Package org.jenkinsci.remoting.protocol.impl

Class ChannelApplicationLayer

java.lang.Object

org.jenkinsci.remoting.protocol.ApplicationLayer<Future<Channel>>

org.jenkinsci.remoting.protocol.impl.ChannelApplicationLayer

All Implemented Interfaces:

ProtocolLayer, ProtocolLayer.Recv

public class ChannelApplicationLayer
extends ApplicationLayer<Future<Channel>>

An ApplicationLayer that produces a Channel.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChannelApplicationLayer.ChannelDecorator	Callback for decorating the ChannelBuilder before the Channel is created.
static interface	ChannelApplicationLayer.Listener	Callback interface for notification of the Channel being created.

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

Constructor Summary

Constructors

Constructor	Description
ChannelApplicationLayer(ExecutorService executorService, ChannelApplicationLayer.Listener listener)	Creates a new ChannelApplicationLayer
ChannelApplicationLayer(ExecutorService executorService, ChannelApplicationLayer.Listener listener, String cookie)	Creates a new ChannelApplicationLayer

Method Summary

Modifier and Type	Method	Description
ChannelBuilder	decorate(ChannelBuilder builder)	Allows subclasses to decorate the ChannelBuilder
Future<Channel>	get()	SPI: Returns the application specific API instance.
boolean	isReadOpen()	SPI: Implementations of ApplicationLayer must ensure this method either returns true while the application specific API instance (ApplicationLayer.get()) is accepting data via ApplicationLayer.onRead(ByteBuffer) or returns false once it is permanently closed to incoming data.
void	onRead(ByteBuffer data)	SPI: Callback on data being received from the protocol stack.
void	onReadClosed(IOException cause)	Callback on the lower layer's source of data being closed.
void	start()	Starts this layer.

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

doCloseRead, doCloseWrite, init, isRecvOpen, isWriteOpen, onRecv, onRecvClosed, stack, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelApplicationLayer

public ChannelApplicationLayer(@NonNull
                               ExecutorService executorService,
                               @CheckForNull
                               ChannelApplicationLayer.Listener listener)

Creates a new ChannelApplicationLayer

Parameters:

executorService - the ExecutorService to use for the Channel.

listener - the ChannelApplicationLayer.Listener to notify when the Channel is available.

ChannelApplicationLayer

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public ChannelApplicationLayer(@NonNull
                               ExecutorService executorService,
                               @CheckForNull
                               ChannelApplicationLayer.Listener listener,
                               String cookie)

Creates a new ChannelApplicationLayer

Parameters:

executorService - the ExecutorService to use for the Channel.

listener - the ChannelApplicationLayer.Listener to notify when the Channel is available.

cookie - a cookie to pass through the channel.

Method Detail

get

public Future<Channel> get()

SPI: Returns the application specific API instance.

Specified by:

get in class ApplicationLayer<Future<Channel>>

Returns:

the application specific API instance.

isReadOpen

public boolean isReadOpen()

SPI: Implementations of ApplicationLayer must ensure this method either returns true while the application specific API instance (ApplicationLayer.get()) is accepting data via ApplicationLayer.onRead(ByteBuffer) or returns false once it is permanently closed to incoming data. If the application specific API instance is temporarily not accepting data then this method should return true and the implementation is responsible for caching the data submitted in calls to ApplicationLayer.onRead(ByteBuffer) Once this method returns false it must always return false and can be assumed to behave in this way.

Specified by:

isReadOpen in class ApplicationLayer<Future<Channel>>

Returns:

true if the application specific API instance (ApplicationLayer.get() is accepting data via ApplicationLayer.onRead(ByteBuffer)

onRead

public void onRead(@NonNull
                   ByteBuffer data)
            throws IOException

SPI: Callback on data being received from the protocol stack.

Specified by:

onRead in class ApplicationLayer<Future<Channel>>

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 there was an error during processing of the received data.

onReadClosed

public void onReadClosed(IOException cause)

Callback on the lower layer's source of data being closed.

Specified by:

onReadClosed in class ApplicationLayer<Future<Channel>>

Parameters:

cause - the cause of the lower layer being closed or null.

start

public void start()

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.

decorate

public ChannelBuilder decorate(ChannelBuilder builder)

Allows subclasses to decorate the ChannelBuilder

Parameters:

builder - the ChannelBuilder to decorate

Returns:

the provided ChannelBuilder for method chaining.