Package ch.qos.logback.classic.net

Class SocketReceiver

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.classic.net.ReceiverBase

ch.qos.logback.classic.net.SocketReceiver

All Implemented Interfaces:

SocketConnector.ExceptionHandler, ContextAware, LifeCycle, java.lang.Runnable

Direct Known Subclasses:

SSLSocketReceiver

public class SocketReceiver
extends ReceiverBase
implements java.lang.Runnable, SocketConnector.ExceptionHandler

A component that receives serialized ILoggingEvent objects from a remote appender over a Socket.

Field Summary

Fields

Modifier and Type	Field	Description
private int	acceptConnectionTimeout
private java.net.InetAddress	address
private java.util.concurrent.Future<java.net.Socket>	connectorTask
private static int	DEFAULT_ACCEPT_CONNECTION_DELAY
private int	port
private java.lang.String	receiverId
private int	reconnectionDelay
private java.lang.String	remoteHost
private java.net.Socket	socket

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
SocketReceiver()

Method Summary

Modifier and Type	Method	Description
private java.util.concurrent.Future<java.net.Socket>	activateConnector(SocketConnector connector)
void	connectionFailed(SocketConnector connector, java.lang.Exception ex)
private SocketConnector	createConnector(java.net.InetAddress address, int port, int initialDelay, int retryDelay)
private void	dispatchEvents(LoggerContext lc)
protected java.lang.Runnable	getRunnableTask()	Provides the runnable task this receiver will execute.
protected javax.net.SocketFactory	getSocketFactory()
protected SocketConnector	newConnector(java.net.InetAddress address, int port, int initialDelay, int retryDelay)
protected void	onStop()	Allows a subclass to participate in receiver shutdown.
void	run()
void	setAcceptConnectionTimeout(int acceptConnectionTimeout)
void	setPort(int port)
void	setReconnectionDelay(int reconnectionDelay)
void	setRemoteHost(java.lang.String remoteHost)
protected boolean	shouldStart()	Determines whether this receiver should start.
private java.net.Socket	waitForConnectorToReturnASocket()

Methods inherited from class ch.qos.logback.classic.net.ReceiverBase

isStarted, start, stop

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ACCEPT_CONNECTION_DELAY

private static final int DEFAULT_ACCEPT_CONNECTION_DELAY

See Also:

Constant Field Values

remoteHost

private java.lang.String remoteHost

address

private java.net.InetAddress address

port

private int port

reconnectionDelay

private int reconnectionDelay

acceptConnectionTimeout

private int acceptConnectionTimeout

receiverId

private java.lang.String receiverId

socket

private volatile java.net.Socket socket

connectorTask

private java.util.concurrent.Future<java.net.Socket> connectorTask

Constructor Detail

SocketReceiver

public SocketReceiver()

Method Detail

shouldStart

protected boolean shouldStart()

Determines whether this receiver should start.

Subclasses will implement this method to do any subclass-specific validation. The subclass's ReceiverBase.getRunnableTask() method will be invoked (and the task returned will be submitted to the executor) if and only if this method returns true

Specified by:

shouldStart in class ReceiverBase

Returns:

flag indicating whether this receiver should start

onStop

protected void onStop()

Allows a subclass to participate in receiver shutdown.

Specified by:

onStop in class ReceiverBase

getRunnableTask

protected java.lang.Runnable getRunnableTask()

Description copied from class: ReceiverBase

Provides the runnable task this receiver will execute.

Specified by:

getRunnableTask in class ReceiverBase

Returns:

runnable task

run

public void run()

Specified by:

run in interface java.lang.Runnable

createConnector

private SocketConnector createConnector(java.net.InetAddress address,
                                        int port,
                                        int initialDelay,
                                        int retryDelay)

activateConnector

private java.util.concurrent.Future<java.net.Socket> activateConnector(SocketConnector connector)

waitForConnectorToReturnASocket

private java.net.Socket waitForConnectorToReturnASocket()
                                                 throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

dispatchEvents

private void dispatchEvents(LoggerContext lc)

connectionFailed

public void connectionFailed(SocketConnector connector,
                             java.lang.Exception ex)

Specified by:

connectionFailed in interface SocketConnector.ExceptionHandler

newConnector

protected SocketConnector newConnector(java.net.InetAddress address,
                                       int port,
                                       int initialDelay,
                                       int retryDelay)

getSocketFactory

protected javax.net.SocketFactory getSocketFactory()

setRemoteHost

public void setRemoteHost(java.lang.String remoteHost)

setPort

public void setPort(int port)

setReconnectionDelay

public void setReconnectionDelay(int reconnectionDelay)

setAcceptConnectionTimeout

public void setAcceptConnectionTimeout(int acceptConnectionTimeout)