| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> | |
| <!-- | |
| Licensed to the Apache Software Foundation (ASF) under one or more | |
| contributor license agreements. See the NOTICE file distributed with | |
| this work for additional information regarding copyright ownership. | |
| The ASF licenses this file to You under the Apache License, Version 2.0 | |
| (the "License"); you may not use this file except in compliance with | |
| the License. You may obtain a copy of the License at | |
| http://www.apache.org/licenses/LICENSE-2.0 | |
| Unless required by applicable law or agreed to in writing, software | |
| distributed under the License is distributed on an "AS IS" BASIS, | |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| See the License for the specific language governing permissions and | |
| limitations under the License. | |
| --><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> | |
| <title>Apache log4cxx: SocketHubAppender Class Reference</title> | |
| <link href="doxygen.css" rel="stylesheet" type="text/css"> | |
| <link href="tabs.css" rel="stylesheet" type="text/css"> | |
| </head><body> | |
| <!-- Generated by Doxygen 1.4.6 --> | |
| <div class="tabs"> | |
| <ul> | |
| <li><a href="main.html"><span>Main Page</span></a></li> | |
| <li><a href="modules.html"><span>Modules</span></a></li> | |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> | |
| <li id="current"><a href="classes.html"><span>Classes</span></a></li> | |
| <li><a href="files.html"><span>Files</span></a></li> | |
| </ul></div> | |
| <div class="tabs"> | |
| <ul> | |
| <li><a href="classes.html"><span>Alphabetical List</span></a></li> | |
| <li><a href="annotated.html"><span>Class List</span></a></li> | |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> | |
| <li><a href="functions.html"><span>Class Members</span></a></li> | |
| </ul></div> | |
| <div class="nav"> | |
| <a class="el" href="namespacelog4cxx.html">log4cxx</a>::<a class="el" href="namespacelog4cxx_1_1net.html">net</a>::<a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a></div> | |
| <h1>SocketHubAppender Class Reference</h1><!-- doxytag: class="log4cxx::net::SocketHubAppender" --><!-- doxytag: inherits="log4cxx::AppenderSkeleton" -->Inherits <a class="el" href="classlog4cxx_1_1_appender_skeleton.html">AppenderSkeleton</a>. | |
| <p> | |
| <a href="classlog4cxx_1_1net_1_1_socket_hub_appender-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> | |
| Sends <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">LoggingEvent</a> objects to a set of remote log servers, usually a SocketNode. | |
| <p> | |
| Acts just like <a class="el" href="classlog4cxx_1_1net_1_1_socket_appender.html">SocketAppender</a> except that instead of connecting to a given remote log server, <code><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a></code> accepts connections from the remote log servers as clients. It can accept more than one connection. When a log event is received, the event is sent to the set of currently connected remote log servers. Implemented this way it does not require any update to the configuration file to send data to another remote log server. The remote log server simply connects to the host and port the <code><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a></code> is running on.<p> | |
| The <code><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a></code> does not store events such that the remote side will events that arrived after the establishment of its connection. Once connected, events arrive in order as guaranteed by the TCP protocol.<p> | |
| This implementation borrows heavily from the <a class="el" href="classlog4cxx_1_1net_1_1_socket_appender.html">SocketAppender</a>.<p> | |
| The <a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a> has the following characteristics:<p> | |
| <ul> | |
| <li>If sent to a SocketNode, logging is non-intrusive as far as the log event is concerned. In other words, the event will be logged with the same time stamp, <a class="el" href="classlog4cxx_1_1_n_d_c.html">NDC</a>, location info as if it were logged locally.</li></ul> | |
| <p> | |
| <ul> | |
| <li><code><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a></code> does not use a layout. It ships a serialized <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">spi::LoggingEvent</a> object to the remote side.</li></ul> | |
| <p> | |
| <ul> | |
| <li><code><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a></code> relies on the TCP protocol. Consequently, if the remote side is reachable, then log events will eventually arrive at remote client.</li></ul> | |
| <p> | |
| <ul> | |
| <li>If no remote clients are attached, the logging requests are simply dropped.</li></ul> | |
| <p> | |
| <ul> | |
| <li>Logging events are automatically <em>buffered</em> by the native TCP implementation. This means that if the link to remote client is slow but still faster than the rate of (log) event production, the application will not be affected by the slow network connection. However, if the network connection is slower then the rate of event production, then the local application can only progress at the network rate. In particular, if the network link to the the remote client is down, the application will be blocked. <br> | |
| <br> | |
| On the other hand, if the network link is up, but the remote client is down, the client will not be blocked when making log requests but the log events will be lost due to client unavailability. <br> | |
| <br> | |
| The single remote client case extends to multiple clients connections. The rate of logging will be determined by the slowest link.</li></ul> | |
| <p> | |
| <ul> | |
| <li>If the application hosting the <code><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a></code> exits before the <code><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a></code> is closed either explicitly or subsequent to garbage collection, then there might be untransmitted data in the pipe which might be lost. This is a common problem on Windows based systems. <br> | |
| <br> | |
| To avoid lost data, it is usually sufficient to <a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#47feccb1873356363e4d0e302bc3822c">close</a> the <code><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a></code> either explicitly or by calling the <a class="el" href="classlog4cxx_1_1_log_manager.html#62d41be4b41bfdb31fb9d8b017c5363a">LogManager::shutdown</a> method before exiting the application. </li></ul> | |
| <p> | |
| <table border="0" cellpadding="0" cellspacing="0"> | |
| <tr><td></td></tr> | |
| <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#57b492bb638f45dd164c8a3ad148b825">SocketHubAppender</a> ()</td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#6e8d42e6e9ca42434f5f63fc23a56451">~SocketHubAppender</a> ()</td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#5a01622efd9e036a3e7e1d2d6cb95557">SocketHubAppender</a> (int port)</td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Connects to remote server at <code>address</code> and <code>port</code>. <a href="#5a01622efd9e036a3e7e1d2d6cb95557"></a><br></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#f1f3ced78d335ec9c2b800d6d5aa3ef8">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Set up the socket server on the specified port. <a href="#f1f3ced78d335ec9c2b800d6d5aa3ef8"></a><br></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#ee5023c29cca9dc68164b22a01cb7c6e">setOption</a> (const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &option, const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &value)</td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Set options. <a href="#ee5023c29cca9dc68164b22a01cb7c6e"></a><br></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#47feccb1873356363e4d0e302bc3822c">close</a> ()</td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Release any resources allocated within the appender such as file handles, network connections, etc. <a href="#47feccb1873356363e4d0e302bc3822c"></a><br></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#c0184656854a0362e99b46512b6a1761">append</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> &event, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Append an event to all of current connections. <a href="#c0184656854a0362e99b46512b6a1761"></a><br></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#4312e727a9ea814779d2c9950dc3c73e">requiresLayout</a> () const </td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a> does not use a layout. <a href="#4312e727a9ea814779d2c9950dc3c73e"></a><br></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#ea5168a8793a0d18d65a94d84904a2fb">setPort</a> (int port1)</td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The <b>Port</b> option takes a positive integer representing the port where the server is waiting for connections. <a href="#ea5168a8793a0d18d65a94d84904a2fb"></a><br></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#5e4fc3488ccbe0511b7e7a1b3ca873cf">getPort</a> () const </td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns value of the <b>Port</b> option. <a href="#5e4fc3488ccbe0511b7e7a1b3ca873cf"></a><br></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#41d896ff776e8e9094929230bfc5f648">setLocationInfo</a> (bool locationInfo1)</td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">The <b>LocationInfo</b> option takes a boolean value. <a href="#41d896ff776e8e9094929230bfc5f648"></a><br></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#d70ffd01a630335c8e0465b04f360db4">getLocationInfo</a> () const </td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns value of the <b>LocationInfo</b> option. <a href="#d70ffd01a630335c8e0465b04f360db4"></a><br></td></tr> | |
| </table> | |
| <hr><h2>Constructor & Destructor Documentation</h2> | |
| <a class="anchor" name="57b492bb638f45dd164c8a3ad148b825"></a><!-- doxytag: member="log4cxx::net::SocketHubAppender::SocketHubAppender" ref="57b492bb638f45dd164c8a3ad148b825" args="()" --><p> | |
| <table class="mdTable" cellpadding="2" cellspacing="0"> | |
| <tr> | |
| <td class="mdRow"> | |
| <table cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td class="md" nowrap valign="top"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a> </td> | |
| <td class="md" valign="top">( </td> | |
| <td class="mdname1" valign="top" nowrap> </td> | |
| <td class="md" valign="top"> ) </td> | |
| <td class="md" nowrap></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <table cellspacing="5" cellpadding="0" border="0"> | |
| <tr> | |
| <td> | |
| | |
| </td> | |
| <td> | |
| <p> | |
| </td> | |
| </tr> | |
| </table> | |
| <a class="anchor" name="6e8d42e6e9ca42434f5f63fc23a56451"></a><!-- doxytag: member="log4cxx::net::SocketHubAppender::~SocketHubAppender" ref="6e8d42e6e9ca42434f5f63fc23a56451" args="()" --><p> | |
| <table class="mdTable" cellpadding="2" cellspacing="0"> | |
| <tr> | |
| <td class="mdRow"> | |
| <table cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td class="md" nowrap valign="top">~<a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a> </td> | |
| <td class="md" valign="top">( </td> | |
| <td class="mdname1" valign="top" nowrap> </td> | |
| <td class="md" valign="top"> ) </td> | |
| <td class="md" nowrap></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <table cellspacing="5" cellpadding="0" border="0"> | |
| <tr> | |
| <td> | |
| | |
| </td> | |
| <td> | |
| <p> | |
| </td> | |
| </tr> | |
| </table> | |
| <a class="anchor" name="5a01622efd9e036a3e7e1d2d6cb95557"></a><!-- doxytag: member="log4cxx::net::SocketHubAppender::SocketHubAppender" ref="5a01622efd9e036a3e7e1d2d6cb95557" args="(int port)" --><p> | |
| <table class="mdTable" cellpadding="2" cellspacing="0"> | |
| <tr> | |
| <td class="mdRow"> | |
| <table cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td class="md" nowrap valign="top"><a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a> </td> | |
| <td class="md" valign="top">( </td> | |
| <td class="md" nowrap valign="top">int </td> | |
| <td class="mdname1" valign="top" nowrap> <em>port</em> </td> | |
| <td class="md" valign="top"> ) </td> | |
| <td class="md" nowrap></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <table cellspacing="5" cellpadding="0" border="0"> | |
| <tr> | |
| <td> | |
| | |
| </td> | |
| <td> | |
| <p> | |
| Connects to remote server at <code>address</code> and <code>port</code>. | |
| <p> | |
| </td> | |
| </tr> | |
| </table> | |
| <hr><h2>Member Function Documentation</h2> | |
| <a class="anchor" name="f1f3ced78d335ec9c2b800d6d5aa3ef8"></a><!-- doxytag: member="log4cxx::net::SocketHubAppender::activateOptions" ref="f1f3ced78d335ec9c2b800d6d5aa3ef8" args="(log4cxx::helpers::Pool &p)" --><p> | |
| <table class="mdTable" cellpadding="2" cellspacing="0"> | |
| <tr> | |
| <td class="mdRow"> | |
| <table cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td class="md" nowrap valign="top">virtual void activateOptions </td> | |
| <td class="md" valign="top">( </td> | |
| <td class="md" nowrap valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td> | |
| <td class="mdname1" valign="top" nowrap> <em>p</em> </td> | |
| <td class="md" valign="top"> ) </td> | |
| <td class="md" nowrap><code> [virtual]</code></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <table cellspacing="5" cellpadding="0" border="0"> | |
| <tr> | |
| <td> | |
| | |
| </td> | |
| <td> | |
| <p> | |
| Set up the socket server on the specified port. | |
| <p> | |
| <p> | |
| Reimplemented from <a class="el" href="classlog4cxx_1_1_appender_skeleton.html#be1aa95ede9cc9d0609905154129c0ba">AppenderSkeleton</a>. </td> | |
| </tr> | |
| </table> | |
| <a class="anchor" name="c0184656854a0362e99b46512b6a1761"></a><!-- doxytag: member="log4cxx::net::SocketHubAppender::append" ref="c0184656854a0362e99b46512b6a1761" args="(const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)" --><p> | |
| <table class="mdTable" cellpadding="2" cellspacing="0"> | |
| <tr> | |
| <td class="mdRow"> | |
| <table cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td class="md" nowrap valign="top">virtual void append </td> | |
| <td class="md" valign="top">( </td> | |
| <td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> & </td> | |
| <td class="mdname" nowrap> <em>event</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="md" nowrap align="right"></td> | |
| <td class="md"></td> | |
| <td class="md" nowrap><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td> | |
| <td class="mdname" nowrap> <em>p</em></td> | |
| </tr> | |
| <tr> | |
| <td class="md"></td> | |
| <td class="md">) </td> | |
| <td class="md" colspan="2"><code> [virtual]</code></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <table cellspacing="5" cellpadding="0" border="0"> | |
| <tr> | |
| <td> | |
| | |
| </td> | |
| <td> | |
| <p> | |
| Append an event to all of current connections. | |
| <p> | |
| <p> | |
| Implements <a class="el" href="classlog4cxx_1_1_appender_skeleton.html#4c08a91d859f636117f07463bb53fe41">AppenderSkeleton</a>. </td> | |
| </tr> | |
| </table> | |
| <a class="anchor" name="47feccb1873356363e4d0e302bc3822c"></a><!-- doxytag: member="log4cxx::net::SocketHubAppender::close" ref="47feccb1873356363e4d0e302bc3822c" args="()" --><p> | |
| <table class="mdTable" cellpadding="2" cellspacing="0"> | |
| <tr> | |
| <td class="mdRow"> | |
| <table cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td class="md" nowrap valign="top">virtual void close </td> | |
| <td class="md" valign="top">( </td> | |
| <td class="mdname1" valign="top" nowrap> </td> | |
| <td class="md" valign="top"> ) </td> | |
| <td class="md" nowrap><code> [virtual]</code></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <table cellspacing="5" cellpadding="0" border="0"> | |
| <tr> | |
| <td> | |
| | |
| </td> | |
| <td> | |
| <p> | |
| Release any resources allocated within the appender such as file handles, network connections, etc. | |
| <p> | |
| It is a programming error to append to a closed appender. | |
| <p> | |
| Implements <a class="el" href="classlog4cxx_1_1_appender.html#f6ee7eacbde6b379b68d954e44f6e549">Appender</a>. </td> | |
| </tr> | |
| </table> | |
| <a class="anchor" name="d70ffd01a630335c8e0465b04f360db4"></a><!-- doxytag: member="log4cxx::net::SocketHubAppender::getLocationInfo" ref="d70ffd01a630335c8e0465b04f360db4" args="() const " --><p> | |
| <table class="mdTable" cellpadding="2" cellspacing="0"> | |
| <tr> | |
| <td class="mdRow"> | |
| <table cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td class="md" nowrap valign="top">bool getLocationInfo </td> | |
| <td class="md" valign="top">( </td> | |
| <td class="mdname1" valign="top" nowrap> </td> | |
| <td class="md" valign="top"> ) </td> | |
| <td class="md" nowrap> const<code> [inline]</code></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <table cellspacing="5" cellpadding="0" border="0"> | |
| <tr> | |
| <td> | |
| | |
| </td> | |
| <td> | |
| <p> | |
| Returns value of the <b>LocationInfo</b> option. | |
| <p> | |
| </td> | |
| </tr> | |
| </table> | |
| <a class="anchor" name="5e4fc3488ccbe0511b7e7a1b3ca873cf"></a><!-- doxytag: member="log4cxx::net::SocketHubAppender::getPort" ref="5e4fc3488ccbe0511b7e7a1b3ca873cf" args="() const " --><p> | |
| <table class="mdTable" cellpadding="2" cellspacing="0"> | |
| <tr> | |
| <td class="mdRow"> | |
| <table cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td class="md" nowrap valign="top">int getPort </td> | |
| <td class="md" valign="top">( </td> | |
| <td class="mdname1" valign="top" nowrap> </td> | |
| <td class="md" valign="top"> ) </td> | |
| <td class="md" nowrap> const<code> [inline]</code></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <table cellspacing="5" cellpadding="0" border="0"> | |
| <tr> | |
| <td> | |
| | |
| </td> | |
| <td> | |
| <p> | |
| Returns value of the <b>Port</b> option. | |
| <p> | |
| </td> | |
| </tr> | |
| </table> | |
| <a class="anchor" name="4312e727a9ea814779d2c9950dc3c73e"></a><!-- doxytag: member="log4cxx::net::SocketHubAppender::requiresLayout" ref="4312e727a9ea814779d2c9950dc3c73e" args="() const " --><p> | |
| <table class="mdTable" cellpadding="2" cellspacing="0"> | |
| <tr> | |
| <td class="mdRow"> | |
| <table cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td class="md" nowrap valign="top">virtual bool requiresLayout </td> | |
| <td class="md" valign="top">( </td> | |
| <td class="mdname1" valign="top" nowrap> </td> | |
| <td class="md" valign="top"> ) </td> | |
| <td class="md" nowrap> const<code> [inline, virtual]</code></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <table cellspacing="5" cellpadding="0" border="0"> | |
| <tr> | |
| <td> | |
| | |
| </td> | |
| <td> | |
| <p> | |
| The <a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html">SocketHubAppender</a> does not use a layout. | |
| <p> | |
| Hence, this method returns <code>false</code>. | |
| <p> | |
| Implements <a class="el" href="classlog4cxx_1_1_appender.html#1fa0a21a0f0a6ec3a9e92a98db9ffa85">Appender</a>. </td> | |
| </tr> | |
| </table> | |
| <a class="anchor" name="41d896ff776e8e9094929230bfc5f648"></a><!-- doxytag: member="log4cxx::net::SocketHubAppender::setLocationInfo" ref="41d896ff776e8e9094929230bfc5f648" args="(bool locationInfo1)" --><p> | |
| <table class="mdTable" cellpadding="2" cellspacing="0"> | |
| <tr> | |
| <td class="mdRow"> | |
| <table cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td class="md" nowrap valign="top">void setLocationInfo </td> | |
| <td class="md" valign="top">( </td> | |
| <td class="md" nowrap valign="top">bool </td> | |
| <td class="mdname1" valign="top" nowrap> <em>locationInfo1</em> </td> | |
| <td class="md" valign="top"> ) </td> | |
| <td class="md" nowrap><code> [inline]</code></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <table cellspacing="5" cellpadding="0" border="0"> | |
| <tr> | |
| <td> | |
| | |
| </td> | |
| <td> | |
| <p> | |
| The <b>LocationInfo</b> option takes a boolean value. | |
| <p> | |
| If true, the information sent to the remote host will include location information. By default no location information is sent to the server. </td> | |
| </tr> | |
| </table> | |
| <a class="anchor" name="ee5023c29cca9dc68164b22a01cb7c6e"></a><!-- doxytag: member="log4cxx::net::SocketHubAppender::setOption" ref="ee5023c29cca9dc68164b22a01cb7c6e" args="(const LogString &option, const LogString &value)" --><p> | |
| <table class="mdTable" cellpadding="2" cellspacing="0"> | |
| <tr> | |
| <td class="mdRow"> | |
| <table cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td class="md" nowrap valign="top">virtual void setOption </td> | |
| <td class="md" valign="top">( </td> | |
| <td class="md" nowrap valign="top">const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td> | |
| <td class="mdname" nowrap> <em>option</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="md" nowrap align="right"></td> | |
| <td class="md"></td> | |
| <td class="md" nowrap>const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td> | |
| <td class="mdname" nowrap> <em>value</em></td> | |
| </tr> | |
| <tr> | |
| <td class="md"></td> | |
| <td class="md">) </td> | |
| <td class="md" colspan="2"><code> [virtual]</code></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <table cellspacing="5" cellpadding="0" border="0"> | |
| <tr> | |
| <td> | |
| | |
| </td> | |
| <td> | |
| <p> | |
| Set options. | |
| <p> | |
| <p> | |
| Reimplemented from <a class="el" href="classlog4cxx_1_1_appender_skeleton.html#ee5023c29cca9dc68164b22a01cb7c6e">AppenderSkeleton</a>. </td> | |
| </tr> | |
| </table> | |
| <a class="anchor" name="ea5168a8793a0d18d65a94d84904a2fb"></a><!-- doxytag: member="log4cxx::net::SocketHubAppender::setPort" ref="ea5168a8793a0d18d65a94d84904a2fb" args="(int port1)" --><p> | |
| <table class="mdTable" cellpadding="2" cellspacing="0"> | |
| <tr> | |
| <td class="mdRow"> | |
| <table cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td class="md" nowrap valign="top">void setPort </td> | |
| <td class="md" valign="top">( </td> | |
| <td class="md" nowrap valign="top">int </td> | |
| <td class="mdname1" valign="top" nowrap> <em>port1</em> </td> | |
| <td class="md" valign="top"> ) </td> | |
| <td class="md" nowrap><code> [inline]</code></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <table cellspacing="5" cellpadding="0" border="0"> | |
| <tr> | |
| <td> | |
| | |
| </td> | |
| <td> | |
| <p> | |
| The <b>Port</b> option takes a positive integer representing the port where the server is waiting for connections. | |
| <p> | |
| </td> | |
| </tr> | |
| </table> | |
| <hr>The documentation for this class was generated from the following file:<ul> | |
| <li><a class="el" href="sockethubappender_8h.html">sockethubappender.h</a></ul> | |
| <!-- | |
| Licensed to the Apache Software Foundation (ASF) under one or more | |
| contributor license agreements. See the NOTICE file distributed with | |
| this work for additional information regarding copyright ownership. | |
| The ASF licenses this file to You under the Apache License, Version 2.0 | |
| (the "License"); you may not use this file except in compliance with | |
| the License. You may obtain a copy of the License at | |
| http://www.apache.org/licenses/LICENSE-2.0 | |
| Unless required by applicable law or agreed to in writing, software | |
| distributed under the License is distributed on an "AS IS" BASIS, | |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| See the License for the specific language governing permissions and | |
| limitations under the License. | |
| --> | |
| </BODY> | |
| </HTML> |