Apache Log4cxx  Version 2.0.0
Loading...
Searching...
No Matches
log4cxx::net::TelnetAppender Class Reference

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

#include <telnetappender.h>

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

Public Member Functions

 TelnetAppender ()
 ~TelnetAppender ()
LogString getEncoding () const
 The current encoding value.
void setEncoding (const LogString &value)
 Set the encoding to value.
void activateOptions () override
 Activate the options that were previously set with calls to option setters.
void setOption (const LogString &option, const LogString &value) override
 Override this method to 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 setNonBlocking (bool newValue)
 Use newValue for the behaviour when the TCP send buffer (on an accepted socket connection) is full.
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

void append (const spi::LoggingEventPtr &event) override
 Send event to each connected client.
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

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() [1/2]

void log4cxx::net::TelnetAppender::activateOptions ( )
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.

◆ 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::TelnetAppender::append ( const spi::LoggingEventPtr & event)
overrideprotectedvirtual

Send event to each connected client.

Implements log4cxx::AppenderSkeleton.

◆ 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.

◆ 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

◆ setNonBlocking()

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

Use newValue for the behaviour when the TCP send buffer (on an accepted socket connection) is full.

When true (the default), the socket connection is closed if the write would block.

Setting newValue to false is an explicit opt-out that must only be used when every telnet client is trusted to read promptly: a blocking connection lets a client that stops reading stall the send indefinitely, blocking every thread that logs through this appender.

See also
setOption

◆ setOption()

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

Override this method to 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
NonBlocking True,False True
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: