TelnetAppender Class Reference

Inheritance diagram for TelnetAppender:

[legend]

Collaboration diagram for TelnetAppender:

[legend]

List of all members.

Public Member Functions
virtual bool	requiresLayout () const
void	activateOptions ()
virtual void	setOption (const String &option, const String &value)
int	getPort () const
void	setPort (int port)
void	close ()
Protected Member Functions
virtual void	append (const spi::LoggingEventPtr &event)

---

Detailed Description

The TelnetAppender is a log4cxx appender that specializes in writing to a read-only socket. The output is provided in a telnet-friendly way so that a log can be monitored over TCP/IP. Clients using telnet connect to the socket and receive log data. This is handy for remote monitoring, especially when monitoring a servlet.

Here is a list of the available configuration options:

Name	Requirement	Description	Sample Value
Port	optional	This parameter determines the port to use for announcing log events. The default port is 23 (telnet).	5875

---

Member Function Documentation

virtual bool requiresLayout

(

)

const [inline, virtual]

This appender requires a layout to format the text to the attached client(s).

Implements Appender.

void activateOptions

(

)

[virtual]

all of the options have been set, create the socket handler and wait for connections.

Reimplemented from AppenderSkeleton.

void setOption	(	const String &	option,
		const String &	value
	)			[virtual]

Set options

Reimplemented from AppenderSkeleton.

int getPort

(

)

const [inline]

Returns value of the Port option.

void setPort

(

int

port

)

[inline]

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

void close

(

)

[virtual]

shuts down the appender.

Implements Appender.

void append

(

const spi::LoggingEventPtr &

event

)

[protected, virtual]

Handles a log event. For this appender, that means writing the message to each connected client.

Implements AppenderSkeleton.

---

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

• telnetappender.h
• telnetappender.cpp