com.github.netty.core.util

类 ChunkedWriteHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

com.github.netty.core.util.ChunkedWriteHandler

所有已实现的接口:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler

public class ChunkedWriteHandler
extends io.netty.channel.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(ByteBufAllocator), 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

io.netty.channel.ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
ChunkedWriteHandler(LongSupplier maxBufferBytes)
ChunkedWriteHandler(Queue<com.github.netty.core.util.ChunkedWriteHandler.PendingWrite> queue, LongSupplier maxBufferBytes)

方法概要

限定符和类型	方法和说明
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
void	channelWritabilityChanged(io.netty.channel.ChannelHandlerContext ctx)
void	discard(Throwable cause)
void	flush(io.netty.channel.ChannelHandlerContext ctx)
long	getMaxBufferBytes()
Collection<com.github.netty.core.util.ChunkedWriteHandler.PendingWrite>	getUnFlushList()
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
void	resumeTransfer() Continues to fetch the chunks from the input.
void	setMaxBufferBytes(LongSupplier maxBufferBytes)
String	toString()
int	unWriteSize()
void	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise)

从类继承的方法 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

handlerRemoved, isSharable

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

exceptionCaught, handlerRemoved

构造器详细资料

ChunkedWriteHandler

public ChunkedWriteHandler(LongSupplier maxBufferBytes)

ChunkedWriteHandler

public ChunkedWriteHandler(Queue<com.github.netty.core.util.ChunkedWriteHandler.PendingWrite> queue,
                           LongSupplier maxBufferBytes)

方法详细资料

setMaxBufferBytes

public void setMaxBufferBytes(LongSupplier maxBufferBytes)

getUnFlushList

public Collection<com.github.netty.core.util.ChunkedWriteHandler.PendingWrite> getUnFlushList()

getMaxBufferBytes

public long getMaxBufferBytes()

handlerAdded

public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
                  throws Exception

指定者:

handlerAdded 在接口中 io.netty.channel.ChannelHandler

覆盖:

handlerAdded 在类中 io.netty.channel.ChannelHandlerAdapter

抛出:

Exception

resumeTransfer

public void resumeTransfer()

Continues to fetch the chunks from the input.

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
                  Object msg,
                  io.netty.channel.ChannelPromise promise)
           throws Exception

指定者:

write 在接口中 io.netty.channel.ChannelOutboundHandler

覆盖:

write 在类中 io.netty.channel.ChannelDuplexHandler

抛出:

Exception

flush

public void flush(io.netty.channel.ChannelHandlerContext ctx)
           throws Exception

指定者:

flush 在接口中 io.netty.channel.ChannelOutboundHandler

覆盖:

flush 在类中 io.netty.channel.ChannelDuplexHandler

抛出:

Exception

channelInactive

public void channelInactive(io.netty.channel.ChannelHandlerContext ctx)
                     throws Exception

指定者:

channelInactive 在接口中 io.netty.channel.ChannelInboundHandler

覆盖:

channelInactive 在类中 io.netty.channel.ChannelInboundHandlerAdapter

抛出:

Exception

channelWritabilityChanged

public void channelWritabilityChanged(io.netty.channel.ChannelHandlerContext ctx)
                               throws Exception

指定者:

channelWritabilityChanged 在接口中 io.netty.channel.ChannelInboundHandler

覆盖:

channelWritabilityChanged 在类中 io.netty.channel.ChannelInboundHandlerAdapter

抛出:

Exception

unWriteSize

public int unWriteSize()

discard

public void discard(Throwable cause)

toString

public String toString()

覆盖:

toString 在类中 Object