rsb.transport.socket

Class BusConnectionBase

java.lang.Object

rsb.transport.socket.BusConnectionBase

All Implemented Interfaces:

Activatable, BusConnection

Direct Known Subclasses:

BusClientConnection, BusServerConnection

public abstract class BusConnectionBase
extends Object
implements BusConnection

Utility base class for the implementation of the BusConnection interface. Subclasses need to use this object for synchronization. Subclasses need to call setSocket(Socket) with a valid socket before activate() will be called. activate() will automatically call handshake().

Author:

jwienke

Nested Class Summary

Nested classes/interfaces inherited from interface rsb.Activatable

Activatable.State

Constructor Summary

Constructors

Constructor and Description
BusConnectionBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates all resources that belong to a specific object.
void	deactivate() Deactivate all resources that are owned by a specific object in order to correctly tear down.
SocketOptions	getOptions() Returns the current configuration of the connection.
protected ReadableByteChannel	getReader() Returns the reader for the internal socket.
Socket	getSocket() Returns the contained socket instance.
protected WritableByteChannel	getWriter() Returns the writer for the internal socket.
protected abstract void	handshake() Performs the handshake step of the protocol.
boolean	isActive() Tells whether this class is currently active or not.
boolean	isActiveShutdown() Indicates whether the connection is currently performing an active shutdown as a consequence of calling BusConnection.shutdown().
protected int	readLength() Extract length of next notification blob.
NotificationType.Notification	readNotification() Reads a notification from the connection.
void	sendNotification(NotificationType.Notification notification) Sends a notification over the connection.
protected void	setOptions(SocketOptions options) Sets the options for the socket to hold in this instance.
protected void	setSocket(Socket socket) Sets the internal socket instance.
void	shutdown() This method starts and orderly shutdown of the connection.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusConnectionBase

public BusConnectionBase()

Method Detail

handshake

protected abstract void handshake()
                           throws RSBException

Performs the handshake step of the protocol.

Throws:

RSBException - error during handshake

getSocket

public Socket getSocket()

Returns the contained socket instance.

Returns:

socket instance or null if not set yet.

setSocket

protected void setSocket(Socket socket)

Sets the internal socket instance.

Parameters:

socket - new socket instance

setOptions

protected void setOptions(SocketOptions options)

Sets the options for the socket to hold in this instance.

Parameters:

options - socket options to hold

getOptions

public SocketOptions getOptions()

Description copied from interface: BusConnection

Returns the current configuration of the connection.

Specified by:

getOptions in interface BusConnection

Returns:

configuration of the connection

getReader

protected ReadableByteChannel getReader()

Returns the reader for the internal socket.

Returns:

reader instance or null if called before activate()

getWriter

protected WritableByteChannel getWriter()

Returns the writer for the internal socket.

Returns:

writer instance or null if called before activate()

activate

public void activate()
              throws RSBException

Description copied from interface: Activatable

Activates all resources that belong to a specific object.

Specified by:

activate in interface Activatable

Throws:

RSBException - generic error related to RSB

shutdown

public void shutdown()
              throws IOException

Description copied from interface: BusConnection

This method starts and orderly shutdown of the connection. It needs to be called before Activatable.deactivate() for this procedure to succeed. Should be callable multiple times without raising an error. Calls after the first are usually ignored.

Specified by:

shutdown in interface BusConnection

Throws:

IOException - error indicating the shutdown due to socket writing problems

isActiveShutdown

public boolean isActiveShutdown()

Description copied from interface: BusConnection

Indicates whether the connection is currently performing an active shutdown as a consequence of calling BusConnection.shutdown().

Specified by:

isActiveShutdown in interface BusConnection

Returns:

true in case of active shutdown, else false

deactivate

public void deactivate()
                throws RSBException,
                       InterruptedException

Description copied from interface: Activatable

Deactivate all resources that are owned by a specific object in order to correctly tear down. The method should only return once the object is completely deactivated including possible background threads.

Specified by:

deactivate in interface Activatable

Throws:

RSBException - generic error related to RSB

InterruptedException - interrupted while waiting for proper deactivation. Object might be in an undefined state now

isActive

public boolean isActive()

Description copied from interface: Activatable

Tells whether this class is currently active or not.

Specified by:

isActive in interface Activatable

Returns:

true if active

readLength

protected int readLength()
                  throws IOException

Extract length of next notification blob.

Returns:

Number of bytes

Throws:

IOException - error while reading from the socket

readNotification

public NotificationType.Notification readNotification()
                                               throws IOException

Description copied from interface: BusConnection

Reads a notification from the connection. Blocks if necessary.

Specified by:

readNotification in interface BusConnection

Returns:

the read notification

Throws:

IOException - communication error

sendNotification

public void sendNotification(NotificationType.Notification notification)
                      throws IOException

Description copied from interface: BusConnection

Sends a notification over the connection.

Specified by:

sendNotification in interface BusConnection

Parameters:

notification - the notification to send. Must be complete so that it can be serialized.

Throws:

IOException - error sending the notification