Apache Log4cxx  Version 2.0.0
Loading...
Searching...
No Matches
log4cxx::net::SocketAppenderSkeleton Class Referenceabstract

Abstract base class that sends spi::LoggingEvent elements to a remote server. More...

#include <socketappenderskeleton.h>

Inheritance diagram for log4cxx::net::SocketAppenderSkeleton:
log4cxx::AppenderSkeleton log4cxx::Appender log4cxx::spi::OptionHandler log4cxx::helpers::Object log4cxx::net::JSONSocketAppender log4cxx::net::XMLSocketAppender

Public Member Functions

 SocketAppenderSkeleton (int defaultPort, int millisecondDelay)
 A unconnected appender sending to defaultPort, with a retry after millisecondDelay when unable to establish a connection.
 ~SocketAppenderSkeleton ()
 Close and shutdown the connection if not already done.
 SocketAppenderSkeleton (const helpers::InetAddressPtr &address, int port, int millisecondDelay)
 A remote server at address and port, with a retry after millisecondDelay when unable to establish a connection.
 SocketAppenderSkeleton (const LogString &host, int port, int millisecondDelay)
 A remote server at host and port, with a retry after millisecondDelay when unable to establish a connection.
void activateOptions () override
 Connects to the configured RemoteHost and Port.
void append (const spi::LoggingEventPtr &event) override
 Sends the message that the configured Layout produces from event to the output sink.
void setRemoteHost (const LogString &newValue)
 Use newValue as the name of the server.
const LogString & getRemoteHost () const
 Returns value of the RemoteHost option.
void setPort (int newValue)
 Use newValue, which must be a positive integer, as the port on which the server is waiting for connections.
int getPort () const
 Returns value of the Port option.
void setReconnectionDelay (int millisecondDelay)
 Use millisecondDelay as the number of milliseconds to wait between each failed connection attempt to the server.
int getReconnectionDelay () const
 The value of the ReconnectionDelay option, the number of milliseconds to wait between each failed connection attempt to the server.
void setSocketSubclass (const LogString &newSubclass)
 Use newSubclass as the helpers::Socket interface instead of the default implementation.
const LogString & getSocketSubclass () const
 The class name used for the helpers::Socket interface implemention.
void setOption (const LogString &option, const LogString &value) override
 Override this method to set option to value.
void activateOptions (helpers::Pool &)
Public Member Functions inherited from log4cxx::AppenderSkeleton
 AppenderSkeleton (const LayoutPtr &layout={})
virtual ~AppenderSkeleton ()
void addFilter (const spi::FilterPtr &newFilter) override
 Add newFilter to end of the spi::Filter chain.
void clearFilters () override
 Clear the spi::Filter chain.
void close () override
 Release any resources allocated within the appender such as file handles, network connections, etc.
const spi::ErrorHandlerPtr getErrorHandler () const
 The currently set spi::ErrorHandler for this Appender.
spi::FilterPtr getFilter () const override
 The first spi::Filter in the filter chain for this Appender.
const spi::FilterPtr getFirstFilter () const
 The first spi::Filter in the filter chain for this Appender.
LayoutPtr getLayout () const override
 The currently set Layout for this appender.
LogString getName () const override
 The name of this Appender.
const LevelPtr getThreshold () const
 This appender's current threshold level.
bool isAsSevereAsThreshold (const LevelPtr &level) const
 Is level greater than or equal to this appender's threshold?
void doAppend (const spi::LoggingEventPtr &event) override
 Call doAppendImpl after acquiring a lock that prevents other threads from concurrently executing doAppendImpl.
void setErrorHandler (const spi::ErrorHandlerPtr &newValue)
 Use newValue as the spi::ErrorHandler for this Appender.
void setLayout (const LayoutPtr &newValue) override
 Use newValue as the layout for this appender.
void setName (const LogString &newValue) override
 Use newValue for the name of this Appender.
void setThreshold (const LevelPtr &newValue)
 Use newValue as this appender's threshold level.
void activateOptions (helpers::Pool &)
Public Member Functions inherited from log4cxx::Appender
virtual ~Appender ()
void doAppend (const spi::LoggingEventPtr &event, helpers::Pool &pool)
virtual bool requiresLayout () const
Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
void activateOptions (helpers::Pool &)
Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
virtual const helpers::Class & getClass () const =0
virtual bool instanceof (const Class &clazz) const =0
virtual const void * cast (const Class &clazz) const =0

Protected Member Functions

 SocketAppenderSkeleton (std::unique_ptr< SocketAppenderSkeletonPriv > priv)
virtual int getDefaultDelay () const =0
virtual int getDefaultPort () const =0
Protected Member Functions inherited from log4cxx::AppenderSkeleton
 AppenderSkeleton (LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv)
void doAppendImpl (const spi::LoggingEventPtr &event)
 Call the AppenderSkeleton::append method if the level of event is not lower than this appender's threshold and no attached spi::Filter indicates event is rejected.
bool isAccepted (const spi::LoggingEventPtr &event) const
 Does no attached filter deny event or does an attached filter accept event?

Detailed Description

Abstract base class that sends spi::LoggingEvent elements to a remote server.

