com.sun.grizzly
Class UDPSelectorHandler

java.lang.Object
  com.sun.grizzly.TCPSelectorHandler
      com.sun.grizzly.UDPSelectorHandler

All Implemented Interfaces:

Handler, LinuxSpinningWorkaround, SelectorHandler, PendingIOhandler, AttributeHolder, Copyable, SupportStateHolder<State>

Direct Known Subclasses:

ReusableUDPSelectorHandler

public class UDPSelectorHandler
extends TCPSelectorHandler

A SelectorHandler handles all java.nio.channels.Selector operations. One or more instance of a Selector are handled by SelectorHandler. The logic for processing of SelectionKey interest (OP_ACCEPT,OP_READ, etc.) is usually defined using an instance of SelectorHandler. This class represent a UDP implementation of a SelectorHandler. This class first bind a datagramSocketChannel to a UDP port and then start waiting for NIO events.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.grizzly.TCPSelectorHandler

TCPSelectorHandler.ConnectChannelOperation, TCPSelectorHandler.RegisterChannelOperation, TCPSelectorHandler.RegisterKeyOperation, TCPSelectorHandler.RunnableOperation, TCPSelectorHandler.SelectionKeyCancelOperation

Field Summary

protected java.nio.channels.DatagramChannel	datagramChannel The DatagramChannel.
protected java.net.DatagramSocket	datagramSocket The datagramSocket instance.

Fields inherited from class com.sun.grizzly.TCPSelectorHandler

asyncQueueReader, asyncQueueWriter, attributes, connectorInstanceHandler, inet, instanceHandler, isKeepAlive, isShutDown, linger, logger, portRange, postponedTasks, receiveBufferSize, reuseAddress, role, selectionKeyHandler, selector, selectorHandlerTasks, selectTimeout, sendBufferSize, serverSocket, serverSocketChannel, serverTimeout, socketTimeout, ssBackLog, stateHolder, tcpNoDelay, threadPool

Constructor Summary

UDPSelectorHandler()

UDPSelectorHandler(boolean isClient)

UDPSelectorHandler(Role role)

Method Summary

void	closeChannel(java.nio.channels.SelectableChannel channel) Closes SelectableChannel
void	copyTo(Copyable copy)
protected java.util.concurrent.Callable<ConnectorHandler>	getConnectorInstanceHandlerDelegate() Return factory object, which knows how to create ConnectorInstanceHandler corresponding to the protocol
int	getLinger()
int	getPortLowLevel() Returns port number SelectorHandler is listening on Similar to getPort(), but getting port number directly from connection (ServerSocket, DatagramSocket).
java.lang.Class<? extends SelectionKeyHandler>	getPreferredSelectionKeyHandler() Get the preffered SelectionKeyHandler implementation for this SelectorHandler.
protected java.nio.channels.SelectableChannel	getSelectableChannel(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)
int	getSocketNativeReceiveBufferSize()
int	getSocketNativeSendBufferSize()
int	getSocketTimeout()
int	getSsBackLog()
boolean	isTcpNoDelay() Return the tcpNoDelay value used by the underlying accepted Sockets.
boolean	onAcceptInterest(java.nio.channels.SelectionKey key, Context ctx) Handle OP_ACCEPT.
protected void	onConnectOp(Context ctx, TCPSelectorHandler.ConnectChannelOperation selectionKeyOp) Handle new OP_CONNECT ops.
void	preSelect(Context ctx) Before invoking Selector.select(), make sure the ServerScoketChannel has been created.
Controller.Protocol	protocol() A token describing the protocol supported by an implementation of this interface
void	setLinger(int linger)
void	setSocketNativeReceiveBufferSize(int recBuffSize)
void	setSocketNativeSendBufferSize(int sendBuffSize)
void	setSocketTimeout(int socketTimeout)
void	setSsBackLog(int ssBackLog)
void	setTcpNoDelay(boolean tcpNoDelay) Enable (true) or disable (false) the underlying Socket's tcpNoDelay.
void	shutdown() Shuntdown this instance by closing its Selector and associated channels.

Methods inherited from class com.sun.grizzly.TCPSelectorHandler

acceptWithoutRegistration, acquireConnectorHandler, addPendingIO, addPendingKeyCancel, boolean2Role, configureChannel, connect, getAsyncQueueReader, getAsyncQueueWriter, getAttribute, getAttributes, getInet, getLogger, getPort, getPortRange, getProtocolChainInstanceHandler, getRole, getSelectionKeyHandler, getSelector, getSelectTimeout, getServerTimeout, getSpinRate, getStateHolder, getThreadPool, invokeAsyncQueueReader, invokeAsyncQueueWriter, invokeCallbackHandler, isExecutePendingIOUsingSelectorThread, isKeepAlive, isOpen, isReuseAddress, keyFor, keys, onConnectInterest, onReadInterest, onWriteInterest, pause, pollContext, postSelect, processPendingOperations, register, register, register, releaseConnectorHandler, removeAttribute, resetSpinCounter, resume, select, setAttribute, setAttributes, setExecutePendingIOUsingSelectorThread, setInet, setKeepAlive, setLogger, setMaxAcceptRetries, setPort, setPortRange, setProtocolChainInstanceHandler, setReceiveBufferSize, setReuseAddress, setRole, setSelectionKeyHandler, setSelector, setSelectTimeout, setSendBufferSize, setServerTimeout, setThreadPool, workaroundSelectorSpin

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

datagramSocket

protected java.net.DatagramSocket datagramSocket

The datagramSocket instance.

datagramChannel

protected java.nio.channels.DatagramChannel datagramChannel

The DatagramChannel.

Constructor Detail

UDPSelectorHandler

public UDPSelectorHandler()

UDPSelectorHandler

public UDPSelectorHandler(boolean isClient)

UDPSelectorHandler

public UDPSelectorHandler(Role role)

Method Detail

copyTo

public void copyTo(Copyable copy)

Specified by:

copyTo in interface Copyable

Overrides:

copyTo in class TCPSelectorHandler

preSelect

public void preSelect(Context ctx)
               throws java.io.IOException

Before invoking Selector.select(), make sure the ServerScoketChannel has been created. If true, then register all SelectionKey to the Selector.

Specified by:

preSelect in interface SelectorHandler

Overrides:

preSelect in class TCPSelectorHandler

Parameters:

ctx - Context

Throws:

java.io.IOException

getSelectableChannel

protected java.nio.channels.SelectableChannel getSelectableChannel(java.net.SocketAddress remoteAddress,
                                                                   java.net.SocketAddress localAddress)
                                                            throws java.io.IOException

Overrides:

getSelectableChannel in class TCPSelectorHandler

Throws:

java.io.IOException

onConnectOp

protected void onConnectOp(Context ctx,
                           TCPSelectorHandler.ConnectChannelOperation selectionKeyOp)
                    throws java.io.IOException

Handle new OP_CONNECT ops.

Overrides:

onConnectOp in class TCPSelectorHandler

Throws:

java.io.IOException

shutdown

public void shutdown()

Shuntdown this instance by closing its Selector and associated channels.

Specified by:

shutdown in interface SelectorHandler

Overrides:

shutdown in class TCPSelectorHandler

onAcceptInterest

public boolean onAcceptInterest(java.nio.channels.SelectionKey key,
                                Context ctx)
                         throws java.io.IOException

Handle OP_ACCEPT. Not used for UPD.

Specified by:

onAcceptInterest in interface SelectorHandler

Overrides:

onAcceptInterest in class TCPSelectorHandler

Parameters:

key - SelectionKey

ctx - Context

Returns:

always returns false

Throws:

java.io.IOException

getPreferredSelectionKeyHandler

public java.lang.Class<? extends SelectionKeyHandler> getPreferredSelectionKeyHandler()

Get the preffered SelectionKeyHandler implementation for this SelectorHandler.

Specified by:

getPreferredSelectionKeyHandler in interface SelectorHandler

Overrides:

getPreferredSelectionKeyHandler in class TCPSelectorHandler

protocol

public Controller.Protocol protocol()

A token describing the protocol supported by an implementation of this interface

Specified by:

protocol in interface SelectorHandler

Overrides:

protocol in class TCPSelectorHandler

Returns:

SelectorHandler supported protocol

getPortLowLevel

public int getPortLowLevel()

Description copied from class: TCPSelectorHandler

Returns port number SelectorHandler is listening on Similar to getPort(), but getting port number directly from connection (ServerSocket, DatagramSocket). So if default port number 0 was set during initialization, then getPort() will return 0, but getPortLowLevel() will return port number assigned by OS.

Overrides:

getPortLowLevel in class TCPSelectorHandler

Returns:

port number or -1 if SelectorHandler was not initialized for accepting connections.

setSocketNativeSendBufferSize

public void setSocketNativeSendBufferSize(int sendBuffSize)
                                   throws java.net.SocketException

Parameters:

sndBuffSize -

Throws:

java.net.SocketException

setSocketNativeReceiveBufferSize

public void setSocketNativeReceiveBufferSize(int recBuffSize)
                                      throws java.net.SocketException

Parameters:

sndBuffSize -

Throws:

java.net.SocketException

getSocketNativeReceiveBufferSize

public int getSocketNativeReceiveBufferSize()
                                     throws java.net.SocketException

Returns:

Throws:

java.net.SocketException

getSocketNativeSendBufferSize

public int getSocketNativeSendBufferSize()
                                  throws java.net.SocketException

Returns:

Throws:

java.net.SocketException

getSsBackLog

public int getSsBackLog()

Overrides:

getSsBackLog in class TCPSelectorHandler

setSsBackLog

public void setSsBackLog(int ssBackLog)

Overrides:

setSsBackLog in class TCPSelectorHandler

isTcpNoDelay

public boolean isTcpNoDelay()

Description copied from class: TCPSelectorHandler

Return the tcpNoDelay value used by the underlying accepted Sockets. Also see setTcpNoDelay(boolean tcpNoDelay)

Overrides:

isTcpNoDelay in class TCPSelectorHandler

setTcpNoDelay

public void setTcpNoDelay(boolean tcpNoDelay)

Description copied from class: TCPSelectorHandler

Enable (true) or disable (false) the underlying Socket's tcpNoDelay. Default value for tcpNoDelay is enabled (set to true), as according to the performance tests, it performs better for most cases. The Connector side should also set tcpNoDelay the same as it is set here whenever possible.

Overrides:

setTcpNoDelay in class TCPSelectorHandler

getLinger

public int getLinger()

Overrides:

getLinger in class TCPSelectorHandler

setLinger

public void setLinger(int linger)

Overrides:

setLinger in class TCPSelectorHandler

getSocketTimeout

public int getSocketTimeout()

Overrides:

getSocketTimeout in class TCPSelectorHandler

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

Overrides:

setSocketTimeout in class TCPSelectorHandler

closeChannel

public void closeChannel(java.nio.channels.SelectableChannel channel)

Description copied from class: TCPSelectorHandler

Closes SelectableChannel

Specified by:

closeChannel in interface SelectorHandler

Overrides:

closeChannel in class TCPSelectorHandler

getConnectorInstanceHandlerDelegate

protected java.util.concurrent.Callable<ConnectorHandler> getConnectorInstanceHandlerDelegate()

Description copied from class: TCPSelectorHandler

Return factory object, which knows how to create ConnectorInstanceHandler corresponding to the protocol

Overrides:

getConnectorInstanceHandlerDelegate in class TCPSelectorHandler

Returns:

factory