org.apache.logging.log4j.core.net

Class TcpSocketManager

java.lang.Object

org.apache.logging.log4j.core.appender.AbstractManager

org.apache.logging.log4j.core.appender.OutputStreamManager

org.apache.logging.log4j.core.net.AbstractSocketManager

org.apache.logging.log4j.core.net.TcpSocketManager

All Implemented Interfaces:

AutoCloseable, ByteBufferDestination

Direct Known Subclasses:

SslSocketManager

public class TcpSocketManager
extends AbstractSocketManager

Manager of TCP Socket connections.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TcpSocketManager.TcpSocketManagerFactory<M extends TcpSocketManager,T extends org.apache.logging.log4j.core.net.TcpSocketManager.FactoryData> Factory to create a TcpSocketManager.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RECONNECTION_DELAY_MILLIS The default reconnection delay (30000 milliseconds or 30 seconds).

Fields inherited from class org.apache.logging.log4j.core.net.AbstractSocketManager

host, inetAddress, port

Fields inherited from class org.apache.logging.log4j.core.appender.OutputStreamManager

byteBuffer, layout

Fields inherited from class org.apache.logging.log4j.core.appender.AbstractManager

count, LOGGER

Constructor Summary

Constructors

Constructor and Description
TcpSocketManager(String name, OutputStream os, Socket socket, InetAddress inetAddress, String host, int port, int connectTimeoutMillis, int reconnectionDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize) Deprecated. Use TcpSocketManager(String, OutputStream, Socket, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions).
TcpSocketManager(String name, OutputStream os, Socket socket, InetAddress inetAddress, String host, int port, int connectTimeoutMillis, int reconnectionDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize, SocketOptions socketOptions) Constructs.

Method Summary

Modifier and Type	Method and Description
protected boolean	closeOutputStream()
protected Socket	createSocket(String host, int port)
protected static Socket	createSocket(String host, int port, SocketOptions socketOptions, int connectTimeoutMillis)
int	getConnectTimeoutMillis()
Map<String,String>	getContentFormat() Gets this TcpSocketManager's content format.
int	getReconnectionDelayMillis()
Socket	getSocket() USE AT YOUR OWN RISK, method is public for testing purpose only for now.
static TcpSocketManager	getSocketManager(String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize) Deprecated. Use getSocketManager(String, int, int, int, boolean, Layout, int, SocketOptions).
static TcpSocketManager	getSocketManager(String host, int port, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, Layout<? extends Serializable> layout, int bufferSize, SocketOptions socketOptions) Obtains a TcpSocketManager.
SocketOptions	getSocketOptions() USE AT YOUR OWN RISK, method is public for testing purpose only for now.
String	toString()
protected void	write(byte[] bytes, int offset, int length, boolean immediateFlush) Some output streams synchronize writes while others do not.

Methods inherited from class org.apache.logging.log4j.core.appender.OutputStreamManager

createOutputStream, drain, flush, flushBuffer, flushDestination, getByteBuffer, getManager, getOutputStream, hasOutputStream, isOpen, releaseSub, setOutputStream, skipFooter, write, write, write, writeBytes, writeBytes, writeFooter, writeToDestination

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractManager

close, getCount, getLoggerContext, getName, hasManager, log, logDebug, logError, logger, logWarn, narrow, release, stop, updateData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_RECONNECTION_DELAY_MILLIS

public static final int DEFAULT_RECONNECTION_DELAY_MILLIS

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

See Also:

Constant Field Values

Constructor Detail

TcpSocketManager

@Deprecated
public TcpSocketManager(String name,
                                    OutputStream os,
                                    Socket socket,
                                    InetAddress inetAddress,
                                    String host,
                                    int port,
                                    int connectTimeoutMillis,
                                    int reconnectionDelayMillis,
                                    boolean immediateFail,
                                    Layout<? extends Serializable> layout,
                                    int bufferSize)

Deprecated. Use TcpSocketManager(String, OutputStream, Socket, InetAddress, String, int, int, int, boolean, Layout, int, SocketOptions).

Constructs.

Parameters:

name - The unique name of this connection.

os - The OutputStream.

socket - The Socket.

inetAddress - The Internet address of the host.

host - The name of the host.

port - The port number on the host.

connectTimeoutMillis - the connect timeout in milliseconds.

reconnectionDelayMillis - Reconnection interval.

immediateFail - True if the write should fail if no socket is immediately available.

layout - The Layout.

bufferSize - The buffer size.

TcpSocketManager

public TcpSocketManager(String name,
                        OutputStream os,
                        Socket socket,
                        InetAddress inetAddress,
                        String host,
                        int port,
                        int connectTimeoutMillis,
                        int reconnectionDelayMillis,
                        boolean immediateFail,
                        Layout<? extends Serializable> layout,
                        int bufferSize,
                        SocketOptions socketOptions)

Constructs.

Parameters:

name - The unique name of this connection.

os - The OutputStream.

socket - The Socket.

inetAddress - The Internet address of the host.

host - The name of the host.

port - The port number on the host.

connectTimeoutMillis - the connect timeout in milliseconds.

reconnectionDelayMillis - Reconnection interval.

immediateFail - True if the write should fail if no socket is immediately available.

layout - The Layout.

bufferSize - The buffer size.

Method Detail

getSocketManager

@Deprecated
public static TcpSocketManager getSocketManager(String host,
                                                            int port,
                                                            int connectTimeoutMillis,
                                                            int reconnectDelayMillis,
                                                            boolean immediateFail,
                                                            Layout<? extends Serializable> layout,
                                                            int bufferSize)

Deprecated. Use getSocketManager(String, int, int, int, boolean, Layout, int, SocketOptions).

Obtains a TcpSocketManager.

Parameters:

host - The host to connect to.

port - The port on the host.

connectTimeoutMillis - the connect timeout in milliseconds

reconnectDelayMillis - The interval to pause between retries.

bufferSize - The buffer size.

Returns:

A TcpSocketManager.

getSocketManager

public static TcpSocketManager getSocketManager(String host,
                                                int port,
                                                int connectTimeoutMillis,
                                                int reconnectDelayMillis,
                                                boolean immediateFail,
                                                Layout<? extends Serializable> layout,
                                                int bufferSize,
                                                SocketOptions socketOptions)

Obtains a TcpSocketManager.

Parameters:

host - The host to connect to.

port - The port on the host.

connectTimeoutMillis - the connect timeout in milliseconds

reconnectDelayMillis - The interval to pause between retries.

bufferSize - The buffer size.

Returns:

A TcpSocketManager.

write

protected void write(byte[] bytes,
                     int offset,
                     int length,
                     boolean immediateFlush)

Description copied from class: OutputStreamManager

Some output streams synchronize writes while others do not. Synchronizing here insures that log events won't be intertwined.

Overrides:

write in class OutputStreamManager

Parameters:

bytes - The serialized Log event.

offset - The offset into the byte array.

length - The number of bytes to write.

immediateFlush - flushes immediately after writing.

closeOutputStream

protected boolean closeOutputStream()

Overrides:

closeOutputStream in class OutputStreamManager

getConnectTimeoutMillis

public int getConnectTimeoutMillis()

getContentFormat

public Map<String,String> getContentFormat()

Gets this TcpSocketManager's content format. Specified by:

• Key: "protocol" Value: "tcp"
• Key: "direction" Value: "out"

Overrides:

getContentFormat in class AbstractSocketManager

Returns:

Map of content format keys supporting TcpSocketManager

createSocket

protected Socket createSocket(String host,
                              int port)
                       throws IOException

Throws:

IOException

createSocket

protected static Socket createSocket(String host,
                                     int port,
                                     SocketOptions socketOptions,
                                     int connectTimeoutMillis)
                              throws IOException

Throws:

IOException

getSocketOptions

public SocketOptions getSocketOptions()

USE AT YOUR OWN RISK, method is public for testing purpose only for now.

getSocket

public Socket getSocket()

USE AT YOUR OWN RISK, method is public for testing purpose only for now.

getReconnectionDelayMillis

public int getReconnectionDelayMillis()

toString

public String toString()

Overrides:

toString in class Object