io.netty.handler.stream

Class ChunkedWriteHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.handler.stream.ChunkedWriteHandler

All Implemented Interfaces:

ChannelHandler

public class ChunkedWriteHandler
extends ChannelHandlerAdapter

A ChannelHandler that adds support for writing a large data stream asynchronously neither spending a lot of memory nor getting OutOfMemoryError. Large data streaming such as file transfer requires complicated state management in a ChannelHandler implementation. ChunkedWriteHandler manages such complicated states so that you can send a large data stream without difficulties.

To use ChunkedWriteHandler in your application, you have to insert a new ChunkedWriteHandler instance:

 ChannelPipeline p = ...;
 p.addLast("streamer", new ChunkedWriteHandler());
 p.addLast("handler", new MyHandler());
 

Once inserted, you can write a ChunkedInput so that the ChunkedWriteHandler can pick it up and fetch the content of the stream chunk by chunk and write the fetched chunk downstream:

 Channel ch = ...;
 ch.write(new ChunkedFile(new File("video.mkv"));
 

Sending a stream which generates a chunk intermittently

Some ChunkedInput generates a chunk on a certain event or timing. Such ChunkedInput implementation often returns null on ChunkedInput.readChunk(ChannelHandlerContext), resulting in the indefinitely suspended transfer. To resume the transfer when a new chunk is available, you have to call resumeTransfer().

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable, ChannelHandler.Skip

Constructor Summary

Constructors

Constructor and Description
ChunkedWriteHandler()
ChunkedWriteHandler(int maxPendingWrites) Deprecated. use ChunkedWriteHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	channelInactive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelHandler in the ChannelPipeline.
void	flush(ChannelHandlerContext ctx) Calls ChannelHandlerContext.flush() to forward to the next ChannelHandler in the ChannelPipeline.
void	handlerAdded(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
void	resumeTransfer() Continues to fetch the chunks from the input.
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) Calls ChannelHandlerContext.write(Object) to forward to the next ChannelHandler in the ChannelPipeline.

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, channelActive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, close, connect, deregister, disconnect, exceptionCaught, handlerRemoved, isSharable, read, userEventTriggered

Methods inherited from class java.lang.Object

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

Constructor Detail

ChunkedWriteHandler

public ChunkedWriteHandler()

ChunkedWriteHandler

@Deprecated
public ChunkedWriteHandler(int maxPendingWrites)

Deprecated. use ChunkedWriteHandler()

Method Detail

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws Exception

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

handlerAdded in interface ChannelHandler

Overrides:

handlerAdded in class ChannelHandlerAdapter

Throws:

Exception

resumeTransfer

public void resumeTransfer()

Continues to fetch the chunks from the input.

write

public void write(ChannelHandlerContext ctx,
         Object msg,
         ChannelPromise promise)
           throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.write(Object) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

write in interface ChannelHandler

Overrides:

write in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

flush

public void flush(ChannelHandlerContext ctx)
           throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.flush() to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

flush in interface ChannelHandler

Overrides:

flush in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the flush operation is made

Throws:

Exception - thrown if an error accour

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelInactive in interface ChannelHandler

Overrides:

channelInactive in class ChannelHandlerAdapter

Throws:

Exception

channelWritabilityChanged

public void channelWritabilityChanged(ChannelHandlerContext ctx)
                               throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelWritabilityChanged in interface ChannelHandler

Overrides:

channelWritabilityChanged in class ChannelHandlerAdapter

Throws:

Exception