Class EncoderSink

java.lang.Object

org.eclipse.jetty.compression.EncoderSink

All Implemented Interfaces:

Content.Sink

public abstract class EncoderSink
extends Object
implements Content.Sink

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EncoderSink.WriteRecord

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EncoderSink(Content.Sink sink)

Method Summary

Modifier and Type	Method	Description
protected abstract EncoderSink.WriteRecord	encode(boolean last, ByteBuffer content)	Creates a EncoderSink.WriteRecord with the given last flag and content buffer.
protected void	release()	Release all resources held by this instance.
void	write(boolean last, ByteBuffer content, Callback callback)	Writes the given ByteBuffer, notifying the Callback when the write is complete.

Methods inherited from class Object

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

Constructor Details

EncoderSink

protected EncoderSink(Content.Sink sink)

Method Details

write

public void write(boolean last,
 ByteBuffer content,
 Callback callback)

Description copied from interface: Content.Sink

Writes the given ByteBuffer, notifying the Callback when the write is complete.

Implementations guarantee that calls to this method are safely reentrant so that stack overflows are avoided in the case of mutual recursion between the execution of the Callback and a call to this method.

Specified by:

write in interface Content.Sink

Parameters:

last - whether the ByteBuffer is the last to write

content - the ByteBuffer to write

callback - the callback to notify when the write operation is complete

encode

protected abstract EncoderSink.WriteRecord encode(boolean last,
 ByteBuffer content)

Creates a EncoderSink.WriteRecord with the given last flag and content buffer.

Parameters:

last - the last flag to eventually pass to Content.Sink.write(boolean, ByteBuffer, Callback).

content - the buffer to eventually pass to Content.Sink.write(boolean, ByteBuffer, Callback).

Returns:

the EncoderSink.WriteRecord.

Throws:

IllegalStateException - if release() has already been called.

release

protected void release()

Release all resources held by this instance. Any further write attempt fails once this method has been called.

Implementation must be idempotent.