org.jenkinsci.remoting.protocol.impl

Class NIONetworkLayer

java.lang.Object

org.jenkinsci.remoting.protocol.NetworkLayer

org.jenkinsci.remoting.protocol.impl.NIONetworkLayer

All Implemented Interfaces:

IOHubReadyListener, ProtocolLayer, ProtocolLayer.Send

public class NIONetworkLayer
extends NetworkLayer
implements IOHubReadyListener

A NetworkLayer that uses the NIO Selector of a IOHub to manage I/O.

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.jenkinsci.remoting.protocol.ProtocolLayer

ProtocolLayer.Recv, ProtocolLayer.Send

Field Summary

Fields inherited from interface org.jenkinsci.remoting.protocol.ProtocolLayer

EMPTY_BUFFER, UTF_8

Constructor Summary

Constructors

Constructor and Description
NIONetworkLayer(IOHub ioHub, ReadableByteChannel in, WritableByteChannel out) Constructor.

Method Summary

Modifier and Type	Method and Description
void	doCloseRecv() Request the recv side to be closed.
void	doCloseSend() Notify the lower layer that it should close.
boolean	isSendOpen() Tracks if this layer is submitting data to be sent via ProtocolLayer.Send.doSend(ByteBuffer).
void	ready(boolean accept, boolean connect, boolean read, boolean write) Callback to indicate the SelectableChannel that this listener was registered for is ready for the indicated operations.
void	start() Starts this layer.
protected void	write(ByteBuffer data) SPI: Perform the actual write to the recipient.

Methods inherited from class org.jenkinsci.remoting.protocol.NetworkLayer

acquire, doSend, getIoHub, init, isRecvOpen, newByteBufferQueue, onRead, onRecvClosed, release, stack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NIONetworkLayer

public NIONetworkLayer(IOHub ioHub,
                       ReadableByteChannel in,
                       WritableByteChannel out)

Constructor.

Parameters:

ioHub - our hub.

in - the source of data.

out - the sink for data.

Method Detail

ready

public void ready(boolean accept,
                  boolean connect,
                  boolean read,
                  boolean write)

Callback to indicate the SelectableChannel that this listener was registered for is ready for the indicated operations. The SelectionKey.interestOps() will have been cleared for all the operations that are true so the callback can be assured that processing of any one specific operation will be linearized, though there may be concurrent calls to IOHubReadyListener.ready(boolean, boolean, boolean, boolean) with disjoint ready operations. The callback will most likely want to re-register for IOHub.addInterestRead(SelectionKey) or IOHub.addInterestAccept(SelectionKey) immediately before returning from a ready notification of the read or accept status. The callback will only want to re-register for a IOHub.addInterestWrite(SelectionKey) if it has filled the SelectableChannel's output buffer and has more data to write.

Specified by:

ready in interface IOHubReadyListener

Parameters:

accept - if the SelectableChannel has a connection to accept. Call IOHub.addInterestAccept(SelectionKey) to request additional callbacks for this ready state.

connect - if the SelectableChannel has established a connection. Call IOHub.addInterestConnect(SelectionKey) to request additional callbacks for this ready state.

read - if the SelectableChannel has data available to read. Call IOHub.addInterestRead(SelectionKey) to request additional callbacks for this ready state.

write - if the SelectableChannel can accept data for writing. Call IOHub.addInterestWrite(SelectionKey) to request additional callbacks for this ready state.

write

protected void write(@Nonnull
                     ByteBuffer data)
              throws IOException

SPI: Perform the actual write to the recipient. This method should be non-blocking. The data should be enqueued and written in the order of calls to NetworkLayer.write(ByteBuffer).

Specified by:

write in class NetworkLayer

Parameters:

data - the data received. Any data consumed from the ByteBuffer can be assumed as processed. Any data not consumed from the ByteBuffer will be the responsibility of the caller to resubmit in subsequent calls.

Throws:

IOException - if something goes wrong

doCloseRecv

public void doCloseRecv()

Request the recv side to be closed.

Specified by:

doCloseRecv in class NetworkLayer

start

public void start()
           throws IOException

Starts this layer. All layers in the stack will be initialized before a call to this method. All lower layers in the stack will have been started before this layer is started.

Specified by:

start in interface ProtocolLayer

Overrides:

start in class NetworkLayer

Throws:

IOException - if something goes wrong.

doCloseSend

public void doCloseSend()
                 throws IOException

Notify the lower layer that it should close. Callers to this method are assumed to have already called ProtocolLayer.Recv.onRecvClosed(IOException) for any upper layers.

Specified by:

doCloseSend in interface ProtocolLayer.Send

Throws:

IOException - if there was an error closing the lower layer.

isSendOpen

public boolean isSendOpen()

Tracks if this layer is submitting data to be sent via ProtocolLayer.Send.doSend(ByteBuffer). Once this method returns false it must always return false and can be assumed to behave in this way.

Specified by:

isSendOpen in interface ProtocolLayer.Send

Returns:

true if submitting data to be sent via ProtocolLayer.Send.doSend(ByteBuffer).