rsb.transport.socket

Class SocketConnectorUtility

java.lang.Object

rsb.transport.socket.SocketConnectorUtility

public class SocketConnectorUtility
extends Object

A class providing base functionality for Connector implementations of the socket transport. It is intended to be used via composition. Provided methods are generally thread-safe if not indicated otherwise. The respective instance of this class is used for synchronizing in case clients of this class need to extend synchronized blocks or interact with the synchronization strategies of this class.

Author:

jwienke

Constructor Summary

Constructors

Constructor and Description
SocketConnectorUtility(SocketOptions socketOptions, ServerMode serverMode, ConverterSelectionStrategy<ByteBuffer> converters) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Acquires a new Bus instance and activates it respecting the requested ServerMode.
void	deactivate() Deactivates the underlying bus instance.
Bus	getBus() Returns the underlying bus instance when called after activate() .
ConverterSelectionStrategy<ByteBuffer>	getConverters() Returns the contained converters to use.
boolean	isActive() Indicates whether this class has been activated or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

SocketConnectorUtility

public SocketConnectorUtility(SocketOptions socketOptions,
                      ServerMode serverMode,
                      ConverterSelectionStrategy<ByteBuffer> converters)

Constructor.

Parameters:

socketOptions - socket options to use

serverMode - the kind of server mode to use

converters - the converters to use for serialization

Method Detail

getBus

public Bus getBus()

Returns the underlying bus instance when called after activate() .

Returns:

bus instance or null

getConverters

public ConverterSelectionStrategy<ByteBuffer> getConverters()

Returns the contained converters to use.

Returns:

converters

activate

public void activate()
              throws RSBException

Acquires a new Bus instance and activates it respecting the requested ServerMode.

Throws:

RSBException - error initializing Bus

deactivate

public void deactivate()
                throws RSBException,
                       InterruptedException

Deactivates the underlying bus instance.

Throws:

RSBException - error deactivating Bus

InterruptedException - interrupted while waiting for the bus to terminate

isActive

public boolean isActive()

Indicates whether this class has been activated or not.

Returns:

true if activated