rsb.transport.socket

Class BusServer

java.lang.Object

rsb.AbstractActivatable

rsb.transport.socket.BusBase

rsb.transport.socket.BusServer

All Implemented Interfaces:

Closeable, AutoCloseable, Activatable, Bus

public class BusServer
extends BusBase

Instances of this class provide access to a socket-based bus for remote bus clients. Remote clients connect to a server socket in order to send and receive events through the resulting socket connection (maintained in BusConnection objects). Local clients (connectors) use the usual Bus interface to receive events published by remote clients and submit events which will be distributed to remote clients by the BusServer through the list of active BusConnection instances.

Author:

swrede, jwienke

Nested Class Summary

Nested classes/interfaces inherited from class rsb.transport.socket.BusBase

BusBase.ReceiveThread

Nested classes/interfaces inherited from interface rsb.transport.socket.Bus

Bus.NotificationReceiver

Nested classes/interfaces inherited from interface rsb.Activatable

Activatable.State

Constructor Summary

Constructors

Constructor and Description
BusServer(SocketOptions options) Constructor.

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.
void	handleIncoming(NotificationType.Notification notification, BusConnection sourceConnection) Implement this method to specify the behavior in case of an incoming notification received from a connection.
boolean	isActive() Tells whether this class is currently active or not.

Methods inherited from class rsb.transport.socket.BusBase

addConnection, addNotificationReceiver, getSocketOptions, getTransportUri, handleGlobally, handleGlobally, handleIncoming, handleLocally, handleOutgoing, numberOfConnections, removeConnection, removeNotificationReceiver

Methods inherited from class rsb.AbstractActivatable

close

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

BusServer

public BusServer(SocketOptions options)

Constructor.

Parameters:

options - socket options to use for the communication

Method Detail

activate

public void activate()
              throws RSBException

Description copied from interface: Activatable

Activates all resources that belong to a specific object.

Throws:

RSBException - generic error related to RSB

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

Overrides:

deactivate in class BusBase

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.

Returns:

true if active

handleIncoming

public void handleIncoming(NotificationType.Notification notification,
                  BusConnection sourceConnection)
                    throws RSBException

Description copied from class: BusBase

Implement this method to specify the behavior in case of an incoming notification received from a connection. Implementations can use the utility methods BusBase.handleLocally(rsb.protocol.NotificationType.Notification) and BusBase.handleGlobally(rsb.protocol.NotificationType.Notification) to implement their processing logic.

Specified by:

handleIncoming in class BusBase

Parameters:

notification - the received connection

sourceConnection - the source BusConnection providing this Notification

Throws:

RSBException - processing error