rsb.transport.socket

Class RefCountingBus

java.lang.Object

rsb.transport.socket.RefCountingBus

All Implemented Interfaces:

Activatable, Bus

public class RefCountingBus
extends Object
implements Bus

A reference counting decorator for Bus instances. The wrapped instance is activated only to the first call to activate() and deactivated only when as many deactivate() calls are received as have been activate calls received.

Author:

jwienke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RefCountingBus.DeactivationHandler A handler that will be called once the underlying bus will really be deactivated.

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
RefCountingBus(Bus bus, RefCountingBus.DeactivationHandler handler) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates all resources that belong to a specific object.
void	addNotificationReceiver(Bus.NotificationReceiver receiver) Registers a local observer for notifications.
void	deactivate() Deactivate all resources that are owned by a specific object in order to correctly tear down.
Bus	getContainedBus() Returns the underlying bus that is handled with reference counting.
SocketOptions	getSocketOptions() Returns the current socket configuration of the bus.
URI	getTransportUri() Return the URI describing the transport manifested by this bus.
void	handleOutgoing(NotificationType.Notification notification) Handles a notification to be sent over the bus.
boolean	isActive() Tells whether this class is currently active or not.
void	removeNotificationReceiver(Bus.NotificationReceiver receiver) Removes a local observer for notifications if registered before.

Methods inherited from class java.lang.Object

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

Constructor Detail

RefCountingBus

public RefCountingBus(Bus bus,
              RefCountingBus.DeactivationHandler handler)

Constructor.

Parameters:

bus - bus to manage

handler - handler to be called on deactivation of the bus

Method Detail

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

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

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

getSocketOptions

public SocketOptions getSocketOptions()

Description copied from interface: Bus

Returns the current socket configuration of the bus.

Specified by:

getSocketOptions in interface Bus

Returns:

socket options used

handleOutgoing

public void handleOutgoing(NotificationType.Notification notification)
                    throws RSBException

Description copied from interface: Bus

Handles a notification to be sent over the bus. The default implementation dispatches the notification to all local Bus.NotificationReceiver and to all registered BusConnection s.

Specified by:

handleOutgoing in interface Bus

Parameters:

notification - the notification to distribute

Throws:

RSBException - error during dispatching

addNotificationReceiver

public void addNotificationReceiver(Bus.NotificationReceiver receiver)

Description copied from interface: Bus

Registers a local observer for notifications.

Specified by:

addNotificationReceiver in interface Bus

Parameters:

receiver - the receiver to register

removeNotificationReceiver

public void removeNotificationReceiver(Bus.NotificationReceiver receiver)

Description copied from interface: Bus

Removes a local observer for notifications if registered before.

Specified by:

removeNotificationReceiver in interface Bus

Parameters:

receiver - the receiver to remove

getContainedBus

public Bus getContainedBus()

Returns the underlying bus that is handled with reference counting. Do not call Activatable.activate() or Activatable.deactivate() on this instance!

Returns:

the managed bus

getTransportUri

public URI getTransportUri()

Description copied from interface: Bus

Return the URI describing the transport manifested by this bus. Only valid if activated.

Specified by:

getTransportUri in interface Bus

Returns:

URI, not null