| org.mortbay.io.EndPoint
All known Subclasses: org.mortbay.io.nio.ChannelEndPoint, org.mortbay.io.ByteArrayEndPoint, org.mortbay.io.bio.StreamEndPoint,
| EndPoint | | public interface EndPoint (Code) | |
author:
gregw
author:
A transport EndPoint |
| close | | void close() throws IOException(Code) | | Close any backing stream associated with the buffer
|
| fill | | int fill(Buffer buffer) throws IOException(Code) | | Fill the buffer from the current putIndex to it's capacity from whatever
byte source is backing the buffer. The putIndex is increased if bytes filled.
The buffer may chose to do a compact before filling.
an int value indicating the number of bytes filled or -1 if EOF is reached. |
| flush | | int flush(Buffer buffer) throws IOException(Code) | | Flush the buffer from the current getIndex to it's putIndex using whatever byte
sink is backing the buffer. The getIndex is updated with the number of bytes flushed.
Any mark set is cleared.
If the entire contents of the buffer are flushed, then an implicit empty() is done.
Parameters:
buffer - The buffer to flush. This buffers getIndex is updated. the number of bytes written |
| flush | | int flush(Buffer header, Buffer buffer, Buffer trailer) throws IOException(Code) | | Flush the buffer from the current getIndex to it's putIndex using whatever byte
sink is backing the buffer. The getIndex is updated with the number of bytes flushed.
Any mark set is cleared.
If the entire contents of the buffer are flushed, then an implicit empty() is done.
The passed header/trailer buffers are written before/after the contents of this buffer. This may be done
either as gather writes, as a poke into this buffer or as several writes. The implementation is free to
select the optimal mechanism.
Parameters:
header - A buffer to write before flushing this buffer. This buffers getIndex is updated.
Parameters:
buffer - The buffer to flush. This buffers getIndex is updated.
Parameters:
trailer - A buffer to write after flushing this buffer. This buffers getIndex is updated. the total number of bytes written. |
| flush | | public void flush() throws IOException(Code) | | Flush any buffered output.
May fail to write all data if endpoint is non-blocking
throws:
IOException - |
| getLocalAddr | | public String getLocalAddr()(Code) | | The local IP address to which this EndPoint is bound, or nullif this EndPoint does not represent a network connection. |
| getLocalHost | | public String getLocalHost()(Code) | | The local host name to which this EndPoint is bound, or nullif this EndPoint does not represent a network connection. |
| getLocalPort | | public int getLocalPort()(Code) | | The local port number on which this EndPoint is listening, or 0if this EndPoint does not represent a network connection. |
| getRemoteAddr | | public String getRemoteAddr()(Code) | | The remote IP address to which this EndPoint is connected, or nullif this EndPoint does not represent a network connection. |
| getRemoteHost | | public String getRemoteHost()(Code) | | The host name of the remote machine to which this EndPoint is connected, or nullif this EndPoint does not represent a network connection. |
| getRemotePort | | public int getRemotePort()(Code) | | The remote port number to which this EndPoint is connected, or 0if this EndPoint does not represent a network connection. |
| getTransport | | public Object getTransport()(Code) | | The underlying transport object (socket, channel, etc.) |
| isBlocking | | public boolean isBlocking()(Code) | | |
| isBufferingInput | | public boolean isBufferingInput()(Code) | | True if the endpoint has some buffered input data |
| isBufferingOutput | | public boolean isBufferingOutput()(Code) | | True if the endpoint has some buffered output data |
| isBufferred | | public boolean isBufferred()(Code) | | |
| isOpen | | public boolean isOpen()(Code) | | |
|
|