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

Abstract base class for SocketAppender and XMLSocketAppender. More...

#include <socketappenderskeleton.h>

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

Public Member Functions

 SocketAppenderSkeleton (int defaultPort, int reconnectionDelay)
 
 ~SocketAppenderSkeleton ()
 
 SocketAppenderSkeleton (helpers::InetAddressPtr address, int port, int reconnectionDelay)
 Connects to remote server at address and port.
 
 SocketAppenderSkeleton (const LogString &host, int port, int reconnectionDelay)
 Connects to remote server at host and port.
 
void activateOptions (helpers::Pool &p) override
 Activate the options that were previously set with calls to option setters.
 
void close () override
 Release any resources allocated within the appender such as file handles, network connections, etc.
 
bool requiresLayout () const override
 This appender does not use a layout.
 
void setRemoteHost (const LogString &host)
 The RemoteHost option takes a string value which should be the host name of the server where a Apache Chainsaw or compatible is running.
 
const LogStringgetRemoteHost () const
 Returns value of the RemoteHost option.
 
void setPort (int port1)
 The Port option takes a positive integer representing the port where the server is waiting for connections.
 
int getPort () const
 Returns value of the Port option.
 
void setLocationInfo (bool locationInfo1)
 The LocationInfo option takes a boolean value.
 
bool getLocationInfo () const
 Returns value of the LocationInfo option.
 
void setReconnectionDelay (int reconnectionDelay1)
 The ReconnectionDelay option takes a positive integer representing the number of milliseconds to wait between each failed connection attempt to the server.
 
int getReconnectionDelay () const
 Returns value of the ReconnectionDelay option.
 
void fireConnector ()
 
void setOption (const LogString &option, const LogString &value) override
 Set option to value.
 
- Public Member Functions inherited from log4cxx::AppenderSkeleton
 AppenderSkeleton ()
 
 AppenderSkeleton (const LayoutPtr &layout)
 
virtual ~AppenderSkeleton ()
 
void finalize ()
 Finalize this appender by calling the derived class' close method.
 
void activateOptions (helpers::Pool &) override
 Activate the options that were previously set with calls to option setters.
 
void setOption (const LogString &option, const LogString &value) override
 Set option to value.
 
void addFilter (const spi::FilterPtr newFilter) override
 Add a filter to end of the filter list.
 
void clearFilters () override
 Clear the filters chain.
 
const spi::ErrorHandlerPtr getErrorHandler () const
 Return the currently set spi::ErrorHandler for this Appender.
 
spi::FilterPtr getFilter () const override
 Returns the head Filter.
 
const spi::FilterPtr getFirstFilter () const
 Return the first filter in the filter chain for this Appender.
 
LayoutPtr getLayout () const override
 Returns the layout of this appender.
 
LogString getName () const override
 Returns the name of this Appender.
 
const LevelPtr getThreshold () const
 Returns this appenders threshold level.
 
bool isAsSevereAsThreshold (const LevelPtr &level) const
 Check whether the message level is below the appender's threshold.
 
void doAppend (const spi::LoggingEventPtr &event, helpers::Pool &pool) override
 This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific AppenderSkeleton::append method.
 
void setErrorHandler (const spi::ErrorHandlerPtr eh)
 Set the ErrorHandler for this Appender.
 
void setLayout (const LayoutPtr layout1) override
 Set the layout for this appender.
 
void setName (const LogString &name1) override
 Set the name of this Appender.
 
void setThreshold (const LevelPtr &threshold)
 Set the threshold level.
 
- Public Member Functions inherited from log4cxx::Appender
virtual ~Appender ()
 
virtual void addFilter (const spi::FilterPtr newFilter)=0
 Add a filter to the end of the filter list.
 
virtual spi::FilterPtr getFilter () const =0
 Returns the head Filter.
 
virtual void clearFilters ()=0
 Clear the list of filters by removing all the filters in it.
 
virtual void close ()=0
 Release any resources allocated within the appender such as file handles, network connections, etc.
 
virtual void doAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)=0
 Log in Appender specific way.
 
virtual LogString getName () const =0
 Get the name of this appender.
 
virtual void setLayout (const LayoutPtr layout)=0
 Set the Layout for this appender.
 
virtual LayoutPtr getLayout () const =0
 Returns this appenders layout.
 
virtual void setName (const LogString &name)=0
 Set the name of this appender.
 
virtual bool requiresLayout () const =0
 Configurators call this method to determine if the appender requires a layout.
 
- Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
 
virtual void activateOptions (helpers::Pool &p)=0
 Activate the options that were previously set with calls to option setters.
 
virtual void setOption (const LogString &option, const LogString &value)=0
 Set option to value.
 
- Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
 
virtual const helpers::ClassgetClass () 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 void setSocket (log4cxx::helpers::SocketPtr &socket, log4cxx::helpers::Pool &p)=0
 
virtual void cleanUp (log4cxx::helpers::Pool &p)=0
 
virtual int getDefaultDelay () const =0
 
virtual int getDefaultPort () const =0
 
- Protected Member Functions inherited from log4cxx::AppenderSkeleton
 AppenderSkeleton (LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv)
 
virtual void append (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)=0
 Subclasses of AppenderSkeleton should implement this method to perform actual logging.
 
void doAppendImpl (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)
 

Detailed Description

Abstract base class for SocketAppender and XMLSocketAppender.

Constructor & Destructor Documentation

◆ SocketAppenderSkeleton() [1/4]

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

◆ ~SocketAppenderSkeleton()

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

◆ SocketAppenderSkeleton() [2/4]

log4cxx::net::SocketAppenderSkeleton::SocketAppenderSkeleton ( helpers::InetAddressPtr  address,
int  port,
int  reconnectionDelay 
)

Connects to remote server at address and port.

◆ SocketAppenderSkeleton() [3/4]

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

Connects to remote server at host and port.

◆ SocketAppenderSkeleton() [4/4]

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

Member Function Documentation

◆ activateOptions()

void log4cxx::net::SocketAppenderSkeleton::activateOptions ( helpers::Pool p)
overridevirtual

Activate the options that were previously set with calls to option setters.

Connects to the specified RemoteHost and Port.

Reimplemented from log4cxx::AppenderSkeleton.

◆ cleanUp()

virtual void log4cxx::net::SocketAppenderSkeleton::cleanUp ( log4cxx::helpers::Pool p)
protectedpure virtual

◆ close()

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

Release any resources allocated within the appender such as file handles, network connections, etc.

It is a programming error to append to a closed appender.

Implements log4cxx::Appender.

◆ fireConnector()

void log4cxx::net::SocketAppenderSkeleton::fireConnector ( )

◆ getDefaultDelay()

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

◆ getDefaultPort()

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

◆ getLocationInfo()

bool log4cxx::net::SocketAppenderSkeleton::getLocationInfo ( ) const

Returns value of the LocationInfo option.

◆ getPort()

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

Returns value of the Port option.

◆ getReconnectionDelay()

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

Returns value of the ReconnectionDelay option.

◆ getRemoteHost()

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

Returns value of the RemoteHost option.

◆ requiresLayout()

bool log4cxx::net::SocketAppenderSkeleton::requiresLayout ( ) const
inlineoverridevirtual

This appender does not use a layout.

Hence, this method returns false.

Implements log4cxx::Appender.

◆ setLocationInfo()

void log4cxx::net::SocketAppenderSkeleton::setLocationInfo ( bool  locationInfo1)

The LocationInfo option takes a boolean value.

If true, the information sent to the remote host will include location information. By default no location information is sent to the server.

◆ setOption()

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

Set option to value.

Supported options Supported values Default value
RemoteHost (1) -
Port {int} (2)
LocationInfo True,False False

(1) A valid internet address.

(2) Provided by the derived class.

See also
AppenderSkeleton::setOption()

Reimplemented from log4cxx::AppenderSkeleton.

◆ setPort()

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

The Port option takes a positive integer representing the port where the server is waiting for connections.

◆ setReconnectionDelay()

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

The ReconnectionDelay option takes a positive integer representing the number of milliseconds to wait between each failed connection attempt to the server.

The default value of this option is 30000 which corresponds to 30 seconds.

Setting this option to zero turns off reconnection capability.

◆ setRemoteHost()

void log4cxx::net::SocketAppenderSkeleton::setRemoteHost ( const LogString host)

The RemoteHost option takes a string value which should be the host name of the server where a Apache Chainsaw or compatible is running.

◆ setSocket()

virtual void log4cxx::net::SocketAppenderSkeleton::setSocket ( log4cxx::helpers::SocketPtr &  socket,
log4cxx::helpers::Pool p 
)
protectedpure virtual

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