rsb.transport.spread

Class SpreadWrapperImpl

java.lang.Object

rsb.AbstractActivatable

rsb.transport.spread.SpreadWrapperImpl

All Implemented Interfaces:

Closeable, AutoCloseable, Activatable, SpreadWrapper

public class SpreadWrapperImpl
extends AbstractActivatable
implements SpreadWrapper

This class encapsulates and manages a connection to the spread daemon. Thereby, it maintains the membership information for this connection and evaluates and enqueues all sorts of spread messages.

Author:

swrede

Nested Class Summary

Nested classes/interfaces inherited from interface rsb.transport.spread.SpreadWrapper

SpreadWrapper.ConnectionState

Nested classes/interfaces inherited from interface rsb.Activatable

Activatable.State

Constructor Summary

Constructors

Constructor and Description
SpreadWrapperImpl(SpreadOptions options) Creates a new instance for the given settings.

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.
String	getPrivateGroup() Returns the name of the private spread group for the wrapped connection.
InetAddress	getSpreadhost()
SpreadWrapper.ConnectionState	getStatus() Indicates the current state of the underlying connection.
URI	getTransportUri() Returns the transport URI for this spread connection.
boolean	isActive() Tells whether this class is currently active or not.
boolean	isConnected() Indicate whether this wrapper is currently successfully connected to a spread daemon.
boolean	isShutdown() Indicate whether a shutdown was requested.
boolean	isUseTcpNoDelay()
void	join(String group) If connected, joins the specified group.
void	leave(String group) If connected and joined, leaves the specified group.
spread.SpreadMessage	receive() Receive the next message from the spread connection in groups this wrapper has joined.
void	send(DataMessage msg) Sends the given message.

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

SpreadWrapperImpl

public SpreadWrapperImpl(SpreadOptions options)
                  throws UnknownHostException

Creates a new instance for the given settings. Connection will be established during activate().

Parameters:

options - the options to use for the connection

Throws:

UnknownHostException - host name cannot be resolved

Method Detail

getStatus

public SpreadWrapper.ConnectionState getStatus()

Description copied from interface: SpreadWrapper

Indicates the current state of the underlying connection.

Specified by:

getStatus in interface SpreadWrapper

Returns:

the status

getSpreadhost

public InetAddress getSpreadhost()

Specified by:

getSpreadhost in interface SpreadWrapper

Returns:

the spreadhost

isUseTcpNoDelay

public boolean isUseTcpNoDelay()

Specified by:

isUseTcpNoDelay in interface SpreadWrapper

Returns:

the useTcpNoDelay

join

public void join(String group)
          throws spread.SpreadException

Description copied from interface: SpreadWrapper

If connected, joins the specified group. Otherwise, call is ignored. Calling this method does not wait until messages can effectively be received. You have to wait for a membership message containing your private group to be sure that this is the case.

Specified by:

join in interface SpreadWrapper

Parameters:

group - group to join

Throws:

spread.SpreadException - error joining

send

public void send(DataMessage msg)

Description copied from interface: SpreadWrapper

Sends the given message.

Specified by:

send in interface SpreadWrapper

Parameters:

msg - the message to send

deactivate

public void deactivate()
                throws RSBException

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

leave

public void leave(String group)

Description copied from interface: SpreadWrapper

If connected and joined, leaves the specified group.

Specified by:

leave in interface SpreadWrapper

Parameters:

group - the group to leave

activate

public void activate()
              throws InitializeException

Description copied from interface: Activatable

Activates all resources that belong to a specific object.

Specified by:

activate in interface Activatable

Throws:

InitializeException

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

getPrivateGroup

public String getPrivateGroup()

Description copied from interface: SpreadWrapper

Returns the name of the private spread group for the wrapped connection.

Specified by:

getPrivateGroup in interface SpreadWrapper

Returns:

name of the group or null if not connected so far.

isConnected

public boolean isConnected()

Description copied from interface: SpreadWrapper

Indicate whether this wrapper is currently successfully connected to a spread daemon.

Specified by:

isConnected in interface SpreadWrapper

Returns:

true if connected, else false

receive

public spread.SpreadMessage receive()
                             throws InterruptedIOException,
                                    spread.SpreadException

Description copied from interface: SpreadWrapper

Receive the next message from the spread connection in groups this wrapper has joined. Blocks if no message is available.

Specified by:

receive in interface SpreadWrapper

Returns:

the next message

Throws:

InterruptedIOException - interrupted while waiting for the message

spread.SpreadException - error while reading the next message

isShutdown

public boolean isShutdown()

Description copied from interface: SpreadWrapper

Indicate whether a shutdown was requested.

Specified by:

isShutdown in interface SpreadWrapper

Returns:

true if requested.

getTransportUri

public URI getTransportUri()

Description copied from interface: SpreadWrapper

Returns the transport URI for this spread connection.

Specified by:

getTransportUri in interface SpreadWrapper

Returns:

URI representing this connection