org.cauli.server.netty

类 NettyHttpResponse

java.lang.Object

org.cauli.server.netty.NettyHttpResponse

所有已实现的接口:

HttpResponse

public class NettyHttpResponse
extends Object
implements HttpResponse

字段概要

字段

限定符和类型	字段和说明
private Charset	charset
private org.jboss.netty.channel.ChannelHandlerContext	ctx
private static Charset	DEFAULT_CHARSET
private Thread.UncaughtExceptionHandler	exceptionHandler
private boolean	isKeepAlive
private org.jboss.netty.handler.codec.http.HttpResponse	response
private org.jboss.netty.buffer.ChannelBuffer	responseBuffer

构造器概要

构造器

构造器和说明
NettyHttpResponse(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.handler.codec.http.HttpResponse response, boolean isKeepAlive, Thread.UncaughtExceptionHandler exceptionHandler)

方法概要

方法

限定符和类型	方法和说明
Charset	charset() Current Charset used to encode to response as.
NettyHttpResponse	charset(Charset charset) For text based responses, sets the Charset to encode the response as.
NettyHttpResponse	chunked() Turns the response into a chunked response after this method is called, HttpResponse.write(String) should be used to send chunks
boolean	containsHeader(String name) Test to see if this response has a header of the specified name
NettyHttpResponse	content(byte[] content) Write binary based content back to the client.
NettyHttpResponse	content(ByteBuffer buffer) Write binary based content back to the client.
private NettyHttpResponse	content(org.jboss.netty.buffer.ChannelBuffer content)
NettyHttpResponse	content(String content) Write text based content back to the client.
NettyHttpResponse	cookie(HttpCookie httpCookie) Adds a cookie
NettyHttpResponse	end() Marks the response as ended.
NettyHttpResponse	error(Throwable error) Marks the response as erroneous.
private void	flushResponse()
private String	getStackTrace(Throwable error)
NettyHttpResponse	header(String name, Date value) Adds a Date (RFC 1123 format) HTTP header.
NettyHttpResponse	header(String name, long value) Adds a numeric HTTP header.
NettyHttpResponse	header(String name, String value) Adds an HTTP header.
int	status() Retrieve HTTP status code that this response is going to return.
NettyHttpResponse	status(int status) Sets the HTTP status code.
private org.jboss.netty.channel.ChannelFuture	write(org.jboss.netty.buffer.ChannelBuffer responseBuffer)
NettyHttpResponse	write(String content) Writes immediately to the client without closing the connection.

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

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

字段详细资料

DEFAULT_CHARSET

private static final Charset DEFAULT_CHARSET

ctx

private final org.jboss.netty.channel.ChannelHandlerContext ctx

response

private final org.jboss.netty.handler.codec.http.HttpResponse response

isKeepAlive

private final boolean isKeepAlive

exceptionHandler

private final Thread.UncaughtExceptionHandler exceptionHandler

responseBuffer

private final org.jboss.netty.buffer.ChannelBuffer responseBuffer

charset

private Charset charset

构造器详细资料

NettyHttpResponse

public NettyHttpResponse(org.jboss.netty.channel.ChannelHandlerContext ctx,
                 org.jboss.netty.handler.codec.http.HttpResponse response,
                 boolean isKeepAlive,
                 Thread.UncaughtExceptionHandler exceptionHandler)

方法详细资料

charset

public NettyHttpResponse charset(Charset charset)

从接口复制的说明: HttpResponse

For text based responses, sets the Charset to encode the response as.

If not set, defaults to UTF8.

指定者:

charset 在接口中 HttpResponse

charset

public Charset charset()

从接口复制的说明: HttpResponse

Current Charset used to encode to response as.

指定者:

charset 在接口中 HttpResponse

另请参阅:

HttpResponse.charset(java.nio.charset.Charset)

status

public NettyHttpResponse status(int status)

从接口复制的说明: HttpResponse

Sets the HTTP status code.

Defaults to 200 (OK).

指定者:

status 在接口中 HttpResponse

chunked

public NettyHttpResponse chunked()

从接口复制的说明: HttpResponse

Turns the response into a chunked response

after this method is called, HttpResponse.write(String) should be used to send chunks

指定者:

chunked 在接口中 HttpResponse

status

public int status()

从接口复制的说明: HttpResponse

Retrieve HTTP status code that this response is going to return.

指定者:

status 在接口中 HttpResponse

另请参阅:

HttpResponse.status(int)

header

public NettyHttpResponse header(String name,
                       String value)

从接口复制的说明: HttpResponse

Adds an HTTP header. Multiple HTTP headers can be added with the same name.

指定者:

header 在接口中 HttpResponse

header

public NettyHttpResponse header(String name,
                       long value)

从接口复制的说明: HttpResponse

Adds a numeric HTTP header. Multiple HTTP headers can be added with the same name.

指定者:

header 在接口中 HttpResponse

header

public NettyHttpResponse header(String name,
                       Date value)

从接口复制的说明: HttpResponse

Adds a Date (RFC 1123 format) HTTP header. Multiple HTTP headers can be added with the same name.

指定者:

header 在接口中 HttpResponse

containsHeader

public boolean containsHeader(String name)

从接口复制的说明: HttpResponse

Test to see if this response has a header of the specified name

指定者:

containsHeader 在接口中 HttpResponse

cookie

public NettyHttpResponse cookie(HttpCookie httpCookie)

从接口复制的说明: HttpResponse

Adds a cookie

指定者:

cookie 在接口中 HttpResponse

参数:

httpCookie - the cookie

content

public NettyHttpResponse content(String content)

从接口复制的说明: HttpResponse

Write text based content back to the client.

指定者:

content 在接口中 HttpResponse

另请参阅:

HttpResponse.charset(java.nio.charset.Charset), HttpResponse.content(byte[])

content

public NettyHttpResponse content(byte[] content)

从接口复制的说明: HttpResponse

Write binary based content back to the client.

指定者:

content 在接口中 HttpResponse

另请参阅:

HttpResponse.content(String)

content

public NettyHttpResponse content(ByteBuffer buffer)

从接口复制的说明: HttpResponse

Write binary based content back to the client.

指定者:

content 在接口中 HttpResponse

另请参阅:

HttpResponse.content(String)

content

private NettyHttpResponse content(org.jboss.netty.buffer.ChannelBuffer content)

write

public NettyHttpResponse write(String content)

从接口复制的说明: HttpResponse

Writes immediately to the client without closing the connection. (The HttpResponse.content(String) method caches content until HttpResponse.end() is called()

TODO: Make content write immediately instead and remove this method?

指定者:

write 在接口中 HttpResponse

参数:

content - what to write

error

public NettyHttpResponse error(Throwable error)

从接口复制的说明: HttpResponse

Marks the response as erroneous. The error shall be displayed to the user (500 SERVER ERROR) and the connection closed.

Every response should have either HttpResponse.end() or HttpResponse.error(Throwable) called. No more operations should be performed on a response after these.

指定者:

error 在接口中 HttpResponse

getStackTrace

private String getStackTrace(Throwable error)

end

public NettyHttpResponse end()

从接口复制的说明: HttpResponse

Marks the response as ended. At this point any remaining data shall be flushed and the connection closed.

Every response should have either HttpResponse.end() or HttpResponse.error(Throwable) called. No more operations should be performed on a response after these.

指定者:

end 在接口中 HttpResponse

flushResponse

private void flushResponse()

write

private org.jboss.netty.channel.ChannelFuture write(org.jboss.netty.buffer.ChannelBuffer responseBuffer)