com.caucho.bam.client
Class OutboundMessageStream

java.lang.Object
  extended by com.caucho.bam.client.OutboundMessageStream
All Implemented Interfaces:
MessageStream

public class OutboundMessageStream
extends java.lang.Object
implements MessageStream

HMTP client protocol


Constructor Summary
OutboundMessageStream(LinkConnectionFactory linkFactory, Broker inboundBroker)
           
 
Method Summary
 java.lang.String getAddress()
          Returns the address of the ActorHolder at the end of the stream.
 Broker getBroker()
          Returns the owning broker
 boolean isClosed()
          Tests if the stream is closed.
 void message(java.lang.String to, java.lang.String from, java.io.Serializable payload)
          Sends a unidirectional message to an ActorHolder, addressed by the Actor's address.
 void messageError(java.lang.String to, java.lang.String from, java.io.Serializable payload, BamError error)
          Sends a message error to an ActorHolder, addressed by the Actor's address.
 void query(long id, java.lang.String to, java.lang.String from, java.io.Serializable payload)
          Sends a query/RPCinformation call The receiver of a query acts as a service and the caller acts as a client.
 void queryError(long id, java.lang.String to, java.lang.String from, java.io.Serializable payload, BamError error)
          Sends a query error from a failed query.
 void queryResult(long id, java.lang.String to, java.lang.String from, java.io.Serializable payload)
          Sends a query response for a query
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OutboundMessageStream

public OutboundMessageStream(LinkConnectionFactory linkFactory,
                             Broker inboundBroker)
Method Detail

getAddress

public java.lang.String getAddress()
Description copied from interface: MessageStream
Returns the address of the ActorHolder at the end of the stream.

Specified by:
getAddress in interface MessageStream

getBroker

public Broker getBroker()
Description copied from interface: MessageStream
Returns the owning broker

Specified by:
getBroker in interface MessageStream

isClosed

public boolean isClosed()
Description copied from interface: MessageStream
Tests if the stream is closed.

Specified by:
isClosed in interface MessageStream

message

public void message(java.lang.String to,
                    java.lang.String from,
                    java.io.Serializable payload)
Description copied from interface: MessageStream
Sends a unidirectional message to an ActorHolder, addressed by the Actor's address.

Specified by:
message in interface MessageStream
Parameters:
to - the target actor's address
from - the source actor's address
payload - the message payload

messageError

public void messageError(java.lang.String to,
                         java.lang.String from,
                         java.io.Serializable payload,
                         BamError error)
Description copied from interface: MessageStream
Sends a message error to an ActorHolder, addressed by the Actor's address. Actor protocols may choose to send error messages if a message fails for some reason. In general, Actors should not rely on the delivery of error messages. If an error return is required, use an RPC query instead.

Specified by:
messageError in interface MessageStream
Parameters:
to - the target actor's address
from - the source actor's address
payload - the message payload
error - the message error

query

public void query(long id,
                  java.lang.String to,
                  java.lang.String from,
                  java.io.Serializable payload)
Description copied from interface: MessageStream
Sends a query/RPCinformation call The receiver of a query acts as a service and the caller acts as a client. Because BAM Actors are symmetrical, all Actors can act as services and clients for different RPC calls. The stream MUST send a queryResult or queryError to the client using the same id, because RPC clients rely on a response.

Specified by:
query in interface MessageStream
Parameters:
id - the query identifier used to match requests with responses
to - the service actor's address
from - the client actor's address
payload - the query payload

queryResult

public void queryResult(long id,
                        java.lang.String to,
                        java.lang.String from,
                        java.io.Serializable payload)
Description copied from interface: MessageStream
Sends a query response for a query

Specified by:
queryResult in interface MessageStream
Parameters:
id - the query identifier used to match requests with responses
to - the client actor's address
from - the service actor's address
payload - the result payload

queryError

public void queryError(long id,
                       java.lang.String to,
                       java.lang.String from,
                       java.io.Serializable payload,
                       BamError error)
Description copied from interface: MessageStream
Sends a query error from a failed query.

Specified by:
queryError in interface MessageStream
Parameters:
id - the query identifier used to match requests with responses
to - the client actor's address
from - the service actor's address
payload - the query payload
error - additional error information

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object