Package org.eclipse.jetty.io
Class ChannelEndPoint
java.lang.Object
org.eclipse.jetty.io.IdleTimeout
org.eclipse.jetty.io.AbstractEndPoint
org.eclipse.jetty.io.ChannelEndPoint
- All Implemented Interfaces:
Closeable
,AutoCloseable
,EndPoint
,ManagedSelector.Selectable
- Direct Known Subclasses:
SocketChannelEndPoint
public abstract class ChannelEndPoint
extends AbstractEndPoint
implements ManagedSelector.Selectable
Channel End Point.
Holds the channel and socket for an NIO endpoint.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
private class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final SocketChannel
private int
private int
private SelectionKey
private final Runnable
private final Runnable
private final Runnable
private final ManagedSelector
private final ManagedSelector.SelectorUpdate
private boolean
private static final Logger
-
Constructor Summary
ConstructorsConstructorDescriptionChannelEndPoint
(SocketChannel channel, ManagedSelector selector, SelectionKey key, Scheduler scheduler) -
Method Summary
Modifier and TypeMethodDescriptionprivate void
changeInterests
(int operation) void
doClose()
protected void
int
fill
(ByteBuffer buffer) Fill the passed buffer with data from this endpoint.boolean
flush
(ByteBuffer... buffers) Flush data from the passed header/buffer to this endpoint.boolean
isOpen()
This abstract method should be called to check if idle timeouts should still be checked.boolean
Is the endpoint optimized for DirectBuffer usageprotected void
void
onClose()
Callback method invoked when this EndPoint is close.protected void
Callback method invoked when a read or write events has been detected by theManagedSelector
for this endpoint.void
replaceKey
(SelectionKey newKey) Callback method invoked when the SelectionKey is replaced because the channel has been moved to a new selector.void
Callback method invoked when all the keys selected by theManagedSelector
for this endpoint have been processed.private void
updateKeyAction
(Selector selector) Methods inherited from class org.eclipse.jetty.io.AbstractEndPoint
checkFill, checkFlush, close, close, doShutdownInput, fillInterested, getConnection, getCreatedTimeStamp, getFillInterest, getWriteFlusher, isFillInterested, isInputShutdown, isOutputShutdown, onClose, onIdleExpired, onOpen, reset, setConnection, shutdownInput, shutdownOutput, toConnectionString, toString, tryFillInterested, upgrade, write
Methods inherited from class org.eclipse.jetty.io.IdleTimeout
checkIdleTimeout, getIdleFor, getIdleTimeout, getScheduler, notIdle, setIdleTimeout
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.eclipse.jetty.io.EndPoint
getIdleTimeout, setIdleTimeout
-
Field Details
-
LOG
-
_channel
-
_selector
-
_key
-
_updatePending
private boolean _updatePending -
_currentInterestOps
private int _currentInterestOps -
_desiredInterestOps
private int _desiredInterestOps -
_updateKeyAction
-
_runFillable
-
_runCompleteWrite
-
_runCompleteWriteFillable
-
-
Constructor Details
-
ChannelEndPoint
public ChannelEndPoint(SocketChannel channel, ManagedSelector selector, SelectionKey key, Scheduler scheduler)
-
-
Method Details
-
getLocalAddress
- Specified by:
getLocalAddress
in interfaceEndPoint
- Returns:
- The local Inet address to which this
EndPoint
is bound, ornull
if thisEndPoint
does not represent a network connection.
-
getRemoteAddress
- Specified by:
getRemoteAddress
in interfaceEndPoint
- Returns:
- The remote Inet address to which this
EndPoint
is bound, ornull
if thisEndPoint
does not represent a network connection.
-
isOptimizedForDirectBuffers
public boolean isOptimizedForDirectBuffers()Description copied from interface:EndPoint
Is the endpoint optimized for DirectBuffer usage- Specified by:
isOptimizedForDirectBuffers
in interfaceEndPoint
- Overrides:
isOptimizedForDirectBuffers
in classAbstractEndPoint
- Returns:
- True if direct buffers can be used optimally.
-
isOpen
public boolean isOpen()Description copied from class:IdleTimeout
This abstract method should be called to check if idle timeouts should still be checked.- Specified by:
isOpen
in interfaceEndPoint
- Overrides:
isOpen
in classAbstractEndPoint
- Returns:
- True if the entity monitored should still be checked for idle timeouts
-
doShutdownOutput
protected void doShutdownOutput()- Overrides:
doShutdownOutput
in classAbstractEndPoint
-
doClose
public void doClose()- Overrides:
doClose
in classAbstractEndPoint
-
onClose
public void onClose()Description copied from interface:EndPoint
Callback method invoked when this EndPoint is close.
- Specified by:
onClose
in interfaceEndPoint
- Overrides:
onClose
in classAbstractEndPoint
- See Also:
-
fill
Description copied from interface:EndPoint
Fill the passed buffer with data from this endpoint. The bytes are appended to any data already in the buffer by writing from the buffers limit up to it's capacity. The limit is updated to include the filled bytes.- Specified by:
fill
in interfaceEndPoint
- Parameters:
buffer
- The buffer to fill. The position and limit are modified during the fill. After the operation, the position is unchanged and the limit is increased to reflect the new data filled.- Returns:
- an
int
value indicating the number of bytes filled or -1 if EOF is read or the input is shutdown. - Throws:
IOException
- if the endpoint is closed.
-
flush
Description copied from interface:EndPoint
Flush data from the passed header/buffer to this endpoint. As many bytes as can be consumed are taken from the header/buffer position up until the buffer limit. The header/buffers position is updated to indicate how many bytes have been consumed.- Specified by:
flush
in interfaceEndPoint
- Parameters:
buffers
- the buffers to flush- Returns:
- True IFF all the buffers have been consumed and the endpoint has flushed the data to its destination (ie is not buffering any data).
- Throws:
IOException
- If the endpoint is closed or output is shutdown.
-
getChannel
-
getTransport
- Specified by:
getTransport
in interfaceEndPoint
- Returns:
- The underlying transport object (socket, channel, etc.)
-
needsFillInterest
protected void needsFillInterest()- Specified by:
needsFillInterest
in classAbstractEndPoint
-
onIncompleteFlush
protected void onIncompleteFlush()- Specified by:
onIncompleteFlush
in classAbstractEndPoint
-
onSelected
Description copied from interface:ManagedSelector.Selectable
Callback method invoked when a read or write events has been detected by theManagedSelector
for this endpoint.- Specified by:
onSelected
in interfaceManagedSelector.Selectable
- Returns:
- a job that may block or null
-
updateKeyAction
-
updateKey
public void updateKey()Description copied from interface:ManagedSelector.Selectable
Callback method invoked when all the keys selected by theManagedSelector
for this endpoint have been processed.- Specified by:
updateKey
in interfaceManagedSelector.Selectable
-
replaceKey
Description copied from interface:ManagedSelector.Selectable
Callback method invoked when the SelectionKey is replaced because the channel has been moved to a new selector.- Specified by:
replaceKey
in interfaceManagedSelector.Selectable
- Parameters:
newKey
- the new SelectionKey
-
changeInterests
private void changeInterests(int operation) -
toEndPointString
- Overrides:
toEndPointString
in classAbstractEndPoint
-