|
Rice Pastry API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object rice.pastry.socket.SocketChannelWriter
public class SocketChannelWriter
Class which serves as an "writer" for all of the messages sent across the wire in Pastry. This class serializes and properly formats all messages, and then waits to be called with an available SocketChannel in order to write the message out. If the messagae could not be written in one go, subsequent calls to the write() method will finish writing out the message. This class also maintains an internal queue of messages waiting to be sent across the wire. Calling isEmpty() will tell clients if it is safe to mark the SelectionKey as not being interested in writing.
Field Summary | |
---|---|
protected Environment |
environment
|
protected Logger |
logger
|
protected SourceRoute |
path
|
Constructor Summary | |
---|---|
SocketChannelWriter(Environment env,
SourceRoute path)
|
|
SocketChannelWriter(SocketPastryNode spn,
SourceRoute path)
Constructor which creates this SocketChannelWriter with a pastry node and an object to write out. |
Method Summary | |
---|---|
boolean |
enqueue(byte[] msg)
|
boolean |
enqueue(Message msg)
|
boolean |
enqueue(SocketBuffer o)
Adds an object to this SocketChannelWriter's queue of pending objects to write. |
java.util.LinkedList |
getQueue()
Returns the queue of writes for the remote address |
boolean |
isEmpty()
Returns whether or not there are objects in the queue on in writing. |
void |
reset()
Returns the queue of writes for the remote address |
protected void |
setPath(SourceRoute path)
Sets this writer's path |
boolean |
write(java.nio.channels.SocketChannel sc)
Method which is designed to be called when this writer should write out its data. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected SourceRoute path
protected Environment environment
protected Logger logger
Constructor Detail |
---|
public SocketChannelWriter(SocketPastryNode spn, SourceRoute path)
spn
- The spn the SocketChannelWriter serverspublic SocketChannelWriter(Environment env, SourceRoute path)
Method Detail |
---|
protected void setPath(SourceRoute path)
path
- The path this writer is usingpublic boolean isEmpty()
public java.util.LinkedList getQueue()
public boolean enqueue(Message msg) throws java.io.IOException
java.io.IOException
public boolean enqueue(byte[] msg)
public boolean enqueue(SocketBuffer o)
o
- The object to be written.
public void reset()
public boolean write(java.nio.channels.SocketChannel sc) throws java.io.IOException
sc
- The SocketChannel to write to
java.io.IOException
- DESCRIBE THE EXCEPTION
|
Rice Pastry API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |