Logback Core Module 1.5.1 · ch.qos.logback.core.net.AbstractSocketAppender

Field Summary

Modifier and Type	Field and Description
private int	acceptConnectionTimeout
private InetAddress	address
private SocketConnector	connector
private static final int	DEFAULT_ACCEPT_CONNECTION_DELAY Default timeout when waiting for the remote server to accept our connection.
private static final int	DEFAULT_EVENT_DELAY_TIMEOUT Default timeout for how long to wait when inserting an event into the BlockingQueue.
public static final int	DEFAULT_PORT The default port number of remote logging server (4560).
public static final int	DEFAULT_QUEUE_SIZE Default size of the deque used to hold logging events that are destined for the remote peer.
public static final int	DEFAULT_RECONNECTION_DELAY The default reconnection delay (30000 milliseconds or 30 seconds).
private BlockingDeque<E>	deque
private Duration	eventDelayLimit
private final ObjectWriterFactory	objectWriterFactory
private String	peerId
private int	port
private final QueueFactory	queueFactory
private int	queueSize
private Duration	reconnectionDelay
private String	remoteHost
private volatile Socket	socket
private Future<?>	task

Inherited from ch.qos.logback.core.AppenderBase:: name started

Constructor Summary

Access	Constructor and Description
protected	AbstractSocketAppender() Constructs a new appender.
pack-priv	AbstractSocketAppender(QueueFactory queueFactory, ObjectWriterFactory objectWriterFactory) Constructs a new appender using the given `QueueFactory` and `ObjectWriterFactory`.

Method Summary

Modifier and Type	Method and Description
protected void	append(E event) Implements abstract ch.qos.logback.core.AppenderBase.append.
public void	connectionFailed(SocketConnector connector, Exception ex) Implements ch.qos.logback.core.net.SocketConnector.ExceptionHandler.connectionFailed.
private void	connectSocketAndDispatchEvents()
private SocketConnector	createConnector(InetAddress address, int port, int initialDelay, long retryDelay)
private ObjectWriter	createObjectWriterForSocket()
private void	dispatchEvents(ObjectWriter objectWriter)
public Duration	getEventDelayLimit() Returns the value of the eventDelayLimit property.
public int	getPort() Returns value of the Port property.
protected abstract PreSerializationTransformer<E>	Returns: transformer object getPST() Get the pre-serialization transformer that will be used to transform each event into a Serializable object before delivery to the remote receiver.
public int	getQueueSize() Returns the value of the queueSize property.
public Duration	getReconnectionDelay() Returns value of the reconnectionDelay property.
public String	getRemoteHost() Returns value of the RemoteHost property.
protected SocketFactory	getSocketFactory() Gets the default `SocketFactory` for the platform.
protected SocketConnector	Returns: socket connector newConnector(InetAddress target remote address address, int target remote port port, long delay before the first connection attempt initialDelay, long delay before a reconnection attempt retryDelay) Creates a new `SocketConnector`.
protected abstract void	postProcessEvent(E the event to post-process event) Post-processes an event before it is serialized for delivery to the remote receiver.
pack-priv void	setAcceptConnectionTimeout(int timeout value in milliseconds acceptConnectionTimeout) Sets the timeout that controls how long we'll wait for the remote peer to accept our connection attempt.
public void	setEventDelayLimit(Duration the event delay limit eventDelayLimit) The eventDelayLimit takes a non-negative integer representing the number of milliseconds to allow the appender to block if the underlying BlockingQueue is full.
public void	setPort(int port) The Port property takes a positive integer representing the port where the server is waiting for connections.
public void	setQueueSize(int the deque size to set. queueSize) The queueSize property takes a non-negative integer representing the number of logging events to retain for delivery to the remote receiver.
public void	setReconnectionDelay(Duration delay) The reconnectionDelay property takes a positive `Duration` value representing the time to wait between each failed connection attempt to the server.
public void	setRemoteHost(String host) The RemoteHost property takes the name of the host where a corresponding server is running.
private boolean	socketConnectionCouldBeEstablished()
public void	start() Overrides ch.qos.logback.core.AppenderBase.start. Implements ch.qos.logback.core.spi.LifeCycle.start.
public void	stop() Overrides ch.qos.logback.core.AppenderBase.stop. Implements ch.qos.logback.core.spi.LifeCycle.stop.
private void	tryReAddingEventToFrontOfQueue(E event)

Inherited from ch.qos.logback.core.AppenderBase:: addFilter clearAllFilters doAppend getCopyOfAttachedFiltersList getFilterChainDecision getName isStarted setName toString

Field Detail

acceptConnectionTimeout	back to summary
private int acceptConnectionTimeout

address	back to summary
private InetAddress address

connector	back to summary
private SocketConnector connector

DEFAULT_ACCEPT_CONNECTION_DELAY	back to summary
private static final int DEFAULT_ACCEPT_CONNECTION_DELAY Default timeout when waiting for the remote server to accept our connection.

DEFAULT_EVENT_DELAY_TIMEOUT	back to summary
private static final int DEFAULT_EVENT_DELAY_TIMEOUT Default timeout for how long to wait when inserting an event into the BlockingQueue.

DEFAULT_PORT	back to summary
public static final int DEFAULT_PORT The default port number of remote logging server (4560).

DEFAULT_QUEUE_SIZE	back to summary
public static final int DEFAULT_QUEUE_SIZE Default size of the deque used to hold logging events that are destined for the remote peer.

DEFAULT_RECONNECTION_DELAY	back to summary
public static final int DEFAULT_RECONNECTION_DELAY The default reconnection delay (30000 milliseconds or 30 seconds).

deque	back to summary
private BlockingDeque<E> deque

eventDelayLimit	back to summary
private Duration eventDelayLimit

objectWriterFactory	back to summary
private final ObjectWriterFactory objectWriterFactory

peerId	back to summary
private String peerId

port	back to summary
private int port

queueFactory	back to summary
private final QueueFactory queueFactory

queueSize	back to summary
private int queueSize

reconnectionDelay	back to summary
private Duration reconnectionDelay

remoteHost	back to summary
private String remoteHost

socket	back to summary
private volatile Socket socket

task	back to summary
private Future<?> task

Constructor Detail

AbstractSocketAppender	back to summary
protected AbstractSocketAppender() Constructs a new appender.

AbstractSocketAppender	back to summary
pack-priv AbstractSocketAppender(QueueFactory queueFactory, ObjectWriterFactory objectWriterFactory) Constructs a new appender using the given `QueueFactory` and `ObjectWriterFactory`.

Method Detail

append	back to summary
protected void append(E event) Implements abstract ch.qos.logback.core.AppenderBase.append. Annotations @Override

append

back to summary

protected void append(E event)

Implements abstract ch.qos.logback.core.AppenderBase.append.

Annotations

@Override

connectionFailed	back to summary
public void connectionFailed(SocketConnector connector, Exception ex) Implements ch.qos.logback.core.net.SocketConnector.ExceptionHandler.connectionFailed.

connectSocketAndDispatchEvents	back to summary
private void connectSocketAndDispatchEvents()

createConnector	back to summary
private SocketConnector createConnector(InetAddress address, int port, int initialDelay, long retryDelay)

createObjectWriterForSocket	back to summary
private ObjectWriter createObjectWriterForSocket() throws IOException

dispatchEvents	back to summary
private void dispatchEvents(ObjectWriter objectWriter) throws InterruptedException, IOException

getEventDelayLimit	back to summary
public Duration getEventDelayLimit() Returns the value of the eventDelayLimit property.

getPort	back to summary
public int getPort() Returns value of the Port property.

getPST	back to summary
protected abstract PreSerializationTransformer<E> getPST() Get the pre-serialization transformer that will be used to transform each event into a Serializable object before delivery to the remote receiver. Returns:PreSerializationTransformer<E> transformer object

getPST

back to summary

protected abstract PreSerializationTransformer<E> getPST()

Get the pre-serialization transformer that will be used to transform each event into a Serializable object before delivery to the remote receiver.

Returns:PreSerializationTransformer<E>: transformer object

getQueueSize	back to summary
public int getQueueSize() Returns the value of the queueSize property.

getReconnectionDelay	back to summary
public Duration getReconnectionDelay() Returns value of the reconnectionDelay property.

getRemoteHost	back to summary
public String getRemoteHost() Returns value of the RemoteHost property.

getSocketFactory back to summary

getSocketFactory	back to summary
protected SocketFactory getSocketFactory() Gets the default `SocketFactory` for the platform. Subclasses may override to provide a custom socket factory.

protected SocketFactory getSocketFactory()

Gets the default SocketFactory for the platform.

Subclasses may override to provide a custom socket factory.

newConnector back to summary

newConnector	back to summary
protected SocketConnector newConnector(InetAddress address, int port, long initialDelay, long retryDelay) Creates a new `SocketConnector`. The default implementation creates an instance of `DefaultSocketConnector`. A subclass may override to provide a different `SocketConnector` implementation. Parameters address:InetAddress target remote address port:int target remote port initialDelay:long delay before the first connection attempt retryDelay:long delay before a reconnection attempt Returns:SocketConnector socket connector

protected SocketConnector newConnector(InetAddress address, int port, long initialDelay, long retryDelay)

Creates a new SocketConnector.

The default implementation creates an instance of DefaultSocketConnector. A subclass may override to provide a different SocketConnector implementation.

Parameters

address:InetAddress: target remote address
port:int: target remote port
initialDelay:long: delay before the first connection attempt
retryDelay:long: delay before a reconnection attempt

Returns:SocketConnector

socket connector

postProcessEvent	back to summary
protected abstract void postProcessEvent(E event) Post-processes an event before it is serialized for delivery to the remote receiver. Parameters event:E the event to post-process

postProcessEvent

back to summary

protected abstract void postProcessEvent(E event)

Post-processes an event before it is serialized for delivery to the remote receiver.

Parameters

event:E: the event to post-process

setAcceptConnectionTimeout	back to summary
pack-priv void setAcceptConnectionTimeout(int acceptConnectionTimeout) Sets the timeout that controls how long we'll wait for the remote peer to accept our connection attempt. This property is configurable primarily to support instrumentation for unit testing. Parameters acceptConnectionTimeout:int timeout value in milliseconds

setAcceptConnectionTimeout

back to summary

pack-priv void setAcceptConnectionTimeout(int acceptConnectionTimeout)

Sets the timeout that controls how long we'll wait for the remote peer to accept our connection attempt.

This property is configurable primarily to support instrumentation for unit testing.

Parameters

acceptConnectionTimeout:int: timeout value in milliseconds

setEventDelayLimit	back to summary
public void setEventDelayLimit(Duration eventDelayLimit) The eventDelayLimit takes a non-negative integer representing the number of milliseconds to allow the appender to block if the underlying BlockingQueue is full. Once this limit is reached, the event is dropped. Parameters eventDelayLimit:Duration the event delay limit

setEventDelayLimit

back to summary

public void setEventDelayLimit(Duration eventDelayLimit)

The eventDelayLimit takes a non-negative integer representing the number of milliseconds to allow the appender to block if the underlying BlockingQueue is full. Once this limit is reached, the event is dropped.

Parameters

eventDelayLimit:Duration: the event delay limit

setPort	back to summary
public void setPort(int port) The Port property takes a positive integer representing the port where the server is waiting for connections.

setQueueSize back to summary

setQueueSize	back to summary
public void setQueueSize(int queueSize) The queueSize property takes a non-negative integer representing the number of logging events to retain for delivery to the remote receiver. When the deque size is zero, event delivery to the remote receiver is synchronous. When the deque size is greater than zero, the `append(Object)` method returns immediately after enqueing the event, assuming that there is space available in the deque. Using a non-zero deque length can improve performance by eliminating delays caused by transient network delays. Parameters queueSize:int the deque size to set.

public void setQueueSize(int queueSize)

The queueSize property takes a non-negative integer representing the number of logging events to retain for delivery to the remote receiver. When the deque size is zero, event delivery to the remote receiver is synchronous. When the deque size is greater than zero, the append(Object) method returns immediately after enqueing the event, assuming that there is space available in the deque. Using a non-zero deque length can improve performance by eliminating delays caused by transient network delays.

Parameters

queueSize:int: the deque size to set.

setReconnectionDelay back to summary

setReconnectionDelay	back to summary
public void setReconnectionDelay(Duration delay) The reconnectionDelay property takes a positive `Duration` value representing the time to wait between each failed connection attempt to the server. The default value of this option is to 30 seconds. Setting this option to zero turns off reconnection capability.

public void setReconnectionDelay(Duration delay)

The reconnectionDelay property takes a positive Duration value representing the time to wait between each failed connection attempt to the server. The default value of this option is to 30 seconds.

Setting this option to zero turns off reconnection capability.

setRemoteHost	back to summary
public void setRemoteHost(String host) The RemoteHost property takes the name of the host where a corresponding server is running.

socketConnectionCouldBeEstablished	back to summary
private boolean socketConnectionCouldBeEstablished() throws InterruptedException

start	back to summary
public void start() Overrides ch.qos.logback.core.AppenderBase.start. Implements ch.qos.logback.core.spi.LifeCycle.start.

start

back to summary

public void start()

Overrides ch.qos.logback.core.AppenderBase.start.

Implements ch.qos.logback.core.spi.LifeCycle.start.

stop	back to summary
public void stop() Overrides ch.qos.logback.core.AppenderBase.stop. Implements ch.qos.logback.core.spi.LifeCycle.stop. Annotations @Override

stop

back to summary

public void stop()

Overrides ch.qos.logback.core.AppenderBase.stop.

Implements ch.qos.logback.core.spi.LifeCycle.stop.

Annotations

@Override

tryReAddingEventToFrontOfQueue	back to summary
private void tryReAddingEventToFrontOfQueue(E event)

public abstract Class AbstractSocketAppender<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail