Class AbstractH2StreamMultiplexer.H2StreamChannelImpl

java.lang.Object

org.apache.hc.core5.http2.impl.nio.AbstractH2StreamMultiplexer.H2StreamChannelImpl

All Implemented Interfaces:

Cancellable, CapacityChannel, DataStreamChannel, StreamChannel<ByteBuffer>, H2StreamChannel

Enclosing class:

AbstractH2StreamMultiplexer

class AbstractH2StreamMultiplexer.H2StreamChannelImpl
extends Object
implements H2StreamChannel

Field Summary

Fields

Modifier and Type	Field	Description
private final int	id
private final AtomicInteger	inputWindow
private boolean	localClosed
private long	localResetTime
private final AtomicInteger	outputWindow

Constructor Summary

Constructors

Constructor	Description
H2StreamChannelImpl(int id, int initialInputWindowSize, int initialOutputWindowSize)

Method Summary

Modifier and Type	Method	Description
boolean	cancel()	Cancels the ongoing operation or process.
void	endStream()	Terminates the underlying data stream and optionally writes a closing sequence.
void	endStream(List<? extends Header> trailers)	Terminates the underlying data stream and optionally writes a closing sequence with the given trailers.
(package private) void	ensureNotClosed()
int	getId()
AtomicInteger	getInputWindow()
long	getLocalResetTime()
AtomicInteger	getOutputWindow()
boolean	isLocalClosed()
boolean	localReset(int code)
void	markLocalClosed()
void	push(List<Header> headers, AsyncPushProducer pushProducer)
void	requestOutput()	Signals intent by the data producer to produce more data.
void	submit(List<Header> headers, boolean endStream)
String	toString()
void	update(int increment)	Updates data capacity information through this channel.
int	write(ByteBuffer payload)	Writes data from the buffer through this channel into the underlying byte stream.

Methods inherited from class Object

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

Methods inherited from interface H2StreamChannel

isLocalReset, localReset, terminate

Field Details

id

private final int id

inputWindow

private final AtomicInteger inputWindow

outputWindow

private final AtomicInteger outputWindow

localClosed

private volatile boolean localClosed

localResetTime

private volatile long localResetTime

Constructor Details

H2StreamChannelImpl

H2StreamChannelImpl(int id,
 int initialInputWindowSize,
 int initialOutputWindowSize)

Method Details

getId

public int getId()

Specified by:

getId in interface H2StreamChannel

getOutputWindow

public AtomicInteger getOutputWindow()

Specified by:

getOutputWindow in interface H2StreamChannel

getInputWindow

public AtomicInteger getInputWindow()

Specified by:

getInputWindow in interface H2StreamChannel

ensureNotClosed

void ensureNotClosed()
              throws H2ConnectionException

Throws:

H2ConnectionException

submit

public void submit(List<Header> headers,
 boolean endStream)
            throws IOException

Specified by:

submit in interface H2StreamChannel

Throws:

IOException

push

public void push(List<Header> headers,
 AsyncPushProducer pushProducer)
          throws HttpException,
IOException

Specified by:

push in interface H2StreamChannel

Throws:

HttpException

IOException

update

public void update(int increment)
            throws IOException

Description copied from interface: CapacityChannel

Updates data capacity information through this channel. The total number of bytes the consumer is capable of accepting is incremented by the given increment number.

Specified by:

update in interface CapacityChannel

Parameters:

increment - non-negative number of extra bytes the consumer can accept.

Throws:

IOException - in case of an I/O error.

write

public int write(ByteBuffer payload)
          throws IOException

Description copied from interface: DataStreamChannel

Writes data from the buffer through this channel into the underlying byte stream. If the underlying byte stream is temporarily unable to accept more data it can return zero to indicate that no data could be written to the data stream. The data producer can choose to call DataStreamChannel.requestOutput() to signal its intent to produce more data.

Specified by:

write in interface DataStreamChannel

Specified by:

write in interface StreamChannel<ByteBuffer>

Parameters:

payload - source of data

Returns:

The number of bytes written, possibly zero

Throws:

IOException - in case of an I/O error.

endStream

public void endStream(List<? extends Header> trailers)
               throws IOException

Description copied from interface: DataStreamChannel

Terminates the underlying data stream and optionally writes a closing sequence with the given trailers.

Please note that some data streams may not support trailers and may silently ignore the trailers parameter.

Specified by:

endStream in interface DataStreamChannel

Throws:

IOException - in case of an I/O error.

endStream

public void endStream()
               throws IOException

Description copied from interface: StreamChannel

Terminates the underlying data stream and optionally writes a closing sequence.

Specified by:

endStream in interface StreamChannel<ByteBuffer>

Throws:

IOException - in case of an I/O error.

requestOutput

public void requestOutput()

Description copied from interface: DataStreamChannel

Signals intent by the data producer to produce more data. Once the channel is able to accept data its handler is expected to trigger an event to notify the data producer.

Specified by:

requestOutput in interface DataStreamChannel

isLocalClosed

public boolean isLocalClosed()

Specified by:

isLocalClosed in interface H2StreamChannel

markLocalClosed

public void markLocalClosed()

Specified by:

markLocalClosed in interface H2StreamChannel

localReset

public boolean localReset(int code)
                   throws IOException

Specified by:

localReset in interface H2StreamChannel

Throws:

IOException

getLocalResetTime

public long getLocalResetTime()

Specified by:

getLocalResetTime in interface H2StreamChannel

cancel

public boolean cancel()

Description copied from interface: Cancellable

Cancels the ongoing operation or process.

Specified by:

cancel in interface Cancellable

Returns:

true if the operation or process has been cancelled as a result of this method call or false if it has already been cancelled or not started.

toString

public String toString()

Overrides:

toString in class Object