XNIO version 1.2.0.GA

org.jboss.xnio.channels
Class CommonOptions

java.lang.Object
  extended by org.jboss.xnio.channels.CommonOptions

public final class CommonOptions
extends Object

Common channel options.


Field Summary
static ChannelOption<Integer> BACKLOG
          Configure a server with the specified backlog.
static ChannelOption<Boolean> BROADCAST
          Enable broadcast support for IP datagram sockets.
static ChannelOption<Boolean> CLOSE_ABORT
          Configure a TCP socket to send an RST packet on close.
static ChannelOption<Integer> IP_TOS
          Type of service for IP sockets.
static ChannelOption<Integer> IP_TRAFFIC_CLASS
          Set the IP traffic class/type-of-service for the channel.
static ChannelOption<Boolean> KEEP_ALIVE
          Configure a channel to send a periodic heartbeat of some sort.
static ChannelOption<Boolean> MANAGE_CONNECTIONS
          Configure an acceptor to manage connections or to leave them unmanaged.
static ChannelOption<Integer> MULTICAST_TTL
          Set the multicast time-to-live field for datagram sockets.
static ChannelOption<Integer> RECEIVE_BUFFER
          The receive buffer size.
static ChannelOption<Boolean> REUSE_ADDRESSES
          Configure an IP socket to reuse addresses.
static ChannelOption<Integer> SEND_BUFFER
          The send buffer size.
static ChannelOption<Boolean> TCP_NODELAY
          Configure a TCP socket to disable Nagle's algorithm.
static ChannelOption<Boolean> TCP_OOB_INLINE
          Configure a TCP socket to receive out-of-band data alongside regular data.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IP_TOS

public static final ChannelOption<Integer> IP_TOS
Type of service for IP sockets. The value type for this option is int. The value given is only a hint to the operating system, and may be ignored.


BROADCAST

public static final ChannelOption<Boolean> BROADCAST
Enable broadcast support for IP datagram sockets. The value type for this option is boolean. If you intend to send datagrams to a broadcast address, this option must be enabled.


CLOSE_ABORT

public static final ChannelOption<Boolean> CLOSE_ABORT
Configure a TCP socket to send an RST packet on close. The value type for this option is boolean.


RECEIVE_BUFFER

public static final ChannelOption<Integer> RECEIVE_BUFFER
The receive buffer size. The value type for this option is int. This may be used by an XNIO provider directly, or it may be passed to the underlying operating system, depending on the channel type.


REUSE_ADDRESSES

public static final ChannelOption<Boolean> REUSE_ADDRESSES
Configure an IP socket to reuse addresses. The value type for this option is boolean.


SEND_BUFFER

public static final ChannelOption<Integer> SEND_BUFFER
The send buffer size. The value type for this option is int. This may be used by an XNIO provider directly, or it may be passed to the underlying operating system, depending on the channel type.


TCP_NODELAY

public static final ChannelOption<Boolean> TCP_NODELAY
Configure a TCP socket to disable Nagle's algorithm. The value type for this option is boolean.


MULTICAST_TTL

public static final ChannelOption<Integer> MULTICAST_TTL
Set the multicast time-to-live field for datagram sockets. The value type for this option is int.


IP_TRAFFIC_CLASS

public static final ChannelOption<Integer> IP_TRAFFIC_CLASS
Set the IP traffic class/type-of-service for the channel. The value type for this option is int.


TCP_OOB_INLINE

public static final ChannelOption<Boolean> TCP_OOB_INLINE
Configure a TCP socket to receive out-of-band data alongside regular data. The value type for this option is boolean.


KEEP_ALIVE

public static final ChannelOption<Boolean> KEEP_ALIVE
Configure a channel to send a periodic heartbeat of some sort. The value type for this option is boolean.


BACKLOG

public static final ChannelOption<Integer> BACKLOG
Configure a server with the specified backlog. The value type for this option is int.


MANAGE_CONNECTIONS

public static final ChannelOption<Boolean> MANAGE_CONNECTIONS
Configure an acceptor to manage connections or to leave them unmanaged. A managed entity will appear in any registered MBean server, but there may be a performance penalty associated with management. In general it is recommended to always enable management, unless a specific performance problem is identified.

Since:
1.2

XNIO version 1.2.0.GA

Copyright © 2008 JBoss, a division of Red Hat, Inc.