rsb.transport.spread

Interface SpreadWrapper

All Superinterfaces:

Activatable

All Known Implementing Classes:

RefCountingSpreadWrapper, SpreadWrapperImpl

public interface SpreadWrapper
extends Activatable

Interface for classes that encapsulate and manages a connection to the spread daemon. Such implementations maintain the membership information for this connection and evaluate and enqueue all sorts of spread messages.

Author:

jwienke

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SpreadWrapper.State Describes the current state of the underlying connection.

Method Summary

Methods

Modifier and Type	Method and Description
String	getPrivateGroup() Returns the name of the private spread group for the wrapped connection.
InetAddress	getSpreadhost()
SpreadWrapper.State	getStatus() Indicates the current state of the underlying connection.
URI	getTransportUri() Returns the transport URI for this spread connection.
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 interface rsb.Activatable

activate, deactivate, isActive

Method Detail

getStatus

SpreadWrapper.State getStatus()

Indicates the current state of the underlying connection.

Returns:

the status

getSpreadhost

InetAddress getSpreadhost()

Returns:

the spreadhost

isUseTcpNoDelay

boolean isUseTcpNoDelay()

Returns:

the useTcpNoDelay

join

void join(String group)
          throws spread.SpreadException

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.

Parameters:

group - group to join

Throws:

spread.SpreadException - error joining

send

void send(DataMessage msg)

Sends the given message.

Parameters:

msg - the message to send

Throws:

SendException - error sending the message

leave

void leave(String group)

If connected and joined, leaves the specified group.

Parameters:

group - the group to leave

getPrivateGroup

String getPrivateGroup()

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

Returns:

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

isConnected

boolean isConnected()

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

Returns:

true if connected, else false

receive

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

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

Returns:

the next message

Throws:

InterruptedIOException - interrupted while waiting for the message

spread.SpreadException - error while reading the next message

isShutdown

boolean isShutdown()

Indicate whether a shutdown was requested.

Returns:

true if requested.

getTransportUri

URI getTransportUri()

Returns the transport URI for this spread connection.

Returns:

URI representing this connection