p2ps.pipe
Interface InputPipe

All Known Subinterfaces:

BidirectionalPipe

All Known Implementing Classes:

BidirectionalPipeImp, InputPipeImp

public interface InputPipe

An interface to an input pipe.

Version:

$Revision: 295 $

Author:

Ian Wang

Method Summary

void	addMessageListener(MessageListener listener) Adds a listener to be notified when messages are received
void	close() Closes the pipe
Endpoint[]	getEndpoints()
java.lang.String	getPipeID()
java.lang.String	getPipeName()
java.net.URI	getPipeURI()
boolean	isClosed()
void	removeMessageListener(MessageListener listener) Removes a listener from being notified when messages are received

Method Detail

addMessageListener

public void addMessageListener(MessageListener listener)

Adds a listener to be notified when messages are received

removeMessageListener

public void removeMessageListener(MessageListener listener)

Removes a listener from being notified when messages are received

getPipeURI

public java.net.URI getPipeURI()

Returns:

the uri of the pipe

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

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