io.netty.handler.stream

类 ChunkedWriteHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.stream.ChunkedWriteHandler

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public class ChunkedWriteHandler
extends ChannelDuplexHandler

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().

嵌套类概要

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
ChunkedWriteHandler()
ChunkedWriteHandler(int maxPendingWrites) 已过时。 use ChunkedWriteHandler()

方法概要

限定符和类型	方法和说明
void	channelInactive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	flush(ChannelHandlerContext ctx) Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler 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, java.lang.Object msg, ChannelPromise promise) Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

从类继承的方法 io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, read

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, exceptionCaught, userEventTriggered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

exceptionCaught, handlerRemoved

构造器详细资料

ChunkedWriteHandler

public ChunkedWriteHandler()

ChunkedWriteHandler

@Deprecated
public ChunkedWriteHandler(int maxPendingWrites)

已过时。 use ChunkedWriteHandler()

方法详细资料

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception

从类复制的说明: ChannelHandlerAdapter

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

指定者:

handlerAdded 在接口中 ChannelHandler

覆盖:

handlerAdded 在类中 ChannelHandlerAdapter

抛出:

java.lang.Exception

resumeTransfer

public void resumeTransfer()

Continues to fetch the chunks from the input.

write

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

从类复制的说明: ChannelDuplexHandler

Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

write 在接口中 ChannelOutboundHandler

覆盖:

write 在类中 ChannelDuplexHandler

参数:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

flush

public void flush(ChannelHandlerContext ctx)
           throws java.lang.Exception

从类复制的说明: ChannelDuplexHandler

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

指定者:

flush 在接口中 ChannelOutboundHandler

覆盖:

flush 在类中 ChannelDuplexHandler

参数:

ctx - the ChannelHandlerContext for which the flush operation is made

抛出:

java.lang.Exception - thrown if an error occurs

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

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

指定者:

channelInactive 在接口中 ChannelInboundHandler

覆盖:

channelInactive 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

channelWritabilityChanged

public void channelWritabilityChanged(ChannelHandlerContext ctx)
                               throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

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

指定者:

channelWritabilityChanged 在接口中 ChannelInboundHandler

覆盖:

channelWritabilityChanged 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception