org.dcache.xrootd.stream

Class ChunkedResponseWriteHandler

java.lang.Object

org.dcache.xrootd.stream.ChunkedResponseWriteHandler

All Implemented Interfaces:

org.jboss.netty.channel.ChannelDownstreamHandler, org.jboss.netty.channel.ChannelHandler, org.jboss.netty.channel.ChannelUpstreamHandler, org.jboss.netty.channel.LifeCycleAwareChannelHandler

public class ChunkedResponseWriteHandler
extends Object
implements org.jboss.netty.channel.ChannelUpstreamHandler, org.jboss.netty.channel.ChannelDownstreamHandler, org.jboss.netty.channel.LifeCycleAwareChannelHandler

A ChannelHandler that adds support for writing chunked xrootd replies. Loosely based on org.jboss.netty.handler.stream.ChunkedWriteHandler, but specialized for xrootd. Xrootd allows replies to be delivered out of order, which means that unchunked responses do not have to be queued and can be passed downstream right away. Since the handler is protocol specific, it can generated proper xrootd error responses in case of faults. XrootdChunkedWriteHandler does not support suspended transfers. To use ChunkedResponseWriteHandler, you have to insert a new ChunkedResponseWriteHandler instance:

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

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

 Channel ch = ...;
 ReadRequest request = ...;
 long maxFrameSize = 2 << 20;
 FileChannel channel = ...;
 ch.write(new ChunkedFileChannelReadResponse(request, maxFrameSize, channel));
 

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.netty.channel.ChannelHandler

org.jboss.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
ChunkedResponseWriteHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterAdd(org.jboss.netty.channel.ChannelHandlerContext ctx)
void	afterRemove(org.jboss.netty.channel.ChannelHandlerContext ctx)
void	beforeAdd(org.jboss.netty.channel.ChannelHandlerContext ctx)
void	beforeRemove(org.jboss.netty.channel.ChannelHandlerContext ctx)
void	handleDownstream(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.ChannelEvent e)
void	handleUpstream(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.ChannelEvent e)

Methods inherited from class java.lang.Object

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

Constructor Detail

ChunkedResponseWriteHandler

public ChunkedResponseWriteHandler()

Method Detail

handleDownstream

public void handleDownstream(org.jboss.netty.channel.ChannelHandlerContext ctx,
                    org.jboss.netty.channel.ChannelEvent e)
                      throws Exception

Specified by:

handleDownstream in interface org.jboss.netty.channel.ChannelDownstreamHandler

Throws:

Exception

handleUpstream

public void handleUpstream(org.jboss.netty.channel.ChannelHandlerContext ctx,
                  org.jboss.netty.channel.ChannelEvent e)
                    throws Exception

Specified by:

handleUpstream in interface org.jboss.netty.channel.ChannelUpstreamHandler

Throws:

Exception

beforeAdd

public void beforeAdd(org.jboss.netty.channel.ChannelHandlerContext ctx)
               throws Exception

Specified by:

beforeAdd in interface org.jboss.netty.channel.LifeCycleAwareChannelHandler

Throws:

Exception

afterAdd

public void afterAdd(org.jboss.netty.channel.ChannelHandlerContext ctx)
              throws Exception

Specified by:

afterAdd in interface org.jboss.netty.channel.LifeCycleAwareChannelHandler

Throws:

Exception

beforeRemove

public void beforeRemove(org.jboss.netty.channel.ChannelHandlerContext ctx)
                  throws Exception

Specified by:

beforeRemove in interface org.jboss.netty.channel.LifeCycleAwareChannelHandler

Throws:

Exception

afterRemove

public void afterRemove(org.jboss.netty.channel.ChannelHandlerContext ctx)
                 throws Exception

Specified by:

afterRemove in interface org.jboss.netty.channel.LifeCycleAwareChannelHandler

Throws:

Exception