Package org.apache.logging.log4j.core.net

Class SocketOptions

java.lang.Object

org.apache.logging.log4j.core.net.SocketOptions

All Implemented Interfaces:

Cloneable, Builder<SocketOptions>

@Plugin(name="SocketOptions",
        category="Core",
        printObject=true)
public class SocketOptions
extends Object
implements Builder<SocketOptions>, Cloneable

Holds all socket options settable via Socket methods.

Constructor Summary

Constructors

Constructor	Description
SocketOptions()

Method Summary

Modifier and Type	Method	Description
void	apply(Socket socket)	Applies the values in this builder to the given socket.
SocketOptions	build()	Builds the object after all configuration has been set.
Integer	getActualTrafficClass()	See Socket.setTrafficClass(int).
SocketPerformancePreferences	getPerformancePreferences()	See Socket.setPerformancePreferences(int, int, int).
Integer	getReceiveBufferSize()	See Socket.setReceiveBufferSize(int).
Rfc1349TrafficClass	getRfc1349TrafficClass()	See Socket.setTrafficClass(int).
Integer	getSendBufferSize()	See Socket.setSendBufferSize(int).
Integer	getSoLinger()	See Socket.setSoLinger(boolean, int).
Integer	getSoTimeout()	See Socket.setSoTimeout(int).
Integer	getTrafficClass()	See Socket.setTrafficClass(int).
Boolean	isKeepAlive()	See Socket.setKeepAlive(boolean).
Boolean	isOobInline()	See Socket.setOOBInline(boolean).
Boolean	isReuseAddress()	See Socket.setReuseAddress(boolean).
Boolean	isTcpNoDelay()	See Socket.setTcpNoDelay(boolean).
static SocketOptions	newBuilder()	Constructs a new builder.
SocketOptions	setKeepAlive(boolean keepAlive)	See Socket.setKeepAlive(boolean).
SocketOptions	setOobInline(boolean oobInline)	See Socket.setOOBInline(boolean).
SocketOptions	setPerformancePreferences(SocketPerformancePreferences performancePreferences)	See Socket.setPerformancePreferences(int, int, int).
SocketOptions	setReceiveBufferSize(int receiveBufferSize)	See Socket.setReceiveBufferSize(int).
SocketOptions	setReuseAddress(boolean reuseAddress)	See Socket.setReuseAddress(boolean).
SocketOptions	setRfc1349TrafficClass(Rfc1349TrafficClass trafficClass)	See Socket.setTrafficClass(int).
SocketOptions	setSendBufferSize(int sendBufferSize)	See Socket.setSendBufferSize(int).
SocketOptions	setSoLinger(int soLinger)	See Socket.setSoLinger(boolean, int).
SocketOptions	setSoTimeout(int soTimeout)	See Socket.setSoTimeout(int).
SocketOptions	setTcpNoDelay(boolean tcpNoDelay)	See Socket.setTcpNoDelay(boolean).
SocketOptions	setTrafficClass(int trafficClass)	See Socket.setTrafficClass(int).
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.util.Builder

getErrorPrefix, isValid

Constructor Details

SocketOptions

public SocketOptions()

Method Details

newBuilder

@PluginBuilderFactory
public static SocketOptions newBuilder()

Constructs a new builder.

Returns:

a new builder.

apply

public void apply(Socket socket)
           throws SocketException

Applies the values in this builder to the given socket.

Parameters:

socket - The target Socket.

Throws:

SocketException - if there is an error in the underlying protocol, such as a TCP error.

build

public SocketOptions build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<SocketOptions>

Returns:

the configured instance.

getActualTrafficClass

public Integer getActualTrafficClass()

See Socket.setTrafficClass(int).

Returns:

the value to apply to a Socket.

getPerformancePreferences

public SocketPerformancePreferences getPerformancePreferences()

See Socket.setPerformancePreferences(int, int, int).

Returns:

this.

getReceiveBufferSize

public Integer getReceiveBufferSize()

See Socket.setReceiveBufferSize(int).

