Transport (Payara Project 5.2020.3 API)

All Superinterfaces:

ConfigBeanProxy, PropertyBag
```
public interface Transport
extends ConfigBeanProxy, PropertyBag
```
Defines one specific transport and its properties

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Transport.Duck

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Transport.Duck`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCEPTOR_THREADS`
`static int`	`BUFFER_SIZE`
`static String`	`BYTE_BUFFER_TYPE`
`static String`	`CLASSNAME`
`static boolean`	`DEDICATED_ACCEPTOR_ENABLED`
`static boolean`	`DISPLAY_CONFIGURATION`
`static int`	`IDLE_KEY_TIMEOUT`
`static int`	`LINGER`
`static int`	`MAX_CONNECTIONS_COUNT`
`static int`	`READ_TIMEOUT`
`static int`	`SELECTOR_POLL_TIMEOUT`
`static int`	`SOCKET_RCV_BUFFER_SIZE`
`static int`	`SOCKET_SND_BUFFER_SIZE`
`static boolean`	`TCP_NO_DELAY`
`static int`	`WRITE_TIMEOUT`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`List<NetworkListener>`	`findNetworkListeners()`
`String`	`getAcceptorThreads()` The number of acceptor threads listening for the transport's events
`String`	`getBufferSizeBytes()` Deprecated. This attribute is now ignored. Use socket-send-Buffer-size and/or socket-write-buffer-size instead.
`@Pattern(regexp="heap\|direct",flags=CASE_INSENSITIVE) String`	`getByteBufferType()` Type of ByteBuffer, which will be used with transport.
`String`	`getClassname()` Name of class, which implements transport logic
`String`	`getDedicatedAcceptorEnabled()`
`String`	`getDisplayConfiguration()` Flush Grizzly's internal configuration to the server logs (like number of threads created, how many polled objects, etc.)
`String`	`getIdleKeyTimeoutSeconds()` Timeout, after which idle key will be cancelled and channel closed
`String`	`getIoStrategy()` `IOStrategy` to be used by `Transport`.
`String`	`getLinger()`
`String`	`getMaxConnectionsCount()` The max number of connections the transport should handle at the same time
`String`	`getName()` Transport's name, which could be used as reference
`Transports`	`getParent()` Returns the parent element of this configuration element.
`String`	`getReadTimeoutMillis()` Read operation timeout in ms
`String`	`getSelectionKeyHandler()` Deprecated. This attribute as well as the named selection-key-handler element this attribute refers to has been deprecated and is effectively ignored by the runtime. No equivalent functionality is available.
`String`	`getSelectorPollTimeoutMillis()` The time, in milliseconds, a NIO Selector will block waiting for events (users requests).
`String`	`getSocketReadBufferSize()` The size, in bytes, of the socket send buffer size.
`String`	`getSocketWriteBufferSize()` The size, in bytes, of the socket send buffer size.
`String`	`getTcpNoDelay()`
`String`	`getWriteTimeoutMillis()` Write operation timeout in ms
`void`	`setAcceptorThreads(String value)`
`void`	`setBufferSizeBytes(String size)`
`void`	`setByteBufferType(String value)`
`void`	`setClassname(String value)`
`void`	`setDedicatedAcceptorEnabled(String isEnabled)`
`void`	`setDisplayConfiguration(String bool)`
`void`	`setIdleKeyTimeoutSeconds(String value)`
`void`	`setIoStrategy(String ioStrategy)`
`void`	`setLinger(String linger)`
`void`	`setMaxConnectionsCount(String value)`
`void`	`setName(String value)`
`void`	`setReadTimeoutMillis(String value)`
`void`	`setSelectionKeyHandler(String value)`
`void`	`setSelectorPollTimeoutMillis(String timeout)`
`void`	`setSocketReadBufferSize()`
`void`	`setSocketWriteBufferSize()`
`void`	`setTcpNoDelay(String noDelay)`
`void`	`setWriteTimeoutMillis(String value)`

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy
createChild, deepCopy, getParent

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag
addProperty, getProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

- Field Detail
  - DISPLAY_CONFIGURATION
```
static final boolean DISPLAY_CONFIGURATION
```
    See Also:
    
    Constant Field Values
  - TCP_NO_DELAY
```
static final boolean TCP_NO_DELAY
```
    See Also:
    
    Constant Field Values
  - ACCEPTOR_THREADS
```
static final int ACCEPTOR_THREADS
```
    See Also:
    
    Constant Field Values
  - BUFFER_SIZE
```
static final int BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - IDLE_KEY_TIMEOUT
```
static final int IDLE_KEY_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - LINGER
```
static final int LINGER
```
    See Also:
    
    Constant Field Values
  - MAX_CONNECTIONS_COUNT
```
static final int MAX_CONNECTIONS_COUNT
```
    See Also:
    
    Constant Field Values
  - READ_TIMEOUT
```
static final int READ_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - WRITE_TIMEOUT
```
static final int WRITE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - SELECTOR_POLL_TIMEOUT
```
static final int SELECTOR_POLL_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - SOCKET_RCV_BUFFER_SIZE
```
static final int SOCKET_RCV_BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - SOCKET_SND_BUFFER_SIZE
```
static final int SOCKET_SND_BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - BYTE_BUFFER_TYPE
```
static final String BYTE_BUFFER_TYPE
```
    See Also:
    
    Constant Field Values
  - CLASSNAME
```
static final String CLASSNAME
```
    See Also:
    
    Constant Field Values
  - DEDICATED_ACCEPTOR_ENABLED
```
static final boolean DEDICATED_ACCEPTOR_ENABLED
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getAcceptorThreads
```
String getAcceptorThreads()
```
    The number of acceptor threads listening for the transport's events
  - setAcceptorThreads
```
void setAcceptorThreads(String value)
```
  - getSocketWriteBufferSize
```
String getSocketWriteBufferSize()
```
    The size, in bytes, of the socket send buffer size. If the value is 0 or less, it defaults to the VM's default value.
  - setSocketWriteBufferSize
```
void setSocketWriteBufferSize()
```
  - getSocketReadBufferSize
```
String getSocketReadBufferSize()
```
    The size, in bytes, of the socket send buffer size. If the value is 0 or less, it defaults to the VM's default value.
  - setSocketReadBufferSize
```
void setSocketReadBufferSize()
```
  - getBufferSizeBytes
```
@Deprecated
String getBufferSizeBytes()
```
    Deprecated. This attribute is now ignored. Use socket-send-Buffer-size and/or socket-write-buffer-size instead.
  - setBufferSizeBytes
```
void setBufferSizeBytes(String size)
```
  - getByteBufferType
```
@Pattern(regexp="heap|direct",
         flags=CASE_INSENSITIVE)
@Pattern(regexp="heap|direct",flags=CASE_INSENSITIVE) String getByteBufferType()
```
    Type of ByteBuffer, which will be used with transport. Possible values are: HEAP and DIRECT
  - setByteBufferType
```
void setByteBufferType(String value)
```
  - getClassname
```
String getClassname()
```
    Name of class, which implements transport logic
  - setClassname
```
void setClassname(String value)
```
  - getIoStrategy
```
String getIoStrategy()
```
    IOStrategy to be used by Transport.
  - setIoStrategy
```
void setIoStrategy(String ioStrategy)
```
  - getDisplayConfiguration
```
String getDisplayConfiguration()
```
    Flush Grizzly's internal configuration to the server logs (like number of threads created, how many polled objects, etc.)
  - setDisplayConfiguration
```
void setDisplayConfiguration(String bool)
```
  - getIdleKeyTimeoutSeconds
```
String getIdleKeyTimeoutSeconds()
```
    Timeout, after which idle key will be cancelled and channel closed
  - setIdleKeyTimeoutSeconds
```
void setIdleKeyTimeoutSeconds(String value)
```
  - getMaxConnectionsCount
```
String getMaxConnectionsCount()
```
    The max number of connections the transport should handle at the same time
  - setMaxConnectionsCount
```
void setMaxConnectionsCount(String value)
```
  - getName
```
String getName()
```
    Transport's name, which could be used as reference
  - setName
```
void setName(String value)
```
  - getReadTimeoutMillis
```
String getReadTimeoutMillis()
```
    Read operation timeout in ms
  - setReadTimeoutMillis
```
void setReadTimeoutMillis(String value)
```
  - getSelectionKeyHandler
```
@Deprecated
String getSelectionKeyHandler()
```
    Deprecated. This attribute as well as the named selection-key-handler element this attribute refers to has been deprecated and is effectively ignored by the runtime. No equivalent functionality is available.
    
    Use public SelectionKey handler, which was defined earlier in the document.
  - setSelectionKeyHandler
```
void setSelectionKeyHandler(String value)
```
  - getSelectorPollTimeoutMillis
```
String getSelectorPollTimeoutMillis()
```
    The time, in milliseconds, a NIO Selector will block waiting for events (users requests).
  - setSelectorPollTimeoutMillis
```
void setSelectorPollTimeoutMillis(String timeout)
```
  - getWriteTimeoutMillis
```
String getWriteTimeoutMillis()
```
    Write operation timeout in ms
  - setWriteTimeoutMillis
```
void setWriteTimeoutMillis(String value)
```
  - getTcpNoDelay
```
String getTcpNoDelay()
```
  - setTcpNoDelay
```
void setTcpNoDelay(String noDelay)
```
  - getLinger
```
String getLinger()
```
  - setLinger
```
void setLinger(String linger)
```
  - getDedicatedAcceptorEnabled
```
String getDedicatedAcceptorEnabled()
```
  - setDedicatedAcceptorEnabled
```
void setDedicatedAcceptorEnabled(String isEnabled)
```
  - findNetworkListeners
```
@DuckTyped
List<NetworkListener> findNetworkListeners()
```
  - getParent
```
@DuckTyped
Transports getParent()
```
    Description copied from interface: ConfigBeanProxy
    
    Returns the parent element of this configuration element. It is possible to return a not null parent while the parent knows nothing of this child element. This could happen when the child element was removed from the configuration tree, yet it's parent would not have been reset.
    
    Specified by:
    
    getParent in interface ConfigBeanProxy
    
    Returns:
    
    the parent configuration node.

Interface Transport

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

Field Detail

DISPLAY_CONFIGURATION

TCP_NO_DELAY

ACCEPTOR_THREADS

BUFFER_SIZE

IDLE_KEY_TIMEOUT

LINGER

MAX_CONNECTIONS_COUNT

READ_TIMEOUT

WRITE_TIMEOUT

SELECTOR_POLL_TIMEOUT

SOCKET_RCV_BUFFER_SIZE

SOCKET_SND_BUFFER_SIZE

BYTE_BUFFER_TYPE

CLASSNAME

DEDICATED_ACCEPTOR_ENABLED

Method Detail

getAcceptorThreads

setAcceptorThreads

getSocketWriteBufferSize

setSocketWriteBufferSize

getSocketReadBufferSize

setSocketReadBufferSize

getBufferSizeBytes

setBufferSizeBytes

getByteBufferType

setByteBufferType

getClassname

setClassname

getIoStrategy

setIoStrategy

getDisplayConfiguration

setDisplayConfiguration

getIdleKeyTimeoutSeconds

setIdleKeyTimeoutSeconds

getMaxConnectionsCount

setMaxConnectionsCount

getName

setName

getReadTimeoutMillis

setReadTimeoutMillis

getSelectionKeyHandler

setSelectionKeyHandler

getSelectorPollTimeoutMillis

setSelectorPollTimeoutMillis

getWriteTimeoutMillis

setWriteTimeoutMillis

getTcpNoDelay

setTcpNoDelay

getLinger

setLinger

getDedicatedAcceptorEnabled

setDedicatedAcceptorEnabled

findNetworkListeners

getParent