p2ps.pipe
Interface OutputPipe

All Known Subinterfaces:
BidirectionalPipe
All Known Implementing Classes:
BidirectionalPipeImp, OutputPipeImp, ReplyPipe

public interface OutputPipe

An interface to an input pipe.

Version:
$Revision: 295 $
Author:
Ian Wang

Method Summary
 void close()
          Closes the pipe
 Endpoint[] getEndpoints()
           
 java.lang.String getPipeID()
           
 java.lang.String getPipeName()
           
 java.net.URI getSendURI()
           
 boolean isClosed()
           
 java.lang.String send(byte[] message)
          Sends a message from the pipe.
 

Method Detail

getPipeID

public java.lang.String getPipeID()
Returns:
the id of the pipe

getPipeName

public java.lang.String getPipeName()
Returns:
the name of the pipe

getEndpoints

public Endpoint[] getEndpoints()
Returns:
the endpoints for the pipe

getSendURI

public java.net.URI getSendURI()
Returns:
the uri sent to by this pipe (null if unknown)

send

public java.lang.String send(byte[] message)
                      throws java.io.IOException
Sends a message from the pipe. For bidirectional pipes the send id returned can be used to match replies with the original send.

Returns:
the send id for the message (possibly null).
Throws:
java.io.IOException

close

public void close()
           throws java.io.IOException
Closes the pipe

Throws:
java.io.IOException

isClosed

public boolean isClosed()
Returns:
true if the pipe is closed