Module ch.qos.logback.core
Package ch.qos.logback.core.net.server
Class AbstractServerSocketAppender<E>
java.lang.Object
ch.qos.logback.core.spi.ContextAwareBase
ch.qos.logback.core.AppenderBase<E>
ch.qos.logback.core.net.server.AbstractServerSocketAppender<E>
- All Implemented Interfaces:
Appender<E>
,ContextAware
,FilterAttachable<E>
,LifeCycle
- Direct Known Subclasses:
ServerSocketAppender
,SSLServerSocketAppenderBase
This is the super class for module specific ServerSocketAppender
implementations can derive from.
- Author:
- Carl Harris
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
DefaultServerSocket
backlogstatic final int
Default queue size used for each clientFields inherited from class ch.qos.logback.core.AppenderBase
name, started
Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase
context
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
protected ServerListener
<ch.qos.logback.core.net.server.RemoteReceiverClient> createServerListener
(ServerSocket socket) protected ServerRunner
<ch.qos.logback.core.net.server.RemoteReceiverClient> createServerRunner
(ServerListener<ch.qos.logback.core.net.server.RemoteReceiverClient> listener, Executor executor) Gets the local address for the listener.int
Gets the listener queue depth.int
Gets the event queue size used for each client connection.protected InetAddress
Gets the local address for the listener.int
getPort()
Gets the local port for the listener.protected abstract PreSerializationTransformer
<E> getPST()
Gets a transformer that will be used to convert a received event to aSerializable
form.protected ServerSocketFactory
Gets the factory used to createServerSocket
objects.protected abstract void
postProcessEvent
(E event) Postprocess an event received viaappend()
.void
setAddress
(String address) Sets the local address for the listener.void
setBacklog
(int backlog) Sets the listener queue depth.void
setClientQueueSize
(int clientQueueSize) Sets the event queue size used for each client connection.void
setPort
(int port) Sets the local port for the listener.void
start()
void
stop()
Methods inherited from class ch.qos.logback.core.AppenderBase
addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString
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, wait, wait, wait
Methods inherited from interface ch.qos.logback.core.spi.ContextAware
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext
-
Field Details
-
DEFAULT_BACKLOG
DefaultServerSocket
backlog- See Also:
-
DEFAULT_CLIENT_QUEUE_SIZE
Default queue size used for each client- See Also:
-
-
Constructor Details
-
AbstractServerSocketAppender
public AbstractServerSocketAppender()
-
-
Method Details
-
start
- Specified by:
start
in interfaceLifeCycle
- Overrides:
start
in classAppenderBase<E>
-
createServerListener
protected ServerListener<ch.qos.logback.core.net.server.RemoteReceiverClient> createServerListener(ServerSocket socket) -
createServerRunner
protected ServerRunner<ch.qos.logback.core.net.server.RemoteReceiverClient> createServerRunner(ServerListener<ch.qos.logback.core.net.server.RemoteReceiverClient> listener, Executor executor) -
stop
- Specified by:
stop
in interfaceLifeCycle
- Overrides:
stop
in classAppenderBase<E>
-
append
- Specified by:
append
in classAppenderBase<E>
-
postProcessEvent
Postprocess an event received viaappend()
.- Parameters:
event
-
-
getPST
Gets a transformer that will be used to convert a received event to aSerializable
form.- Returns:
-
getServerSocketFactory
Gets the factory used to createServerSocket
objects.The default implementation delegates to
ServerSocketFactory.getDefault()
. Subclasses may override to private a different socket factory implementation.- Returns:
- socket factory.
- Throws:
Exception
-
getInetAddress
Gets the local address for the listener.- Returns:
- an
InetAddress
representation of the local address. - Throws:
UnknownHostException
-
getPort
Gets the local port for the listener.- Returns:
- local port
-
setPort
Sets the local port for the listener.- Parameters:
port
- the local port to set
-
getBacklog
Gets the listener queue depth.This represents the number of connected clients whose connections have not yet been accepted.
- Returns:
- queue depth
- See Also:
-
setBacklog
Sets the listener queue depth.This represents the number of connected clients whose connections have not yet been accepted.
- Parameters:
backlog
- the queue depth to set- See Also:
-
getAddress
Gets the local address for the listener.- Returns:
- a string representation of the local address
-
setAddress
Sets the local address for the listener.- Parameters:
address
- a host name or a string representation of an IP address
-
getClientQueueSize
Gets the event queue size used for each client connection.- Returns:
- queue size
-
setClientQueueSize
Sets the event queue size used for each client connection.- Parameters:
clientQueueSize
- the queue size to set
-