public class ChannelEndPoint extends Object implements EndPoint
Holds the channel and socket for an NIO endpoint.
Modifier and Type | Field and Description |
---|---|
protected ByteChannel |
_channel |
protected ByteBuffer[] |
_gather2 |
protected InetSocketAddress |
_local |
protected int |
_maxIdleTime |
protected InetSocketAddress |
_remote |
protected Socket |
_socket |
Modifier | Constructor and Description |
---|---|
|
ChannelEndPoint(ByteChannel channel) |
protected |
ChannelEndPoint(ByteChannel channel,
int maxIdleTime) |
Modifier and Type | Method and Description |
---|---|
boolean |
blockReadable(long millisecs) |
boolean |
blockWritable(long millisecs) |
void |
close()
Close any backing stream associated with the endpoint
|
int |
fill(Buffer buffer)
Fill the buffer from the current putIndex to it's capacity from whatever
byte source is backing the buffer.
|
void |
flush()
Flush any buffered output.
|
int |
flush(Buffer buffer)
Flush the buffer from the current getIndex to it's putIndex using whatever byte
sink is backing the buffer.
|
int |
flush(Buffer header,
Buffer buffer,
Buffer trailer)
Flush the buffer from the current getIndex to it's putIndex using whatever byte
sink is backing the buffer.
|
protected int |
gatheringFlush(Buffer header,
ByteBuffer bbuf0,
Buffer buffer,
ByteBuffer bbuf1) |
ByteChannel |
getChannel() |
String |
getLocalAddr() |
String |
getLocalHost() |
int |
getLocalPort() |
int |
getMaxIdleTime()
Get the max idle time in ms.
|
String |
getRemoteAddr() |
String |
getRemoteHost() |
int |
getRemotePort() |
Object |
getTransport() |
boolean |
isBlocking() |
boolean |
isInputShutdown() |
boolean |
isOpen() |
boolean |
isOutputShutdown() |
void |
setMaxIdleTime(int timeMs)
Set the max idle time.
|
protected void |
shutdownChannelInput()
Shutdown the channel Input.
|
protected void |
shutdownChannelOutput() |
void |
shutdownInput()
Shutdown any backing input stream associated with the endpoint
|
void |
shutdownOutput()
Shutdown any backing output stream associated with the endpoint
|
protected final ByteChannel _channel
protected final ByteBuffer[] _gather2
protected final Socket _socket
protected final InetSocketAddress _local
protected final InetSocketAddress _remote
protected volatile int _maxIdleTime
public ChannelEndPoint(ByteChannel channel) throws IOException
IOException
protected ChannelEndPoint(ByteChannel channel, int maxIdleTime) throws IOException
IOException
public boolean isBlocking()
isBlocking
in interface EndPoint
public boolean blockReadable(long millisecs) throws IOException
blockReadable
in interface EndPoint
IOException
public boolean blockWritable(long millisecs) throws IOException
blockWritable
in interface EndPoint
IOException
protected final void shutdownChannelInput() throws IOException
shutdownInput()
IOException
public void shutdownInput() throws IOException
EndPoint
shutdownInput
in interface EndPoint
IOException
protected final void shutdownChannelOutput() throws IOException
IOException
public void shutdownOutput() throws IOException
EndPoint
shutdownOutput
in interface EndPoint
IOException
public boolean isOutputShutdown()
isOutputShutdown
in interface EndPoint
public boolean isInputShutdown()
isInputShutdown
in interface EndPoint
public void close() throws IOException
EndPoint
close
in interface EndPoint
IOException
public int fill(Buffer buffer) throws IOException
EndPoint
fill
in interface EndPoint
int
value indicating the number of bytes
filled or -1 if EOF is reached.EofException
- If input is shutdown or the endpoint is closed.IOException
public int flush(Buffer buffer) throws IOException
EndPoint
flush
in interface EndPoint
buffer
- The buffer to flush. This buffers getIndex is updated.EofException
- If the endpoint is closed or output is shutdown.IOException
public int flush(Buffer header, Buffer buffer, Buffer trailer) throws IOException
EndPoint
flush
in interface EndPoint
header
- A buffer to write before flushing this buffer. This buffers getIndex is updated.buffer
- The buffer to flush. This buffers getIndex is updated.trailer
- A buffer to write after flushing this buffer. This buffers getIndex is updated.IOException
protected int gatheringFlush(Buffer header, ByteBuffer bbuf0, Buffer buffer, ByteBuffer bbuf1) throws IOException
IOException
public ByteChannel getChannel()
public String getLocalAddr()
getLocalAddr
in interface EndPoint
EndPoint
is bound, or null
if this EndPoint
does not represent a network connection.public String getLocalHost()
getLocalHost
in interface EndPoint
EndPoint
is bound, or null
if this EndPoint
does not represent a network connection.public int getLocalPort()
getLocalPort
in interface EndPoint
EndPoint
is listening, or 0
if this EndPoint
does not represent a network connection.public String getRemoteAddr()
getRemoteAddr
in interface EndPoint
EndPoint
is connected, or null
if this EndPoint
does not represent a network connection.public String getRemoteHost()
getRemoteHost
in interface EndPoint
EndPoint
is connected, or null
if this EndPoint
does not represent a network connection.public int getRemotePort()
getRemotePort
in interface EndPoint
EndPoint
is connected, or 0
if this EndPoint
does not represent a network connection.public Object getTransport()
getTransport
in interface EndPoint
public void flush() throws IOException
EndPoint
flush
in interface EndPoint
EofException
- If the endpoint is closed or output is shutdown.IOException
public int getMaxIdleTime()
EndPoint
The max idle time is the time the endpoint can be idle before
extraordinary handling takes place. This loosely corresponds to
the Socket.getSoTimeout()
for blocking connections,
but AsyncEndPoint
implementations must use other mechanisms
to implement the max idle time.
getMaxIdleTime
in interface EndPoint
public void setMaxIdleTime(int timeMs) throws IOException
EndPoint
setMaxIdleTime
in interface EndPoint
timeMs
- the max idle time in MS. Timeout <= 0 implies an infinite timeoutIOException
- if the timeout cannot be set.StreamEndPoint.setMaxIdleTime(int)
Copyright © 1995-2013 Mort Bay Consulting. All Rights Reserved.