org.gridgain.grid.util.nio

Class GridNioServer<T>

java.lang.Object

org.gridgain.grid.util.nio.GridNioServer<T>

Type Parameters:

T - Message type.

public class GridNioServer<T>
extends Object

TCP NIO server. Due to asynchronous nature of connections processing network events such as client connection, disconnection and message receiving are passed to the server listener. Once client connected, an associated GridNioSession object is created and can be used in communication.

This implementation supports several selectors and several reading threads.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GridNioServer.Builder<T> Constructs a new instance of GridNioServer.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DFLT_SEND_QUEUE_LIMIT Default send queue limit.
static int	DFLT_SES_WRITE_TIMEOUT Default session write timeout.
static int	DIFF_VER_NODE_ID_META_KEY Node ID meta key (set only if versions are different).

Method Summary

Methods

Modifier and Type	Method and Description
static <T> GridNioServer.Builder<T>	builder() Creates and returns a builder for a new instance of this class.
GridNioFuture<Boolean>	close(GridNioSession ses)
GridNioFuture<GridNioSession>	createSession(SocketChannel ch, Map<Integer,?> meta) Establishes a session.
long	idleTimeout() Gets configurable idle timeout for this session.
void	idleTimeout(long idleTimeout) Sets configurable idle timeout for session.
InetSocketAddress	localAddress() Gets the address server is bound to.
int	outboundMessagesQueueSize() Gets outbound messages queue size.
void	start() Starts all associated threads to perform accept and read activities.
void	stop() Stops all threads and releases all resources.
String	toString()
long	writeTimeout() Gets configurable write timeout for this session.
void	writeTimeout(long writeTimeout) Sets configurable write timeout for session.

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_SES_WRITE_TIMEOUT

public static final int DFLT_SES_WRITE_TIMEOUT

Default session write timeout.

See Also:

Constant Field Values

DFLT_SEND_QUEUE_LIMIT

public static final int DFLT_SEND_QUEUE_LIMIT

Default send queue limit.

See Also:

Constant Field Values

DIFF_VER_NODE_ID_META_KEY

public static final int DIFF_VER_NODE_ID_META_KEY

Node ID meta key (set only if versions are different).

Method Detail

builder

public static <T> GridNioServer.Builder<T> builder()

Creates and returns a builder for a new instance of this class.

Returns:

Builder for new instance.

start

public void start()

Starts all associated threads to perform accept and read activities.

stop

public void stop()

Stops all threads and releases all resources.

localAddress

public InetSocketAddress localAddress()

Gets the address server is bound to.

Returns:

Address server is bound to.

close

public GridNioFuture<Boolean> close(GridNioSession ses)

Parameters:

ses - Session to close.

Returns:

Future for operation.

createSession

public GridNioFuture<GridNioSession> createSession(SocketChannel ch,
                                          @Nullable
                                          Map<Integer,?> meta)

Establishes a session.

Parameters:

ch - Channel to register within the server and create session for.

meta - Optional meta for new session.

Returns:

Future to get session.

writeTimeout

public long writeTimeout()

Gets configurable write timeout for this session. If not set, default value is DFLT_SES_WRITE_TIMEOUT.

Returns:

Write timeout in milliseconds.

writeTimeout

public void writeTimeout(long writeTimeout)

Sets configurable write timeout for session.

Parameters:

writeTimeout - Write timeout in milliseconds.

idleTimeout

public long idleTimeout()

Gets configurable idle timeout for this session. If not set, default value is GridConfiguration.DFLT_REST_IDLE_TIMEOUT.

Returns:

Idle timeout in milliseconds.

idleTimeout

public void idleTimeout(long idleTimeout)

Sets configurable idle timeout for session.

Parameters:

idleTimeout - Idle timeout in milliseconds.

toString

public String toString()

Overrides:

toString in class Object

outboundMessagesQueueSize

public int outboundMessagesQueueSize()

Gets outbound messages queue size.

Returns:

Write queue size.