|
Project JXTA | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
OuputPipe defines the interface for sending messages from a
PipeService
.
OutputPipe
from the PipeService
.
PipeService
,
InputPipe
,
Message
,
PipeAdvertisement
Method Summary | |
void |
close()
close the pipe |
PipeAdvertisement |
getAdvertisement()
Gets the pipe advertisement |
String |
getName()
Gets the pipe name |
ID |
getPipeID()
Gets the pipe id |
String |
getType()
Gets the pipe type |
boolean |
isClosed()
Returns true if this pipe is closed and no longer
accepting messages to be sent. |
boolean |
send(Message msg)
Send a message throught the pipe WARNING: The message object used when sending a pipe message should not be reused or modified after the send(Message) call is
made. |
Method Detail |
public boolean send(Message msg) throws IOException
send(Message)
call is
made. Concurrent modification of messages will produce unexpected result.
msg
- is the PipeMessage to be sent.
true
if the message has been sent otherwise
false
. false
. is commonly returned for
non-error related congestion, meaning that you should be able to send
the message after waiting some amount of time.
IOException
- output pipe errorpublic void close()
public boolean isClosed()
true
if this pipe is closed and no longer
accepting messages to be sent. The pipe should be discarded.
true
if this pipe is closed, otherwise
false
.public String getType()
public ID getPipeID()
public String getName()
public PipeAdvertisement getAdvertisement()
|
JXTA J2SE | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |