TransportOptions (QpidJMS Client 0.11.0 API)

java.lang.Object
- org.apache.qpid.jms.transports.TransportOptions

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

TransportSslOptions
```
public class TransportOptions
extends Object
implements Cloneable
```
Encapsulates all the TCP Transport options in one configuration object.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_CONNECT_TIMEOUT`
`static int`	`DEFAULT_RECEIVE_BUFFER_SIZE`
`static int`	`DEFAULT_SEND_BUFFER_SIZE`
`static int`	`DEFAULT_SO_LINGER`
`static int`	`DEFAULT_SO_TIMEOUT`
`static boolean`	`DEFAULT_TCP_KEEP_ALIVE`
`static boolean`	`DEFAULT_TCP_NO_DELAY`
`static int`	`DEFAULT_TCP_PORT`
`static int`	`DEFAULT_TRAFFIC_CLASS`
`static TransportOptions`	`INSTANCE`

Constructor Summary

Constructors
Constructor and Description

TransportOptions()

Constructors
Constructor and Description
`TransportOptions()`

Method Summary

Methods
Modifier and Type	Method and Description
`TransportOptions`	`clone()`
`protected TransportOptions`	`copyOptions(TransportOptions copy)`
`int`	`getConnectTimeout()`
`int`	`getDefaultTcpPort()`
`int`	`getReceiveBufferSize()`
`int`	`getSendBufferSize()`
`int`	`getSoLinger()`
`int`	`getSoTimeout()`
`int`	`getTrafficClass()`
`boolean`	`isSSL()`
`boolean`	`isTcpKeepAlive()`
`boolean`	`isTcpNoDelay()`
`void`	`setConnectTimeout(int connectTimeout)`
`void`	`setDefaultTcpPort(int defaultTcpPort)`
`void`	`setReceiveBufferSize(int receiveBufferSize)` Sets the receive buffer size in bytes, the value must be greater than zero or an `IllegalArgumentException` will be thrown.
`void`	`setSendBufferSize(int sendBufferSize)` Sets the send buffer size in bytes, the value must be greater than zero or an `IllegalArgumentException` will be thrown.
`void`	`setSoLinger(int soLinger)`
`void`	`setSoTimeout(int soTimeout)`
`void`	`setTcpKeepAlive(boolean keepAlive)`
`void`	`setTcpNoDelay(boolean tcpNoDelay)`
`void`	`setTrafficClass(int trafficClass)` Sets the traffic class value used by the TCP connection, valid range is between 0 and 255.

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

- Field Detail
  - DEFAULT_SEND_BUFFER_SIZE
```
public static final int DEFAULT_SEND_BUFFER_SIZE
```
    See Also:
    Constant Field Values
  - DEFAULT_RECEIVE_BUFFER_SIZE
```
public static final int DEFAULT_RECEIVE_BUFFER_SIZE
```
    See Also:
    Constant Field Values
  - DEFAULT_TRAFFIC_CLASS
```
public static final int DEFAULT_TRAFFIC_CLASS
```
    See Also:
    Constant Field Values
  - DEFAULT_TCP_NO_DELAY
```
public static final boolean DEFAULT_TCP_NO_DELAY
```
    See Also:
    Constant Field Values
  - DEFAULT_TCP_KEEP_ALIVE
```
public static final boolean DEFAULT_TCP_KEEP_ALIVE
```
    See Also:
    Constant Field Values
  - DEFAULT_SO_LINGER
```
public static final int DEFAULT_SO_LINGER
```
    See Also:
    Constant Field Values
  - DEFAULT_SO_TIMEOUT
```
public static final int DEFAULT_SO_TIMEOUT
```
    See Also:
    Constant Field Values
  - DEFAULT_CONNECT_TIMEOUT
```
public static final int DEFAULT_CONNECT_TIMEOUT
```
    See Also:
    Constant Field Values
  - DEFAULT_TCP_PORT
```
public static final int DEFAULT_TCP_PORT
```
    See Also:
    Constant Field Values
  - INSTANCE
```
public static final TransportOptions INSTANCE
```
- Constructor Detail
  - TransportOptions
```
public TransportOptions()
```
- Method Detail
  - getSendBufferSize
```
public int getSendBufferSize()
```
    Returns:
    the currently set send buffer size in bytes.
  - setSendBufferSize
```
public void setSendBufferSize(int sendBufferSize)
```
    Sets the send buffer size in bytes, the value must be greater than zero or an IllegalArgumentException will be thrown.
    
    Parameters:
    sendBufferSize - the new send buffer size for the TCP Transport.
    
    Throws:
    
    IllegalArgumentException - if the value given is not in the valid range.
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    Returns:
    the currently configured receive buffer size in bytes.
  - setReceiveBufferSize
```
public void setReceiveBufferSize(int receiveBufferSize)
```
    Sets the receive buffer size in bytes, the value must be greater than zero or an IllegalArgumentException will be thrown.
    
    Parameters:
    receiveBufferSize - the new receive buffer size for the TCP Transport.
    
    Throws:
    
    IllegalArgumentException - if the value given is not in the valid range.
  - getTrafficClass
```
public int getTrafficClass()
```
    Returns:
    the currently configured traffic class value.
  - setTrafficClass
```
public void setTrafficClass(int trafficClass)
```
    Sets the traffic class value used by the TCP connection, valid range is between 0 and 255.
    
    Parameters:
    trafficClass - the new traffic class value.
    
    Throws:
    
    IllegalArgumentException - if the value given is not in the valid range.
  - getSoTimeout
```
public int getSoTimeout()
```
  - setSoTimeout
```
public void setSoTimeout(int soTimeout)
```
  - isTcpNoDelay
```
public boolean isTcpNoDelay()
```
  - setTcpNoDelay
```
public void setTcpNoDelay(boolean tcpNoDelay)
```
  - getSoLinger
```
public int getSoLinger()
```
  - setSoLinger
```
public void setSoLinger(int soLinger)
```
  - isTcpKeepAlive
```
public boolean isTcpKeepAlive()
```
  - setTcpKeepAlive
```
public void setTcpKeepAlive(boolean keepAlive)
```
  - getConnectTimeout
```
public int getConnectTimeout()
```
  - setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
  - getDefaultTcpPort
```
public int getDefaultTcpPort()
```
  - setDefaultTcpPort
```
public void setDefaultTcpPort(int defaultTcpPort)
```
  - clone
```
public TransportOptions clone()
```
    Overrides:
    
    clone in class Object
  - isSSL
```
public boolean isSSL()
```
  - copyOptions
```
protected TransportOptions copyOptions(TransportOptions copy)
```

Class TransportOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SEND_BUFFER_SIZE

DEFAULT_RECEIVE_BUFFER_SIZE

DEFAULT_TRAFFIC_CLASS

DEFAULT_TCP_NO_DELAY

DEFAULT_TCP_KEEP_ALIVE

DEFAULT_SO_LINGER

DEFAULT_SO_TIMEOUT

DEFAULT_CONNECT_TIMEOUT

DEFAULT_TCP_PORT

INSTANCE

Constructor Detail

TransportOptions

Method Detail

getSendBufferSize

setSendBufferSize

getReceiveBufferSize

setReceiveBufferSize

getTrafficClass

setTrafficClass

getSoTimeout

setSoTimeout

isTcpNoDelay

setTcpNoDelay

getSoLinger

setSoLinger

isTcpKeepAlive

setTcpKeepAlive

getConnectTimeout

setConnectTimeout

getDefaultTcpPort

setDefaultTcpPort

clone

isSSL

copyOptions