This appender has the following properties:

  • The event will be logged with the same time stamp, NDC, location info as if it were logged locally by the client.
  • Remote logging uses the TCP protocol, so if the server is reachable, log events will eventually arrive at the server.
  • If the remote server is down, the logging requests are simply dropped. However, if and when the server comes back up, then event transmission is resumed transparently. This transparent reconneciton is performed by a connector task which periodically attempts to connect to the server.
  • Logging events are automatically buffered by the native TCP implementation. This means that if the link to server is slow but still faster than the rate of (log) event production by the client, the client will not be affected by the slow network connection. However, if the network connection is slower then the rate of event production, then the client can only progress at the network rate. In particular, if the network link to the the server is down, the client will be blocked. On the other hand, if the network link is up, but the server is down, the client will not be blocked when making log requests but the log events will be lost due to server unavailability.
  • If the application hosting this appender exits before it is closed, either explicitly or subsequent to destruction, then there might be untransmitted data in the pipe which might be lost.

To avoid lost data, it is usually sufficient to close the appender either explicitly or by calling the LogManager::shutdown method before exiting the application.

A periodic task will connect when the server becomes available. It does this by attempting to open a new connection every millisecondDelay milliseconds.

The periodic task stops trying whenever a connection is established. It will restart attempting to open a new connection to the server when a previously open connection is droppped.

Constructor & Destructor Documentation

◆ SocketAppenderSkeleton() [1/4]

log4cxx::net::SocketAppenderSkeleton::SocketAppenderSkeleton ( int defaultPort,
int millisecondDelay )

A unconnected appender sending to defaultPort, with a retry after millisecondDelay when unable to establish a connection.

◆ ~SocketAppenderSkeleton()

log4cxx::net::SocketAppenderSkeleton::~SocketAppenderSkeleton ( )

Close and shutdown the connection if not already done.

◆ SocketAppenderSkeleton() [2/4]

log4cxx::net::SocketAppenderSkeleton::SocketAppenderSkeleton ( const helpers::InetAddressPtr & address,
int port,
int millisecondDelay )

A remote server at address and port, with a retry after millisecondDelay when unable to establish a connection.

◆ SocketAppenderSkeleton() [3/4]

log4cxx::net::SocketAppenderSkeleton::SocketAppenderSkeleton ( const LogString & host,
int port,
int millisecondDelay )

A remote server at host and port, with a retry after millisecondDelay when unable to establish a connection.

◆ SocketAppenderSkeleton() [4/4]

log4cxx::net::SocketAppenderSkeleton::SocketAppenderSkeleton ( std::unique_ptr< SocketAppenderSkeletonPriv > priv)
protected

Member Function Documentation

◆ activateOptions() [1/2]

void log4cxx::net::SocketAppenderSkeleton::activateOptions ( )
overridevirtual

Connects to the configured RemoteHost and Port.

Reimplemented from log4cxx::AppenderSkeleton.

◆ activateOptions() [2/2]

Deprecated
This function is deprecated and will be removed in a future version.
Deprecated
Use activateOptions() without parameters instead

◆ append()

void log4cxx::net::SocketAppenderSkeleton::append ( const spi::LoggingEventPtr & event)
overridevirtual

Sends the message that the configured Layout produces from event to the output sink.

Implements log4cxx::AppenderSkeleton.

◆ getDefaultDelay()

virtual int log4cxx::net::SocketAppenderSkeleton::getDefaultDelay ( ) const
protectedpure virtual

◆ getDefaultPort()

virtual int log4cxx::net::SocketAppenderSkeleton::getDefaultPort ( ) const
protectedpure virtual

◆ getPort()

int log4cxx::net::SocketAppenderSkeleton::getPort ( ) const

Returns value of the Port option.

◆ getReconnectionDelay()

int log4cxx::net::SocketAppenderSkeleton::getReconnectionDelay ( ) const

The value of the ReconnectionDelay option, the number of milliseconds to wait between each failed connection attempt to the server.

◆ getRemoteHost()

const LogString & log4cxx::net::SocketAppenderSkeleton::getRemoteHost ( ) const

Returns value of the RemoteHost option.

◆ getSocketSubclass()

const LogString & log4cxx::net::SocketAppenderSkeleton::getSocketSubclass ( ) const

The class name used for the helpers::Socket interface implemention.

◆ setOption()

void log4cxx::net::SocketAppenderSkeleton::setOption ( const LogString & option,
const LogString & value )
overridevirtual

Override this method to set option to value.

Supported options Supported values Default value
RemoteHost (1) -
Port {int} (2)
SocketSubclass (3) APRSocket

(1) A valid internet address.

(2) Provided by the derived class.

(3) A registered class derived from helpers::Socket.

See also
AppenderSkeleton::setOption()

Reimplemented from log4cxx::AppenderSkeleton.

◆ setPort()

void log4cxx::net::SocketAppenderSkeleton::setPort ( int newValue)

Use newValue, which must be a positive integer, as the port on which the server is waiting for connections.

◆ setReconnectionDelay()

void log4cxx::net::SocketAppenderSkeleton::setReconnectionDelay ( int millisecondDelay)

Use millisecondDelay as the number of milliseconds to wait between each failed connection attempt to the server.

Setting this option to zero turns off reconnection capability.

◆ setRemoteHost()

void log4cxx::net::SocketAppenderSkeleton::setRemoteHost ( const LogString & newValue)

Use newValue as the name of the server.

◆ setSocketSubclass()

void log4cxx::net::SocketAppenderSkeleton::setSocketSubclass ( const LogString & newSubclass)

Use newSubclass as the helpers::Socket interface instead of the default implementation.


The documentation for this class was generated from the following file: