org.jgroups.nio

Class NioServer

java.lang.Object

org.jgroups.blocks.BaseServer<Address,NioConnection>

org.jgroups.nio.NioServer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Server<Address>

public class NioServer
extends BaseServer<Address,NioConnection>

Server for sending and receiving messages via NIO channels. Uses only a single thread to accept, connect, write and read connections. Read messages are passed to a receiver, which typically uses a thread pool to process messages.

Note that writes can get dropped, e.g. in the case where we have a previous write pending and a new write is received. This is typically not an issue as JGroups retransmits messages, but might become one when using NioServer standalone, ie. outside of JGroups.

Since:

3.6.5

Author:

Bela Ban

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	NioServer.Acceptor

Nested classes/interfaces inherited from class org.jgroups.blocks.BaseServer

BaseServer.ConnectionListener<A,V extends Connection>, BaseServer.Reaper

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Thread	acceptor
protected java.nio.channels.ServerSocketChannel	channel
protected int	max_read_batch_size
protected int	max_send_buffers
protected java.util.concurrent.locks.Lock	reg_lock
protected boolean	registration
protected java.nio.channels.Selector	selector

Fields inherited from class org.jgroups.blocks.BaseServer

client_bind_addr, client_bind_port, conn_expire_time, conn_listeners, conns, defer_client_binding, factory, linger, local_addr, log, reaper, reaperInterval, receiver, recv_buf_size, running, send_buf_size, sock_conn_timeout, sock_creation_lock, socket_factory, tcp_nodelay, time_service

Constructor Summary

Constructors

Constructor and Description
NioServer(java.net.InetAddress bind_addr, int port)
NioServer(IpAddress local_addr)
NioServer(ThreadFactory f, SocketFactory socket_factory, Receiver<Address> r, java.net.InetAddress bind_addr, java.net.InetAddress external_addr, int external_port, int srv_port, int end_port, long reaper_interval, long conn_expire_time)

Method Summary

Modifier and Type	Method and Description
protected NioConnection	createConnection(Address dest) Creates a new connection object to target dest, but doesn't yet connect it
int	maxReadBatchSize()
NioServer	maxReadBatchSize(int size)
int	maxSendBuffers()
NioServer	maxSendBuffers(int num)
java.lang.String	printBuffers() Prints send and receive buffers for all connections
protected java.nio.channels.SelectionKey	register(java.nio.channels.SelectableChannel ch, int interest_ops, NioConnection conn)
void	start() Starts the server.
void	stop() Stops the server, e.g.

Methods inherited from class org.jgroups.blocks.BaseServer

addConnection, addConnectionListener, clientBindAddress, clientBindAddress, clientBindPort, clientBindPort, close, connectionEstablishedTo, connExpireTime, connExpireTimeout, deferClientBinding, deferClientBinding, explanation, getConnection, getNumConnections, getNumOpenConnections, hasConnection, linger, linger, localAddress, log, log, notifyConnectionClosed, notifyConnectionOpened, printConnections, reaperInterval, reaperInterval, receive, receive, receiveBufferSize, receiveBufferSize, receiver, receiver, removeConnectionIfPresent, removeConnectionListener, replaceConnection, retainAll, send, send, sendBufferSize, sendBufferSize, socketConnectionTimeout, socketConnectionTimeout, socketFactory, socketFactory, tcpNodelay, tcpNodelay, timeService, timeService, toString, validateArgs

Methods inherited from class java.lang.Object

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

Field Detail

channel

protected java.nio.channels.ServerSocketChannel channel

selector

protected java.nio.channels.Selector selector

acceptor

protected final java.lang.Thread acceptor

reg_lock

protected final java.util.concurrent.locks.Lock reg_lock

registration

protected volatile boolean registration

max_send_buffers

protected int max_send_buffers

max_read_batch_size

protected int max_read_batch_size

Constructor Detail

NioServer

public NioServer(IpAddress local_addr)
          throws java.lang.Exception

Throws:

java.lang.Exception

NioServer

public NioServer(java.net.InetAddress bind_addr,
                 int port)
          throws java.lang.Exception

Throws:

java.lang.Exception

NioServer

public NioServer(ThreadFactory f,
                 SocketFactory socket_factory,
                 Receiver<Address> r,
                 java.net.InetAddress bind_addr,
                 java.net.InetAddress external_addr,
                 int external_port,
                 int srv_port,
                 int end_port,
                 long reaper_interval,
                 long conn_expire_time)
          throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

maxSendBuffers

public int maxSendBuffers()

maxSendBuffers

public NioServer maxSendBuffers(int num)

maxReadBatchSize

public int maxReadBatchSize()

maxReadBatchSize

public NioServer maxReadBatchSize(int size)

printBuffers

public java.lang.String printBuffers()

Prints send and receive buffers for all connections

start

public void start()
           throws java.lang.Exception

Description copied from interface: Server

Starts the server. Implementations will typically create a socket and start a select loop. Note that start() should return immediately, and work (e.g. select()) should be done in a separate thread

Specified by:

start in interface Server<Address>

Overrides:

start in class BaseServer<Address,NioConnection>

Throws:

java.lang.Exception

stop

public void stop()

Description copied from interface: Server

Stops the server, e.g. by killing the thread calling select()

Specified by:

stop in interface Server<Address>

Overrides:

stop in class BaseServer<Address,NioConnection>

createConnection

protected NioConnection createConnection(Address dest)
                                  throws java.lang.Exception

Description copied from class: BaseServer

Creates a new connection object to target dest, but doesn't yet connect it

Specified by:

createConnection in class BaseServer<Address,NioConnection>

Throws:

java.lang.Exception

register

protected java.nio.channels.SelectionKey register(java.nio.channels.SelectableChannel ch,
                                                  int interest_ops,
                                                  NioConnection conn)
                                           throws java.lang.Exception

Throws:

java.lang.Exception