rsb.transport.spread

Class SpreadOutConnector

java.lang.Object

rsb.AbstractActivatable

rsb.transport.AbstractConnector

rsb.transport.spread.SpreadOutConnector

All Implemented Interfaces:

Closeable, AutoCloseable, Activatable, Connector, OutConnector

public class SpreadOutConnector
extends AbstractConnector
implements OutConnector

An OutConnector for the spread daemon network.

Author:

jwienke, swrede

Nested Class Summary

Nested classes/interfaces inherited from interface rsb.Activatable

Activatable.State

Constructor Summary

Constructors

Constructor and Description
SpreadOutConnector(SpreadWrapper spread, ConverterSelectionStrategy<ByteBuffer> outStrategy, QualityOfServiceSpec qos) Constructs a new SpreadOutConnector.

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.
URI	getTransportUri() Return the URI describing this connector.
boolean	isActive() Tells whether this class is currently active or not.
void	push(Event event) Synchronously sends and event over the transport.
void	setQualityOfServiceSpec(QualityOfServiceSpec qos) 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 java.io.Closeable

close

Constructor Detail

SpreadOutConnector

public SpreadOutConnector(SpreadWrapper spread,
                  ConverterSelectionStrategy<ByteBuffer> outStrategy,
                  QualityOfServiceSpec qos)

Constructs a new SpreadOutConnector.

Parameters:

spread - encapsulation of spread communication. Must not be activated.

outStrategy - converters to use for sending data

qos - quality of service requirements to address

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

push

public void push(Event event)
          throws RSBException

Description copied from interface: OutConnector

Synchronously sends and event over the transport.

Specified by:

push in interface OutConnector

Parameters:

event - the event to send

Throws:

RSBException - error while sending

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

setQualityOfServiceSpec

public void setQualityOfServiceSpec(QualityOfServiceSpec qos)

Description copied from interface: Connector

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

Specified by:

setQualityOfServiceSpec in interface Connector

Parameters:

qos - new spec to apply

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

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.

Specified by:

setScope in interface Connector

Parameters:

scope - the scope

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