org.jgroups.blocks

Class BaseServer<A extends Address,C extends Connection>

java.lang.Object

org.jgroups.blocks.BaseServer<A,C>

Type Parameters:

A - The type of the address, e.g. Address

C - The type of the connection, e.g. TcpConnection

All Implemented Interfaces:

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

Direct Known Subclasses:

NioServer, TcpServer

public abstract class BaseServer<A extends Address,C extends Connection>
extends java.lang.Object
implements Server<A>, java.io.Closeable

Abstract class for a server handling sending, receiving and connection management.

Since:

3.6.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BaseServer.ConnectionListener<A,V extends Connection>
protected class	BaseServer.Reaper

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.InetAddress	client_bind_addr
protected int	client_bind_port
protected long	conn_expire_time
protected java.util.List<BaseServer.ConnectionListener<A,C>>	conn_listeners
protected java.util.Map<A,C>	conns
protected boolean	defer_client_binding
protected ThreadFactory	factory
protected int	linger
protected A	local_addr
protected Log	log
protected BaseServer.Reaper	reaper
protected long	reaperInterval
protected Receiver<A>	receiver
protected int	recv_buf_size
protected java.util.concurrent.atomic.AtomicBoolean	running
protected int	send_buf_size
protected int	sock_conn_timeout
protected java.util.concurrent.locks.Lock	sock_creation_lock
protected SocketFactory	socket_factory
protected boolean	tcp_nodelay
protected TimeService	time_service

Constructor Summary

Constructors

Constructor and Description
BaseServer(ThreadFactory f, SocketFactory socket_factory, Receiver<A> r, long reaper_interval, long conn_expire_time)

Method Summary

Modifier and Type	Method and Description
void	addConnection(A peer_addr, C conn)
void	addConnectionListener(BaseServer.ConnectionListener<A,C> cml)
java.net.InetAddress	clientBindAddress()
BaseServer<A,C>	clientBindAddress(java.net.InetAddress addr)
int	clientBindPort()
BaseServer<A,C>	clientBindPort(int port)
void	close()
boolean	connectionEstablishedTo(A address)
long	connExpireTime()
BaseServer<A,C>	connExpireTimeout(long t)
protected abstract C	createConnection(A dest) Creates a new connection object to target dest, but doesn't yet connect it
boolean	deferClientBinding()
BaseServer<A,C>	deferClientBinding(boolean defer)
protected static java.lang.String	explanation(boolean connection_existed, boolean replace)
C	getConnection(A dest) Creates a new connection to dest, or returns an existing one
int	getNumConnections()
int	getNumOpenConnections()
boolean	hasConnection(A address)
int	linger()
BaseServer<A,C>	linger(int linger)
A	localAddress()
Log	log()
BaseServer<A,C>	log(Log the_log)
void	notifyConnectionClosed(A address)
void	notifyConnectionOpened(A address, C conn)
java.lang.String	printConnections()
long	reaperInterval()
BaseServer<A,C>	reaperInterval(long interval)
void	receive(A sender, byte[] data, int offset, int length) Called by a Connection implementation when a message has been received
void	receive(A sender, java.nio.ByteBuffer buf) Called by a Connection implementation when a message has been received
int	receiveBufferSize()
BaseServer<A,C>	receiveBufferSize(int recv_buf_size)
Receiver<A>	receiver()
BaseServer<A,C>	receiver(Receiver<A> r) Sets a receiver
void	removeConnectionIfPresent(A address, C conn) Only removes the connection if conns.get(address) == conn
void	removeConnectionListener(BaseServer.ConnectionListener<A,C> cml)
void	replaceConnection(A address, C conn)
void	retainAll(java.util.Collection<A> current_mbrs) Removes all connections which are not in current_mbrs
void	send(A dest, byte[] data, int offset, int length) Sends a message to a destination
void	send(A dest, java.nio.ByteBuffer data) Sends a message to a destination
int	sendBufferSize()
BaseServer<A,C>	sendBufferSize(int send_buf_size)
int	socketConnectionTimeout()
BaseServer<A,C>	socketConnectionTimeout(int timeout)
SocketFactory	socketFactory()
BaseServer<A,C>	socketFactory(SocketFactory factory)
void	start() Starts the server.
void	stop() Stops the server, e.g.
boolean	tcpNodelay()
BaseServer<A,C>	tcpNodelay(boolean tcp_nodelay)
TimeService	timeService()
BaseServer<A,C>	timeService(TimeService ts)
java.lang.String	toString()
protected <T> boolean	validateArgs(A dest, T buffer)

Methods inherited from class java.lang.Object

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

Field Detail

local_addr

protected A extends Address local_addr

conn_listeners

protected final java.util.List<BaseServer.ConnectionListener<A extends Address,C extends Connection>> conn_listeners

conns

protected final java.util.Map<A extends Address,C extends Connection> conns

sock_creation_lock

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

factory

protected final ThreadFactory factory

reaperInterval

protected long reaperInterval

reaper

protected final BaseServer.Reaper reaper

receiver

protected Receiver<A extends Address> receiver

running

protected final java.util.concurrent.atomic.AtomicBoolean running

log

protected Log log

client_bind_addr

protected java.net.InetAddress client_bind_addr

client_bind_port

protected int client_bind_port

defer_client_binding

protected boolean defer_client_binding

conn_expire_time

protected long conn_expire_time

recv_buf_size

protected int recv_buf_size

send_buf_size

protected int send_buf_size

sock_conn_timeout

protected int sock_conn_timeout

tcp_nodelay

protected boolean tcp_nodelay

linger

protected int linger

socket_factory

protected SocketFactory socket_factory

time_service

protected TimeService time_service

Constructor Detail

BaseServer

public BaseServer(ThreadFactory f,
                  SocketFactory socket_factory,
                  Receiver<A> r,
                  long reaper_interval,
                  long conn_expire_time)
           throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

receiver

public Receiver<A> receiver()

receiver

public BaseServer<A,C> receiver(Receiver<A> r)

Description copied from interface: Server

Sets a receiver

Specified by:

receiver in interface Server<A extends Address>

Parameters:

r - The receiver

reaperInterval

public long reaperInterval()

reaperInterval

public BaseServer<A,C> reaperInterval(long interval)

log

public Log log()

log

public BaseServer<A,C> log(Log the_log)

localAddress

public A localAddress()

socketFactory

public SocketFactory socketFactory()

socketFactory

public BaseServer<A,C> socketFactory(SocketFactory factory)

clientBindAddress

public java.net.InetAddress clientBindAddress()

clientBindAddress

public BaseServer<A,C> clientBindAddress(java.net.InetAddress addr)

clientBindPort

public int clientBindPort()

clientBindPort

public BaseServer<A,C> clientBindPort(int port)

deferClientBinding

public boolean deferClientBinding()

deferClientBinding

public BaseServer<A,C> deferClientBinding(boolean defer)

socketConnectionTimeout

public int socketConnectionTimeout()

socketConnectionTimeout

public BaseServer<A,C> socketConnectionTimeout(int timeout)

connExpireTime

public long connExpireTime()

connExpireTimeout

public BaseServer<A,C> connExpireTimeout(long t)

timeService

public TimeService timeService()

timeService

public BaseServer<A,C> timeService(TimeService ts)

receiveBufferSize

public int receiveBufferSize()

receiveBufferSize

public BaseServer<A,C> receiveBufferSize(int recv_buf_size)

sendBufferSize

public int sendBufferSize()

sendBufferSize

public BaseServer<A,C> sendBufferSize(int send_buf_size)

linger

public int linger()

linger

public BaseServer<A,C> linger(int linger)

tcpNodelay

public boolean tcpNodelay()

tcpNodelay

public BaseServer<A,C> tcpNodelay(boolean tcp_nodelay)

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<A extends Address>

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<A extends Address>

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

receive

public void receive(A sender,
                    byte[] data,
                    int offset,
                    int length)

Called by a Connection implementation when a message has been received

receive

public void receive(A sender,
                    java.nio.ByteBuffer buf)

Called by a Connection implementation when a message has been received

send

public void send(A dest,
                 byte[] data,
                 int offset,
                 int length)
          throws java.lang.Exception

Description copied from interface: Server

Sends a message to a destination

Specified by:

send in interface Server<A extends Address>

Parameters:

dest - The destination address. Must not be null

data - The buffer

offset - The offset into the buffer

length - The number of bytes to be sent

Throws:

java.lang.Exception

send

public void send(A dest,
                 java.nio.ByteBuffer data)
          throws java.lang.Exception

Description copied from interface: Server

Sends a message to a destination

Specified by:

send in interface Server<A extends Address>

Parameters:

dest - The destination address. Must not be null

data - The buffer to be sent

Throws:

java.lang.Exception

createConnection

protected abstract C createConnection(A dest)
                               throws java.lang.Exception

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

Throws:

java.lang.Exception

hasConnection

public boolean hasConnection(A address)

connectionEstablishedTo

public boolean connectionEstablishedTo(A address)

getConnection

public C getConnection(A dest)
                throws java.lang.Exception

Creates a new connection to dest, or returns an existing one

Throws:

java.lang.Exception

replaceConnection

public void replaceConnection(A address,
                              C conn)

addConnection

public void addConnection(A peer_addr,
                          C conn)
                   throws java.lang.Exception

Throws:

java.lang.Exception

addConnectionListener

public void addConnectionListener(BaseServer.ConnectionListener<A,C> cml)

removeConnectionListener

public void removeConnectionListener(BaseServer.ConnectionListener<A,C> cml)

getNumConnections

public int getNumConnections()

getNumOpenConnections

public int getNumOpenConnections()

printConnections

public java.lang.String printConnections()

removeConnectionIfPresent

public void removeConnectionIfPresent(A address,
                                      C conn)

Only removes the connection if conns.get(address) == conn

retainAll

public void retainAll(java.util.Collection<A> current_mbrs)

Removes all connections which are not in current_mbrs

notifyConnectionClosed

public void notifyConnectionClosed(A address)

notifyConnectionOpened

public void notifyConnectionOpened(A address,
                                   C conn)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validateArgs

protected <T> boolean validateArgs(A dest,
                                   T buffer)

explanation

protected static java.lang.String explanation(boolean connection_existed,
                                              boolean replace)