Sends spi::LoggingEvent elements to a remote a log server, usually in XML format. More...

#include <xmlsocketappender.h>

Inheritance diagram for log4cxx::net::XMLSocketAppender:

Public Member Functions
	XMLSocketAppender ()
	~XMLSocketAppender ()
	XMLSocketAppender (helpers::InetAddressPtr address, int port)
	Connects to remote server at `address` and `port`.
	XMLSocketAppender (const LogString &host, int port)
	Connects to remote server at `host` and `port`.
void	activateOptions (helpers::Pool &p) override
void	activateOptions ()
Public Member Functions inherited from log4cxx::net::SocketAppenderSkeleton
	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	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 LogString &	getRemoteHost () 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`.
void	activateOptions ()
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	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 &p) override
	Call AppenderSkeleton::doAppendImpl after acquiring a lock that prevents other threads from concurrently executing AppenderSkeleton::doAppendImpl.
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.
void	activateOptions ()
Public Member Functions inherited from log4cxx::Appender
virtual	~Appender ()
void	doAppend (const spi::LoggingEventPtr &event)
Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual	~OptionHandler ()
void	activateOptions ()
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

Static Public Attributes
static int	DEFAULT_PORT
	The default port number of remote logging server (4560).
static int	DEFAULT_RECONNECTION_DELAY
	The default reconnection delay (30000 milliseconds or 30 seconds).
static const int	MAX_EVENT_LEN
	Unused.

Protected Member Functions
void	setSocket (log4cxx::helpers::SocketPtr &socket, helpers::Pool &p) override
void	cleanUp (helpers::Pool &p) override
int	getDefaultDelay () const override
int	getDefaultPort () const override
void	append (const spi::LoggingEventPtr &event, helpers::Pool &p) override
	Subclasses of `AppenderSkeleton` must implement this method to perform actual logging.
Protected Member Functions inherited from log4cxx::net::SocketAppenderSkeleton
	SocketAppenderSkeleton (std::unique_ptr< SocketAppenderSkeletonPriv > priv)
virtual void	setSocket (helpers::SocketPtr &socket, helpers::Pool &p)=0
Protected Member Functions inherited from log4cxx::AppenderSkeleton
	AppenderSkeleton (LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv)
void	doAppendImpl (const spi::LoggingEventPtr &event, helpers::Pool &p)
	Compare `event` level against the appender threshold and check that `event` is accepted.
bool	isAccepted (const spi::LoggingEventPtr &event) const
	Does no attached filter deny `event` or does an attached filter accept `event`?

Detailed Description

Sends spi::LoggingEvent elements to a remote a log server, usually in XML format.

Here is an example configuration that writes JSON to the TCP input plugin of a fluent-bit log server running on the same system as the application:

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<appender name="A1" class="XMLSocketAppender">
  <param name="RemoteHost" value="localhost" />
  <param name="Port"       value="5170" />
  <layout class="JSONLayout"/>
</appender>
<root>
  <priority value ="INFO" />
  <appender-ref ref="A1" />
</root>
</log4j:configuration>

See SocketAppenderSkeleton for more information on the behaviour this appender.

Constructor & Destructor Documentation

◆ XMLSocketAppender() [1/3]

log4cxx::net::XMLSocketAppender::XMLSocketAppender ( )

◆ ~XMLSocketAppender()

log4cxx::net::XMLSocketAppender::~XMLSocketAppender ( )

◆ XMLSocketAppender() [2/3]

log4cxx::net::XMLSocketAppender::XMLSocketAppender	(	helpers::InetAddressPtr	address,
		int	port )

Connects to remote server at address and port.

◆ XMLSocketAppender() [3/3]

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

Connects to remote server at host and port.

Member Function Documentation

◆ activateOptions() [1/2]

void log4cxx::spi::OptionHandler::activateOptions ( )

◆ activateOptions() [2/2]

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

overridevirtual

Connects to the specified RemoteHost and Port.

Reimplemented from log4cxx::net::SocketAppenderSkeleton.

◆ append()

void log4cxx::net::XMLSocketAppender::append	(	const spi::LoggingEventPtr &	event,
		helpers::Pool &	p )

overrideprotectedvirtual

Subclasses of AppenderSkeleton must implement this method to perform actual logging.

See also AppenderSkeleton::doAppend method.

Implements log4cxx::AppenderSkeleton.

◆ cleanUp()

void log4cxx::net::XMLSocketAppender::cleanUp ( helpers::Pool & p )

overrideprotectedvirtual

Deprecated: This method will be removed in a future version.

Implements log4cxx::net::SocketAppenderSkeleton.

◆ getDefaultDelay()

int log4cxx::net::XMLSocketAppender::getDefaultDelay ( ) const

overrideprotectedvirtual

Implements log4cxx::net::SocketAppenderSkeleton.

◆ getDefaultPort()

int log4cxx::net::XMLSocketAppender::getDefaultPort ( ) const

overrideprotectedvirtual

Implements log4cxx::net::SocketAppenderSkeleton.

◆ setSocket()

void log4cxx::net::XMLSocketAppender::setSocket	(	log4cxx::helpers::SocketPtr &	socket,
		helpers::Pool &	p )

overrideprotected

Deprecated: This method will be removed in a future version.

Member Data Documentation

◆ DEFAULT_PORT

int log4cxx::net::XMLSocketAppender::DEFAULT_PORT

static

The default port number of remote logging server (4560).

◆ DEFAULT_RECONNECTION_DELAY

int log4cxx::net::XMLSocketAppender::DEFAULT_RECONNECTION_DELAY

static

The default reconnection delay (30000 milliseconds or 30 seconds).

◆ MAX_EVENT_LEN

const int log4cxx::net::XMLSocketAppender::MAX_EVENT_LEN

static

Unused.

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

xmlsocketappender.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ XMLSocketAppender() [1/3]

◆ ~XMLSocketAppender()

◆ XMLSocketAppender() [2/3]

◆ XMLSocketAppender() [3/3]

Member Function Documentation

◆ activateOptions() [1/2]

◆ activateOptions() [2/2]

◆ append()

◆ cleanUp()

◆ getDefaultDelay()

◆ getDefaultPort()

◆ setSocket()

Member Data Documentation

◆ DEFAULT_PORT

◆ DEFAULT_RECONNECTION_DELAY

◆ MAX_EVENT_LEN