Public Instance Methods : IdSstConnection
canReach: target
"ACTION
Answer true if the receiver can be used to send messages to
the @target endpoint. That is, if the receiver is a connection
to @target.
PARAMETERS
target : <IuSstRemoteEndpoint>
RETURN VALUE
<Boolean>"
close
"ACTION
Shut down the receiver. Close the handle / stream. Ensure that all
subsequent operations will fail."
handle
"ACTION
Answer the low-level outgoing communictions media for the receiver.
RETURN VALUE
<Object>
NOTES
The form of the result is transport specific."
handle: value
"ACTION
Set the low-level outgoing communictions media for the receiver.
PARAMETERS
value : <Object>
NOTES
The form of @handle is transport specific."
isClosed
"ACTION
Answer true if the receiver has been closed.
RETURN VALUE
<Boolean>"
isStreaming
"ACTION
Answer true if the receiver is a streaming connection.
RETURN VALUE
<Boolean>"
makeAvailable
"ACTION
Make the receiver available for receives. Invoking this method
implies that all data for the previous message has been read
from the receiver."
negotiateAccept
"ACTION
Handle the protocol negotiation between two peers on a
connection. This method is called when connecting to another
machine. The %peer and %transport attributes will be prior to
this call. If successful then the receiver should be suitable for use in
sending data from %handle to %peer. Answer an error if the
negotiation fail.
RETURN VALUE
<void> | <IuSstError>"
negotiateConnect
"ACTION
Handle the protocol negotiation between two peers on a
connection. This method is run on the machine to which
someone is connecting. The %transport attribute will be set prior
to this call. If successful then the receiver should
have a known %peer value and be suitable for use in sending
data from %handle to %peer. Answer an error if the negotiation
failed.
RETURN VALUE
<void> | <IuSstError>"
peer
"ACTION
Answer the receiver's peer.
RETURN VALUE
<IuSstRemoteEndpoint>"
peer: value
"ACTION
Set the receiver's peer.
PARAMETERS
value : <IuSstEndpoint>"
receive
"ACTION
Retrieve a message from the receiver. Answer the result or an
error should one occur.
RETURN VALUE
<IuSstCommunicationMessage> | <IuSstError>"
reply: message
"ACTION
Send @message to the connection represented by the receiver as
a reply. Answer an error should one occur.
PARAMETERS
message : <IuSstCommunicationMessage>
RETURN VALUE
<void> | <IuSstError>"
send: message
"ACTION
Send @message to the connection represented by the receiver.
Answer an error should one occur.
PARAMETERS
message : <IuSstCommunicationMessage>
RETURN VALUE
<void> | <IuSstError>"
transport
"ACTION
Answer the transport of the receiver.
RETURN VALUE
<IdSstTransport>"
[FIRST] [PREV] [NEXT] [LAST]