org.apache.logging.log4j.core.appender
Class SocketAppender
java.lang.Object
org.apache.logging.log4j.core.filter.AbstractFilterable
org.apache.logging.log4j.core.appender.AbstractAppender
org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender
org.apache.logging.log4j.core.appender.SocketAppender
- All Implemented Interfaces:
- Appender, Filterable, LifeCycle
- Direct Known Subclasses:
- SyslogAppender
public class SocketAppender
- extends AbstractOutputStreamAppender
An Appender that delivers events over socket connections. Supports both TCP and UDP.
Method Summary |
static SocketAppender |
createAppender(String host,
String portNum,
String protocol,
String delay,
String immediateFail,
String name,
String immediateFlush,
String suppress,
Layout layout,
Filter filter,
String advertise,
Configuration config)
|
protected static AbstractSocketManager |
createSocketManager(String protocol,
String host,
int port,
int delay,
boolean immediateFail)
|
void |
stop()
Stop the Appender. |
Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender |
close, error, error, error, getHandler, getLayout, getName, isExceptionSuppressed, isStarted, setHandler, toString |
SocketAppender
protected SocketAppender(String name,
Layout layout,
Filter filter,
AbstractSocketManager manager,
boolean handleException,
boolean immediateFlush,
Advertiser advertiser)
stop
public void stop()
- Description copied from class:
AbstractAppender
- Stop the Appender.
- Specified by:
stop
in interface LifeCycle
- Overrides:
stop
in class AbstractOutputStreamAppender
createAppender
public static SocketAppender createAppender(String host,
String portNum,
String protocol,
String delay,
String immediateFail,
String name,
String immediateFlush,
String suppress,
Layout layout,
Filter filter,
String advertise,
Configuration config)
- Parameters:
host
- The name of the host to connect to.portNum
- The port to connect to on the target host.protocol
- The Protocol to use.delay
- The interval in which failed writes should be retried.immediateFail
- True if the write should fail if no socket is immediately available.name
- The name of the Appender.immediateFlush
- "true" if data should be flushed on each write.suppress
- "true" if exceptions should be hidden from the application, "false" otherwise.
The default is "true".layout
- The layout to use (defaults to SerializedLayout).filter
- The Filter or null.advertise
- "true" if the appender configuration should be advertised, "false" otherwise.config
- The Configuration
- Returns:
- A SocketAppender.
createSocketManager
protected static AbstractSocketManager createSocketManager(String protocol,
String host,
int port,
int delay,
boolean immediateFail)
Copyright © 1999-2013 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.