SocketPerformancePreferences

java.lang.Object
- org.apache.logging.log4j.core.net.SocketPerformancePreferences

All Implemented Interfaces:

java.lang.Cloneable, Builder<SocketPerformancePreferences>
```
@Plugin(name="SocketPerformancePreferences",
        category="Core",
        printObject=true)
public class SocketPerformancePreferences
extends java.lang.Object
implements Builder<SocketPerformancePreferences>, java.lang.Cloneable
```
Holds all socket options settable via Socket.setPerformancePreferences(int, int, int).
The Socket.setPerformancePreferences(int, int, int) API may not be implemented by a JRE.

Field Summary

Fields
Modifier and Type Field Description

private int bandwidth

private int connectionTime

private int latency

Constructor Summary

Constructors
Constructor Description

SocketPerformancePreferences()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`apply(java.net.Socket socket)`
`SocketPerformancePreferences`	`build()`	Builds the object after all configuration has been set.
`int`	`getBandwidth()`
`int`	`getConnectionTime()`
`int`	`getLatency()`
`static SocketPerformancePreferences`	`newBuilder()`
`void`	`setBandwidth(int bandwidth)`
`void`	`setConnectionTime(int connectionTime)`
`void`	`setLatency(int latency)`
`java.lang.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

Field Detail

bandwidth

@PluginBuilderAttribute
@Required
private int bandwidth

connectionTime

@PluginBuilderAttribute
@Required
private int connectionTime

latency

@PluginBuilderAttribute
@Required
private int latency

Constructor Detail
- SocketPerformancePreferences
```
public SocketPerformancePreferences()
```

Method Detail

newBuilder

@PluginBuilderFactory
public static SocketPerformancePreferences newBuilder()

apply

public void apply(java.net.Socket socket)

build
```
public SocketPerformancePreferences 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<SocketPerformancePreferences>

Returns:

the configured instance.

getBandwidth
```
public int getBandwidth()
```

getConnectionTime
```
public int getConnectionTime()
```

getLatency
```
public int getLatency()
```

setBandwidth

public void setBandwidth(int bandwidth)

setConnectionTime

public void setConnectionTime(int connectionTime)

setLatency

public void setLatency(int latency)

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object