Netty5/Codec 5.0.0.Alpha5 · io.netty5.handler.codec.compression.CompressionHandler

Modifier and Type	Field and Description
private final long	closeWriteTimeout
private final TimeUnit	closeWriteTimeoutUnit
private Compressor	compressor
private final Supplier<? extends Compressor>	compressorSupplier
private final boolean	discardBytesAfterFinished

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	CompressionHandler(Supplier<? extends Compressor> the `Supplier` that is used to create the `Compressor`. compressorSupplier) Creates a new instance.
public	CompressionHandler(Supplier<? extends Compressor> the `Supplier` that is used to create the `Compressor`. compressorSupplier, long the amount to wait before we will close even tho the write of the trailer was not finished yet. closeWriteTimeout, TimeUnit the unit of the timeout. closeWriteTimeoutUnit, boolean `true` if the bytes should be discarded after the `Compressor` finished the compression of the whole stream. discardBytesAfterFinished) Creates a new instance.

public

CompressionHandler(Supplier<? extends Compressor>

the Supplier that is used to create the Compressor.

compressorSupplier)

Creates a new instance.

public

CompressionHandler(Supplier<? extends Compressor>

the Supplier that is used to create the Compressor.

compressorSupplier, long

the amount to wait before we will close even tho the write of the trailer was not finished yet.

closeWriteTimeout, TimeUnit

the unit of the timeout.

closeWriteTimeoutUnit, boolean

true if the bytes should be discarded after the Compressor finished the compression of the whole stream.

discardBytesAfterFinished)

Creates a new instance.

Method Summary

Modifier and Type	Method and Description
public void	channelInactive(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime.
public Future<Void>	close(ChannelHandlerContext the `ChannelHandlerContext` for which the close operation is made ctx) Overrides default io.netty5.channel.ChannelHandler.close. Called once a close operation is made.
private void	closeCompressor()
private Future<Void>	finish(ChannelHandlerContext ctx, boolean closeCtx)
public void	handlerAdded(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events.
public void	handlerRemoved(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore.
public Future<Void>	write(ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made ctx, Object the message to write msg) Overrides default io.netty5.channel.ChannelHandler.write. Called once a write operation is made.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

closeWriteTimeout	back to summary
private final long closeWriteTimeout

closeWriteTimeoutUnit	back to summary
private final TimeUnit closeWriteTimeoutUnit

compressor	back to summary
private Compressor compressor

compressorSupplier	back to summary
private final Supplier<? extends Compressor> compressorSupplier

discardBytesAfterFinished	back to summary
private final boolean discardBytesAfterFinished

Constructor Detail

CompressionHandler back to summary

CompressionHandler	back to summary
public CompressionHandler(Supplier<? extends Compressor> compressorSupplier) Creates a new instance. Parameters compressorSupplier:Supplier<? extends Compressor> the `Supplier` that is used to create the `Compressor`.

public CompressionHandler(Supplier<? extends Compressor> compressorSupplier)

Creates a new instance.

Parameters

compressorSupplier:Supplier<? extends Compressor>: the Supplier that is used to create the Compressor.

CompressionHandler back to summary

CompressionHandler	back to summary
public CompressionHandler(Supplier<? extends Compressor> compressorSupplier, long closeWriteTimeout, TimeUnit closeWriteTimeoutUnit, boolean discardBytesAfterFinished) Creates a new instance. Parameters compressorSupplier:Supplier<? extends Compressor> the `Supplier` that is used to create the `Compressor`. closeWriteTimeout:long the amount to wait before we will close even tho the write of the trailer was not finished yet. closeWriteTimeoutUnit:TimeUnit the unit of the timeout. discardBytesAfterFinished:boolean `true` if the bytes should be discarded after the `Compressor` finished the compression of the whole stream.

public CompressionHandler(Supplier<? extends Compressor> compressorSupplier, long closeWriteTimeout, TimeUnit closeWriteTimeoutUnit, boolean discardBytesAfterFinished)

Creates a new instance.

Parameters

compressorSupplier:Supplier<? extends Compressor>: the Supplier that is used to create the Compressor.
closeWriteTimeout:long: the amount to wait before we will close even tho the write of the trailer was not finished yet.
closeWriteTimeoutUnit:TimeUnit: the unit of the timeout.
discardBytesAfterFinished:boolean: true if the bytes should be discarded after the Compressor finished the compression of the whole stream.

Method Detail

channelInactive back to summary

channelInactive	back to summary
public void channelInactive(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelInactive. Doc from io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime. Annotations @Override

public void channelInactive(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelInactive.

Doc from io.netty5.channel.ChannelHandler.channelInactive.

The Channel of the ChannelHandlerContext was registered is now inactive and reached its end of lifetime.

Annotations

@Override

close back to summary

close	back to summary
public Future<Void> close(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.close. Doc from io.netty5.channel.ChannelHandler.close. Called once a close operation is made. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the close operation is made Returns:Future<Void> the `Future` which will be notified once the operation completes. Annotations @Override

public Future<Void> close(ChannelHandlerContext ctx)

Overrides default io.netty5.channel.ChannelHandler.close.

Doc from io.netty5.channel.ChannelHandler.close.

Called once a close operation is made.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the close operation is made

Returns:Future<Void>

the Future which will be notified once the operation completes.

Annotations

@Override

closeCompressor	back to summary
private void closeCompressor()

finish	back to summary
private Future<Void> finish(ChannelHandlerContext ctx, boolean closeCtx)

handlerAdded back to summary

handlerAdded	back to summary
public void handlerAdded(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.handlerAdded. Doc from io.netty5.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events. Annotations @Override

public void handlerAdded(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.handlerAdded.

Doc from io.netty5.channel.ChannelHandler.handlerAdded.

Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.

Annotations

@Override

handlerRemoved back to summary

handlerRemoved	back to summary
public void handlerRemoved(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.handlerRemoved. Doc from io.netty5.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore. Annotations @Override

public void handlerRemoved(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.handlerRemoved.

Doc from io.netty5.channel.ChannelHandler.handlerRemoved.

Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.

Annotations

@Override

write back to summary

write	back to summary
public Future<Void> write(ChannelHandlerContext ctx, Object msg) Overrides default io.netty5.channel.ChannelHandler.write. Doc from io.netty5.channel.ChannelHandler.write. Called once a write operation is made. The write operation will write the messages through the `ChannelPipeline`. Those are then ready to be flushed to the actual `Channel` once `Channel#flush()` is called. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made msg:Object the message to write Returns:Future<Void> the `Future` which will be notified once the operation completes. Annotations @Override

public Future<Void> write(ChannelHandlerContext ctx, Object msg)

Overrides default io.netty5.channel.ChannelHandler.write.

Doc from io.netty5.channel.ChannelHandler.write.

Called once a write operation is made. The write operation will write the messages through the ChannelPipeline. Those are then ready to be flushed to the actual Channel once Channel#flush() is called.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the write operation is made
msg:Object: the message to write

Returns:Future<Void>

the Future which will be notified once the operation completes.

Annotations

@Override

public final Class CompressionHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail