ChannelEndPoint (Jetty :: Aggregate :: All core Jetty 7.6.7.v20120910.redhat-002 API)

java.lang.Object
- org.eclipse.jetty.io.nio.ChannelEndPoint

All Implemented Interfaces:

EndPoint

Direct Known Subclasses:

SelectChannelEndPoint
```
public class ChannelEndPoint
extends java.lang.Object
implements EndPoint
```
Channel End Point.
Holds the channel and socket for an NIO endpoint.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.nio.channels.ByteChannel`	`_channel`
`protected java.nio.ByteBuffer[]`	`_gather2`
`protected java.net.InetSocketAddress`	`_local`
`protected int`	`_maxIdleTime`
`protected java.net.InetSocketAddress`	`_remote`
`protected java.net.Socket`	`_socket`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ChannelEndPoint(java.nio.channels.ByteChannel channel)`
`protected`	`ChannelEndPoint(java.nio.channels.ByteChannel channel, int maxIdleTime)`

Method Summary

Methods
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, java.nio.ByteBuffer bbuf0, Buffer buffer, java.nio.ByteBuffer bbuf1)`
`java.nio.channels.ByteChannel`	`getChannel()`
`java.lang.String`	`getLocalAddr()`
`java.lang.String`	`getLocalHost()`
`int`	`getLocalPort()`
`int`	`getMaxIdleTime()` Get the max idle time in ms.
`java.lang.String`	`getRemoteAddr()`
`java.lang.String`	`getRemoteHost()`
`int`	`getRemotePort()`
`java.lang.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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _channel
```
protected final java.nio.channels.ByteChannel _channel
```
  - _gather2
```
protected final java.nio.ByteBuffer[] _gather2
```
  - _socket
```
protected final java.net.Socket _socket
```
  - _local
```
protected final java.net.InetSocketAddress _local
```
  - _remote
```
protected final java.net.InetSocketAddress _remote
```
  - _maxIdleTime
```
protected volatile int _maxIdleTime
```
- Constructor Detail
  - ChannelEndPoint
```
public ChannelEndPoint(java.nio.channels.ByteChannel channel)
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - ChannelEndPoint
```
protected ChannelEndPoint(java.nio.channels.ByteChannel channel,
               int maxIdleTime)
                   throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - isBlocking
```
public boolean isBlocking()
```
    Specified by:
    
    isBlocking in interface EndPoint
  - blockReadable
```
public boolean blockReadable(long millisecs)
                      throws java.io.IOException
```
    Specified by:
    
    blockReadable in interface EndPoint
    
    Throws:
    
    java.io.IOException
  - blockWritable
```
public boolean blockWritable(long millisecs)
                      throws java.io.IOException
```
    Specified by:
    
    blockWritable in interface EndPoint
    
    Throws:
    
    java.io.IOException
  - isOpen
```
public boolean isOpen()
```
    Specified by:
    
    isOpen in interface EndPoint
  - shutdownChannelInput
```
protected final void shutdownChannelInput()
                                   throws java.io.IOException
```
    Shutdown the channel Input. Cannot be overridden. To override, see shutdownInput()
    
    Throws:
    
    java.io.IOException
  - shutdownInput
```
public void shutdownInput()
                   throws java.io.IOException
```
    Description copied from interface: EndPoint
    
    Shutdown any backing input stream associated with the endpoint
    
    Specified by:
    
    shutdownInput in interface EndPoint
    
    Throws:
    
    java.io.IOException
  - shutdownChannelOutput
```
protected final void shutdownChannelOutput()
                                    throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - shutdownOutput
```
public void shutdownOutput()
                    throws java.io.IOException
```
    Description copied from interface: EndPoint
    
    Shutdown any backing output stream associated with the endpoint
    
    Specified by:
    
    shutdownOutput in interface EndPoint
    
    Throws:
    
    java.io.IOException
  - isOutputShutdown
```
public boolean isOutputShutdown()
```
    Specified by:
    
    isOutputShutdown in interface EndPoint
  - isInputShutdown
```
public boolean isInputShutdown()
```
    Specified by:
    
    isInputShutdown in interface EndPoint
  - close
```
public void close()
           throws java.io.IOException
```
    Description copied from interface: EndPoint
    
    Close any backing stream associated with the endpoint
    
    Specified by:
    
    close in interface EndPoint
    
    Throws:
    
    java.io.IOException
  - fill
```
public int fill(Buffer buffer)
         throws java.io.IOException
```
    Description copied from interface: EndPoint
    
    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.
    
    Specified by:
    
    fill in interface EndPoint
    
    Returns:
    an int value indicating the number of bytes filled or -1 if EOF is reached.
    
    Throws:
    
    EofException - If input is shutdown or the endpoint is closed.
    
    java.io.IOException
  - flush
```
public int flush(Buffer buffer)
          throws java.io.IOException
```
    Description copied from interface: EndPoint
    
    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.
    
    Specified by:
    
    flush in interface EndPoint
    
    Parameters:
    buffer - The buffer to flush. This buffers getIndex is updated.
    
    Returns:
    the number of bytes written
    
    Throws:
    
    EofException - If the endpoint is closed or output is shutdown.
    
    java.io.IOException
  - flush
```
public int flush(Buffer header,
        Buffer buffer,
        Buffer trailer)
          throws java.io.IOException
```
    Description copied from interface: EndPoint
    
    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.
    
    Specified by:
    
    flush in interface EndPoint
    
    Parameters:
    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.
    
    Returns:
    the total number of bytes written.
    
    Throws:
    
    java.io.IOException
  - gatheringFlush
```
protected int gatheringFlush(Buffer header,
                 java.nio.ByteBuffer bbuf0,
                 Buffer buffer,
                 java.nio.ByteBuffer bbuf1)
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getChannel
```
public java.nio.channels.ByteChannel getChannel()
```
    Returns:
    Returns the channel.
  - getLocalAddr
```
public java.lang.String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface EndPoint
    
    Returns:
    The local IP address to which this EndPoint is bound, or null if this EndPoint does not represent a network connection.
  - getLocalHost
```
public java.lang.String getLocalHost()
```
    Specified by:
    
    getLocalHost in interface EndPoint
    
    Returns:
    The local host name to which this EndPoint is bound, or null if this EndPoint does not represent a network connection.
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface EndPoint
    
    Returns:
    The local port number on which this EndPoint is listening, or 0 if this EndPoint does not represent a network connection.
  - getRemoteAddr
```
public java.lang.String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface EndPoint
    
    Returns:
    The remote IP address to which this EndPoint is connected, or null if this EndPoint does not represent a network connection.
  - getRemoteHost
```
public java.lang.String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface EndPoint
    
    Returns:
    The host name of the remote machine to which this EndPoint is connected, or null if this EndPoint does not represent a network connection.
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface EndPoint
    
    Returns:
    The remote port number to which this EndPoint is connected, or 0 if this EndPoint does not represent a network connection.
  - getTransport
```
public java.lang.Object getTransport()
```
    Specified by:
    
    getTransport in interface EndPoint
    
    Returns:
    The underlying transport object (socket, channel, etc.)
  - flush
```
public void flush()
           throws java.io.IOException
```
    Description copied from interface: EndPoint
    
    Flush any buffered output. May fail to write all data if endpoint is non-blocking
    
    Specified by:
    
    flush in interface EndPoint
    
    Throws:
    
    EofException - If the endpoint is closed or output is shutdown.
    
    java.io.IOException
  - getMaxIdleTime
```
public int getMaxIdleTime()
```
    Description copied from interface: EndPoint
    
    Get the max idle time in ms.
    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.
    
    Specified by:
    
    getMaxIdleTime in interface EndPoint
    
    Returns:
    the max idle time in ms or if ms <= 0 implies an infinite timeout
  - setMaxIdleTime
```
public void setMaxIdleTime(int timeMs)
                    throws java.io.IOException
```
    Description copied from interface: EndPoint
    
    Set the max idle time.
    
    Specified by:
    
    setMaxIdleTime in interface EndPoint
    
    Parameters:
    timeMs - the max idle time in MS. Timeout <= 0 implies an infinite timeout
    
    Throws:
    
    java.io.IOException - if the timeout cannot be set.
    See Also:
    StreamEndPoint.setMaxIdleTime(int)

Class ChannelEndPoint

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_channel

_gather2

_socket

_local

_remote

_maxIdleTime

Constructor Detail

ChannelEndPoint

ChannelEndPoint

Method Detail

isBlocking

blockReadable

blockWritable

isOpen

shutdownChannelInput

shutdownInput

shutdownChannelOutput

shutdownOutput

isOutputShutdown

isInputShutdown

close

fill

flush

flush

gatheringFlush

getChannel

getLocalAddr

getLocalHost

getLocalPort

getRemoteAddr

getRemoteHost

getRemotePort

getTransport

flush

getMaxIdleTime

setMaxIdleTime