The TelnetAppender writes log messages to clients that connect to the TCP port. More...

#include <telnetappender.h>

Inheritance diagram for log4cxx::net::TelnetAppender:

Public Member Functions
	TelnetAppender ()

	~TelnetAppender ()

bool	requiresLayout () const override
	If no layout is provided, sends only the log message to attached client(s).

LogString	getEncoding () const
	The current encoding value.

void	setEncoding (const LogString &value)
	Set the encoding to `value`.

void	activateOptions (helpers::Pool &p) 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`.

int	getPort () const
	The TCP Port number on which to accept connections.

void	setPort (int newValue)
	Use `newValue` as the TCP port number on which to accept connections.

LogString	getHostname () const
	The Hostname on which to accept connections.

void	setHostname (const LogString &newValue)
	Use `newValue` as the Hostname on which to accept connections.

int	getMaxConnections () const
	The number of allowed concurrent connections.

void	setMaxConnections (int newValue)
	Set the number of allowed concurrent connections to `newValue`.

void	setReuseAddress (bool newValue)
	Use `newValue` for the SO_REUSEADDR option of the socket accepting connections.

void	close () override
	Shutdown this appender.

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::Class &	getClass () const =0

virtual bool	instanceof (const Class &clazz) const =0

virtual const void *	cast (const Class &clazz) const =0

Protected Member Functions
void	append (const spi::LoggingEventPtr &event, helpers::Pool &p) override
	Send `event` to each connected client.

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

The TelnetAppender writes log messages to clients that connect to the TCP port.

This allows logging output to be monitored using TCP/IP. To receive log data, use telnet to connect to the configured port number.

TelnetAppender is most useful as a secondary appender, especially when monitoring a servlet remotely.

If no layout is provided, the log message only is sent to attached client(s).

The ReuseAddress option is disabled by default. Enable it to be able to connect to this appender immediately after the logging process restarts.

See TelnetAppender::setOption() for the available options.

Constructor & Destructor Documentation

◆ TelnetAppender()

log4cxx::net::TelnetAppender::TelnetAppender ( )

◆ ~TelnetAppender()

log4cxx::net::TelnetAppender::~TelnetAppender ( )

Member Function Documentation

◆ activateOptions()

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

overridevirtual

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

Create the socket handler and wait for connections.

Reimplemented from log4cxx::AppenderSkeleton.

◆ append()

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

overrideprotectedvirtual

Send event to each connected client.

Implements log4cxx::AppenderSkeleton.

◆ close()

void log4cxx::net::TelnetAppender::close ( )

overridevirtual

Shutdown this appender.

Implements log4cxx::Appender.

◆ getEncoding()

LogString log4cxx::net::TelnetAppender::getEncoding ( ) const

The current encoding value.

See also: setOption

◆ getHostname()

LogString log4cxx::net::TelnetAppender::getHostname ( ) const

The Hostname on which to accept connections.

◆ getMaxConnections()

int log4cxx::net::TelnetAppender::getMaxConnections ( ) const

The number of allowed concurrent connections.

See also: setOption

◆ getPort()

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

The TCP Port number on which to accept connections.

◆ requiresLayout()

bool log4cxx::net::TelnetAppender::requiresLayout ( ) const

overridevirtual

If no layout is provided, sends only the log message to attached client(s).

Implements log4cxx::Appender.

◆ setEncoding()

void log4cxx::net::TelnetAppender::setEncoding ( const LogString & value )

Set the encoding to value.

See also: setOption

◆ setHostname()

void log4cxx::net::TelnetAppender::setHostname ( const LogString & newValue )

Use newValue as the Hostname on which to accept connections.

By default connections are accepted on any network interface device.

◆ setMaxConnections()

void log4cxx::net::TelnetAppender::setMaxConnections ( int newValue )

Set the number of allowed concurrent connections to newValue.

See also: setOption

◆ setOption()

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

overridevirtual

Set option to value.

Supported options	Supported values	Default value
Port	{int}	23

Hostname | name or numeric address | MaxConnections | {int} | 20 Encoding | C,UTF-8,UTF-16,UTF-16BE,UTF-16LE,646,US-ASCII,ISO646-US,ANSI_X3.4-1968,ISO-8859-1,ISO-LATIN-1 | UTF-8 ReuseAddress | True,False | False

See also: AppenderSkeleton::setOption()

Reimplemented from log4cxx::AppenderSkeleton.

◆ setPort()

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

Use newValue as the TCP port number on which to accept connections.

◆ setReuseAddress()

void log4cxx::net::TelnetAppender::setReuseAddress ( bool newValue )

Use newValue for the SO_REUSEADDR option of the socket accepting connections.

When set to true, a telnet client can connect when the socket is in a TIME_WAIT state, so log message delivery will resume quickly when a terminated process restarts.

See also: setOption

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

telnetappender.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TelnetAppender()

◆ ~TelnetAppender()

Member Function Documentation

◆ activateOptions()

◆ append()

◆ close()

◆ getEncoding()

◆ getHostname()

◆ getMaxConnections()

◆ getPort()

◆ requiresLayout()

◆ setEncoding()

◆ setHostname()

◆ setMaxConnections()

◆ setOption()

◆ setPort()

◆ setReuseAddress()