SocketConfig (Ldaptive 1.2.4 API)

java.lang.Object
- org.ldaptive.AbstractConfig
- - org.ldaptive.ssl.SocketConfig

public class SocketConfig
extends AbstractConfig

Contains the configuration data for sockets.

Field Summary

Fields
Modifier and Type	Field and Description
`private Boolean`	`keepAlive` Keep alive.
`private Boolean`	`oobInline` OOB Inline.
`private Integer`	`receiveBufferSize` Receive buffer size.
`private Boolean`	`reuseAddress` Reuse address.
`private Integer`	`sendBufferSize` Send buffer size.
`private Integer`	`soLinger` SO Linger.
`private Integer`	`soTimeout` SO Timeout.
`private Boolean`	`tcpNoDelay` TCP No Delay.
`private Integer`	`trafficClass` Traffic Class.

Fields inherited from class org.ldaptive.AbstractConfig
logger

Constructor Summary

Constructors
Constructor and Description

SocketConfig()

Constructors
Constructor and Description
`SocketConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`configureSocket(Socket socket)` Applies this configuration to the supplied socket.
`Boolean`	`getKeepAlive()` See `Socket.getKeepAlive()`.
`Boolean`	`getOOBInline()` See `Socket.getOOBInline()`.
`Integer`	`getReceiveBufferSize()` See `Socket.getReceiveBufferSize()`.
`Boolean`	`getReuseAddress()` See `Socket.getReuseAddress()`.
`Integer`	`getSendBufferSize()` See `Socket.getSendBufferSize()`.
`Integer`	`getSoLinger()` See `Socket.getSoLinger()`.
`Integer`	`getSoTimeout()` See `Socket.getSoTimeout()`.
`Boolean`	`getTcpNoDelay()` See `Socket.getTcpNoDelay()`.
`Integer`	`getTrafficClass()` See `Socket.getTrafficClass()`.
`boolean`	`isEmpty()` Returns whether this socket config contains any configuration data.
`void`	`setKeepAlive(boolean b)` See `Socket.setKeepAlive(boolean)`.
`void`	`setOOBInline(boolean b)` See `Socket.setOOBInline(boolean)`.
`void`	`setReceiveBufferSize(int i)` See `Socket.setReceiveBufferSize(int)`.
`void`	`setReuseAddress(boolean b)` See `Socket.setReuseAddress(boolean)`.
`void`	`setSendBufferSize(int i)` See `Socket.setSendBufferSize(int)`.
`void`	`setSoLinger(int i)` See `Socket.setSoLinger(boolean, int)`.
`void`	`setSoTimeout(int i)` See `Socket.setSoTimeout(int)`.
`void`	`setTcpNoDelay(boolean b)` See `Socket.setTcpNoDelay(boolean)`.
`void`	`setTrafficClass(int i)` See `Socket.setTrafficClass(int)`.
`String`	`toString()`

Methods inherited from class org.ldaptive.AbstractConfig
checkImmutable, checkStringInput, makeImmutable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - keepAlive
```
private Boolean keepAlive
```
    Keep alive.
  - oobInline
```
private Boolean oobInline
```
    OOB Inline.
  - receiveBufferSize
```
private Integer receiveBufferSize
```
    Receive buffer size.
  - sendBufferSize
```
private Integer sendBufferSize
```
    Send buffer size.
  - reuseAddress
```
private Boolean reuseAddress
```
    Reuse address.
  - soLinger
```
private Integer soLinger
```
    SO Linger.
  - soTimeout
```
private Integer soTimeout
```
    SO Timeout.
  - tcpNoDelay
```
private Boolean tcpNoDelay
```
    TCP No Delay.
  - trafficClass
```
private Integer trafficClass
```
    Traffic Class.
- Constructor Detail
  - SocketConfig
```
public SocketConfig()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Returns whether this socket config contains any configuration data.
    
    Returns:
    
    whether all properties are null
  - getKeepAlive
```
public Boolean getKeepAlive()
```
    See Socket.getKeepAlive().
    
    Returns:
    
    keep alive
  - setKeepAlive
```
public void setKeepAlive(boolean b)
```
    See Socket.setKeepAlive(boolean).
    
    Parameters:
    
    b - keep alive
  - getOOBInline
```
public Boolean getOOBInline()
```
    See Socket.getOOBInline().
    
    Returns:
    
    OOB in line
  - setOOBInline
```
public void setOOBInline(boolean b)
```
    See Socket.setOOBInline(boolean).
    
    Parameters:
    
    b - OOB in line
  - getReceiveBufferSize
```
public Integer getReceiveBufferSize()
```
    See Socket.getReceiveBufferSize().
    
    Returns:
    
    receive buffer size
  - setReceiveBufferSize
```
public void setReceiveBufferSize(int i)
```
    See Socket.setReceiveBufferSize(int).
    
    Parameters:
    
    i - receive buffer size
  - getSendBufferSize
```
public Integer getSendBufferSize()
```
    See Socket.getSendBufferSize().
    
    Returns:
    
    send buffer size
  - setSendBufferSize
```
public void setSendBufferSize(int i)
```
    See Socket.setSendBufferSize(int).
    
    Parameters:
    
    i - send buffer size
  - getReuseAddress
```
public Boolean getReuseAddress()
```
    See Socket.getReuseAddress().
    
    Returns:
    
    reuse address
  - setReuseAddress
```
public void setReuseAddress(boolean b)
```
    See Socket.setReuseAddress(boolean).
    
    Parameters:
    
    b - reuse address
  - getSoLinger
```
public Integer getSoLinger()
```
    See Socket.getSoLinger().
    
    Returns:
    
    SO linger
  - setSoLinger
```
public void setSoLinger(int i)
```
    See Socket.setSoLinger(boolean, int).
    
    Parameters:
    
    i - SO linger
  - getSoTimeout
```
public Integer getSoTimeout()
```
    See Socket.getSoTimeout().
    
    Returns:
    
    SO timeout
  - setSoTimeout
```
public void setSoTimeout(int i)
```
    See Socket.setSoTimeout(int).
    
    Parameters:
    
    i - SO timeout
  - getTcpNoDelay
```
public Boolean getTcpNoDelay()
```
    See Socket.getTcpNoDelay().
    
    Returns:
    
    tcp no delay
  - setTcpNoDelay
```
public void setTcpNoDelay(boolean b)
```
    See Socket.setTcpNoDelay(boolean).
    
    Parameters:
    
    b - tcp no delay
  - getTrafficClass
```
public Integer getTrafficClass()
```
    See Socket.getTrafficClass().
    
    Returns:
    
    traffic class
  - setTrafficClass
```
public void setTrafficClass(int i)
```
    See Socket.setTrafficClass(int).
    
    Parameters:
    
    i - traffic class
  - configureSocket
```
public void configureSocket(Socket socket)
                     throws SocketException
```
    Applies this configuration to the supplied socket.
    
    Parameters:
    
    socket - to set properties on
    
    Throws:
    
    SocketException - if an error occurs invoking a socket setter
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SocketConfig

Field Summary

Fields inherited from class org.ldaptive.AbstractConfig

Constructor Summary

Method Summary

Methods inherited from class org.ldaptive.AbstractConfig

Methods inherited from class java.lang.Object

Field Detail

keepAlive

oobInline

receiveBufferSize

sendBufferSize

reuseAddress

soLinger

soTimeout

tcpNoDelay

trafficClass

Constructor Detail

SocketConfig

Method Detail

isEmpty

getKeepAlive

setKeepAlive

getOOBInline

setOOBInline

getReceiveBufferSize

setReceiveBufferSize

getSendBufferSize

setSendBufferSize

getReuseAddress

setReuseAddress

getSoLinger

setSoLinger

getSoTimeout

setSoTimeout

getTcpNoDelay

setTcpNoDelay

getTrafficClass

setTrafficClass

configureSocket

toString