Returns:

the value to apply to a Socket.

getRfc1349TrafficClass

public Rfc1349TrafficClass getRfc1349TrafficClass()

See Socket.setTrafficClass(int).

Returns:

the value to apply to a Socket.

getSendBufferSize

public Integer getSendBufferSize()

See Socket.setSendBufferSize(int).

Returns:

the value to apply to a Socket.

getSoLinger

public Integer getSoLinger()

See Socket.setSoLinger(boolean, int).

Returns:

the value to apply to a Socket.

getSoTimeout

public Integer getSoTimeout()

See Socket.setSoTimeout(int).

Returns:

the value to apply to a Socket.

getTrafficClass

public Integer getTrafficClass()

See Socket.setTrafficClass(int).

Returns:

the value to apply to a Socket.

isKeepAlive

public Boolean isKeepAlive()

See Socket.setKeepAlive(boolean).

Returns:

the value to apply to a Socket.

isOobInline

public Boolean isOobInline()

See Socket.setOOBInline(boolean).

Returns:

the value to apply to a Socket.

isReuseAddress

public Boolean isReuseAddress()

See Socket.setReuseAddress(boolean).

Returns:

the value to apply to a Socket.

isTcpNoDelay

public Boolean isTcpNoDelay()

See Socket.setTcpNoDelay(boolean).

Returns:

the value to apply to a Socket.

setKeepAlive

public SocketOptions setKeepAlive(boolean keepAlive)

See Socket.setKeepAlive(boolean).

Parameters:

keepAlive - See Socket.setKeepAlive(boolean).

Returns:

this.

setOobInline

public SocketOptions setOobInline(boolean oobInline)

See Socket.setOOBInline(boolean).

Parameters:

oobInline - See Socket.setOOBInline(boolean).

Returns:

this.

setPerformancePreferences

public SocketOptions setPerformancePreferences(SocketPerformancePreferences performancePreferences)

See Socket.setPerformancePreferences(int, int, int).

Parameters:

performancePreferences - See Socket.setPerformancePreferences(int, int, int).

Returns:

this.

setReceiveBufferSize

public SocketOptions setReceiveBufferSize(int receiveBufferSize)

See Socket.setReceiveBufferSize(int).

Parameters:

receiveBufferSize - See Socket.setReceiveBufferSize(int).

Returns:

this.

setReuseAddress

public SocketOptions setReuseAddress(boolean reuseAddress)

See Socket.setReuseAddress(boolean).

Parameters:

reuseAddress - See Socket.setReuseAddress(boolean).

Returns:

this.

setRfc1349TrafficClass

public SocketOptions setRfc1349TrafficClass(Rfc1349TrafficClass trafficClass)

See Socket.setTrafficClass(int).

Parameters:

trafficClass - See Socket.setTrafficClass(int).

Returns:

the value to apply to a Socket.

setSendBufferSize

public SocketOptions setSendBufferSize(int sendBufferSize)

See Socket.setSendBufferSize(int).

Parameters:

sendBufferSize - See Socket.setSendBufferSize(int).

Returns:

this.

setSoLinger

public SocketOptions setSoLinger(int soLinger)

See Socket.setSoLinger(boolean, int).

Parameters:

soLinger - See Socket.setSoLinger(boolean, int).

Returns:

this.

setSoTimeout

public SocketOptions setSoTimeout(int soTimeout)

See Socket.setSoTimeout(int).

Parameters:

soTimeout - See Socket.setSoTimeout(int).

Returns:

this.

setTcpNoDelay

public SocketOptions setTcpNoDelay(boolean tcpNoDelay)

See Socket.setTcpNoDelay(boolean).

Parameters:

tcpNoDelay - See Socket.setTcpNoDelay(boolean).

Returns:

this.

setTrafficClass

public SocketOptions setTrafficClass(int trafficClass)

See Socket.setTrafficClass(int).

Parameters:

trafficClass - See Socket.setTrafficClass(int).

Returns:

this.

toString

public String toString()

Overrides:

toString in class Object