org.jboss.netty.handler.codec.spdy

Class SpdyHttpEncoder

java.lang.Object

org.jboss.netty.handler.codec.spdy.SpdyHttpEncoder

All Implemented Interfaces:

ChannelDownstreamHandler, ChannelHandler

public class SpdyHttpEncoder
extends java.lang.Object
implements ChannelDownstreamHandler

Encodes HttpRequests, HttpResponses, and HttpChunks into SpdySynStreamFrames and SpdySynReplyFrames.

Request Annotations

SPDY specific headers must be added to HttpRequests:

Header Name	Header Value
"X-SPDY-Stream-ID"	The Stream-ID for this request. Stream-IDs must be odd, positive integers, and must increase monotonically.
"X-SPDY-Priority"	The priority value for this request. The priority should be between 0 and 7 inclusive. 0 represents the highest priority and 7 represents the lowest. This header is optional and defaults to 0.

Response Annotations

SPDY specific headers must be added to HttpResponses:

Header Name	Header Value
"X-SPDY-Stream-ID"	The Stream-ID of the request corresponding to this response.

Pushed Resource Annotations

SPDY specific headers must be added to pushed HttpResponses:

Header Name	Header Value
"X-SPDY-Stream-ID"	The Stream-ID for this resource. Stream-IDs must be even, positive integers, and must increase monotonically.
"X-SPDY-Associated-To-Stream-ID"	The Stream-ID of the request that initiated this pushed resource.
"X-SPDY-Priority"	The priority value for this resource. The priority should be between 0 and 7 inclusive. 0 represents the highest priority and 7 represents the lowest. This header is optional and defaults to 0.
"X-SPDY-URL"	The absolute path for the resource being pushed.

Required Annotations

SPDY requires that all Requests and Pushed Resources contain an HTTP "Host" header.

Optional Annotations

Requests and Pushed Resources must contain a SPDY scheme header. This can be set via the "X-SPDY-Scheme" header but otherwise defaults to "https" as that is the most common SPDY deployment.

Chunked Content

This encoder associates all HttpChunks that it receives with the most recently received 'chunked' HttpRequest or HttpResponse.

Pushed Resources

All pushed resources should be sent before sending the response that corresponds to the initial request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SpdyHttpEncoder.SpdyFrameWriter

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

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
private int	currentStreamId
private int	spdyVersion

Constructor Summary

Constructors

Constructor and Description
SpdyHttpEncoder(SpdyVersion spdyVersion) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
private SpdyDataFrame[]	createSpdyDataFrames(int streamId, ChannelBuffer content)
private SpdySynReplyFrame	createSynReplyFrame(HttpResponse httpResponse)
private SpdySynStreamFrame	createSynStreamFrame(HttpMessage httpMessage)
private static ChannelFuture	getDataFuture(ChannelHandlerContext ctx, ChannelFuture future, SpdyDataFrame[] spdyDataFrames, java.net.SocketAddress remoteAddress)
private ChannelFuture	getMessageFuture(ChannelHandlerContext ctx, MessageEvent e, int streamId, HttpMessage httpMessage)
void	handleDownstream(ChannelHandlerContext ctx, ChannelEvent evt) Handles the specified downstream event.
protected void	writeChunk(ChannelHandlerContext ctx, ChannelFuture future, int streamId, HttpChunk chunk, java.net.SocketAddress remoteAddress) Writes an HTTP chunk downstream as one or more SPDY frames.

Methods inherited from class java.lang.Object

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

Field Detail

spdyVersion

private final int spdyVersion

currentStreamId

private volatile int currentStreamId

Constructor Detail

SpdyHttpEncoder

public SpdyHttpEncoder(SpdyVersion spdyVersion)

Creates a new instance.

Parameters:

spdyVersion - the protocol version

Method Detail

handleDownstream

public void handleDownstream(ChannelHandlerContext ctx,
                             ChannelEvent evt)
                      throws java.lang.Exception

Description copied from interface: ChannelDownstreamHandler

Handles the specified downstream event.

Specified by:

handleDownstream in interface ChannelDownstreamHandler

Parameters:

ctx - the context object for this handler

evt - the downstream event to process or intercept

Throws:

java.lang.Exception

writeChunk

protected void writeChunk(ChannelHandlerContext ctx,
                          ChannelFuture future,
                          int streamId,
                          HttpChunk chunk,
                          java.net.SocketAddress remoteAddress)

Writes an HTTP chunk downstream as one or more SPDY frames.

getMessageFuture

private ChannelFuture getMessageFuture(ChannelHandlerContext ctx,
                                       MessageEvent e,
                                       int streamId,
                                       HttpMessage httpMessage)

getDataFuture

private static ChannelFuture getDataFuture(ChannelHandlerContext ctx,
                                           ChannelFuture future,
                                           SpdyDataFrame[] spdyDataFrames,
                                           java.net.SocketAddress remoteAddress)

createSynStreamFrame

private SpdySynStreamFrame createSynStreamFrame(HttpMessage httpMessage)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

createSynReplyFrame

private SpdySynReplyFrame createSynReplyFrame(HttpResponse httpResponse)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

createSpdyDataFrames

private SpdyDataFrame[] createSpdyDataFrames(int streamId,
                                             ChannelBuffer content)