rsb.transport.inprocess

Class InPushConnector

java.lang.Object

rsb.AbstractActivatable

rsb.transport.AbstractConnector

rsb.transport.inprocess.InPushConnector

All Implemented Interfaces:

Closeable, AutoCloseable, Activatable, FilterObserver, Connector, EventHandler, InConnector, InPushConnector

public class InPushConnector
extends AbstractConnector
implements InPushConnector, EventHandler

Implements a push-based connector for receiving events via the inprocess transport.

Author:

jwienke

Nested Class Summary

Nested classes/interfaces inherited from interface rsb.Activatable

Activatable.State

Constructor Summary

Constructors

Constructor and Description
InPushConnector(Bus bus) Creates a new push based connector for receiving events from a given Bus instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates all resources that belong to a specific object.
void	addHandler(EventHandler handler) Adds a handler which will be notified about newly received events.
void	deactivate() Deactivate all resources that are owned by a specific object in order to correctly tear down.
protected Bus	getBus()
protected Scope	getScope() Returns the scope of this connector.
URI	getTransportUri() Return the URI describing this connector.
void	handle(Event event) The callback method.
boolean	isActive() Tells whether this class is currently active or not.
void	notify(Filter filter, FilterAction action) Called in case a Filter was changed.
boolean	removeHandler(EventHandler handler) Removes a registered handler so that it won't be notified anymore.
void	setQualityOfServiceSpec(QualityOfServiceSpec spec) Sets the quality of service requirements on sending and receiving event notifications.
void	setScope(Scope scope) Sets the scope this connector is working on.

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 rsb.transport.Connector

setQualityOfServiceSpec, setScope

Methods inherited from interface rsb.Activatable

deactivate, isActive

Methods inherited from interface java.io.Closeable

close

Constructor Detail

InPushConnector

public InPushConnector(Bus bus)

Creates a new push based connector for receiving events from a given Bus instance.

Parameters:

bus - the bus to receive from

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

addHandler

public void addHandler(EventHandler handler)

Description copied from interface: InPushConnector

Adds a handler which will be notified about newly received events. This method must not be called after calling Activatable.activate().

Specified by:

addHandler in interface InPushConnector

Parameters:

handler - the handler to notify

removeHandler

public boolean removeHandler(EventHandler handler)

Description copied from interface: InPushConnector

Removes a registered handler so that it won't be notified anymore. This method must not be called after calling Activatable.deactivate().

Specified by:

removeHandler in interface InPushConnector

Parameters:

handler - the handler to remove

Returns:

true if the given handler was removed, else false, i.e. in case that handler was never registered.

handle

public void handle(Event event)

Description copied from interface: EventHandler

The callback method.

Specified by:

handle in interface EventHandler

Parameters:

event - the event to handle

notify

public void notify(Filter filter,
          FilterAction action)

Description copied from interface: FilterObserver

Called in case a Filter was changed.

Specified by:

notify in interface FilterObserver

Parameters:

filter - the Filter that changes, not null

action - the action that was performed with this filter, not null

getTransportUri

public URI getTransportUri()

Description copied from interface: Connector

Return the URI describing this connector. Only valid if activated.

Specified by:

getTransportUri in interface Connector

Returns:

URI, not null

getBus

protected Bus getBus()

getScope

protected Scope getScope()

Returns the scope of this connector.

Returns:

scope or null if not yet set

setQualityOfServiceSpec

public void setQualityOfServiceSpec(QualityOfServiceSpec spec)

Description copied from interface: Connector

Sets the quality of service requirements on sending and receiving event notifications.

Parameters:

spec - new spec to apply

setScope

public void setScope(Scope scope)

Description copied from interface: Connector

Sets the scope this connector is working on. Needs to be called before the Activatable.activate() method of the connector is called.

Parameters:

scope - the scope

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.

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