esa.httpserver.impl

类 AsyncResponseImpl

java.lang.Object

esa.httpserver.impl.AsyncResponseImpl

所有已实现的接口:

AsyncResponse

@Internal
public class AsyncResponseImpl
extends Object
implements AsyncResponse

Default implementation of AsyncResponse that wraps the Response as delegate.

嵌套类概要

从接口继承的嵌套类/接口 esa.httpserver.core.AsyncResponse

AsyncResponse.EndListener

字段概要

从接口继承的字段 esa.httpserver.core.AsyncResponse

DEFAULT_BUFFER_SIZE

构造器概要

构造器

构造器和说明
AsyncResponseImpl(esa.httpserver.core.Response res)

方法概要

限定符和类型	方法和说明
void	addCookie(io.netty.handler.codec.http.cookie.Cookie cookie) Adds the specified cookie to the response.
void	addCookie(String name, String value) Adds the specified cookie to the response.
void	addHeader(CharSequence name, String value) Adds a response header with the given name and value.
void	addIntHeader(CharSequence name, int value) Adds a response header with the given name and integer value.
void	addShortHeader(CharSequence name, short value) Adds a response header with the given name and short value.
void	addTrailer(CharSequence name, String value) Adds a trailing header with the given name and value.
io.netty.buffer.ByteBufAllocator	alloc() Get current ByteBufAllocator
int	bufferSize() Get the buffer size of the output stream.
boolean	containsHeader(CharSequence name) Returns a boolean indicating whether the named response header has already been set.
String	getHeader(CharSequence name) Return the value for the specified header, or null if this header has not been set.
Collection<String>	getHeaders(CharSequence name) Return a Collection of all the header values associated with the specified header name.
Collection<String>	headerNames() Get the header names set for this HTTP response.
boolean	isCommitted() Is current response has been write.
boolean	isKeepAlive() Is current request should be keepAlive mode.
void	onEnd(Consumer<AsyncResponse> listener) Add a listener to this response, this listener will be called after current response has been write.
HttpOutputStream	outputStream() Get output stream of this response.
void	reset() Reset this response to origin status, which means the values you have changed will be reset such headers, status and so on.
void	sendFile(File file, long offset, long length) Sends a file to client.
void	sendRedirect(String newUri) Sends a temporary redirect response to the client using the given redirect uri.
void	sendResult(byte[] body) write response
void	sendResult(byte[] body, int off, int len) Write the byte data.
void	sendResult(io.netty.buffer.ByteBuf body, boolean autoRelease) This method does not modify readerIndex or writerIndex of this buffer.
void	sendResult(io.netty.buffer.ByteBuf body, int off, int len, boolean autoRelease)
void	setBufferSize(int size) Set buffer size of the output stream. it will not be effective unless current output stream is null, which means you'd better call this function before AsyncResponse.outputStream() advice: always set the buffer size if you have already known the length or the predication of the response data.
void	setHeader(CharSequence name, String value) Sets a response header with the given name and value.
void	setHeaders(CharSequence name, List<String> values) Sets a response headers with the given name and value.
void	setIntHeader(CharSequence name, int value) Sets a response header with the given name and integer value.
void	setShortHeader(CharSequence name, short value) Sets a response header with the given name and short value.
void	setStatus(int code) Set the response code
void	setTrailer(CharSequence name, String value) Sets a trailing header with the given name and value.
void	setTrailers(CharSequence name, List<String> values) Sets a trailing headers with the given name and value.
int	status() Get current http response code.
String	toString()

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

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

从接口继承的方法 esa.httpserver.core.AsyncResponse

addEndListener, addHeader, addIntHeader, addShortHeader, addTrailer, containsHeader, getBufferSize, getHeader, getHeaderNames, getHeaders, getOutputStream, getStatus, sendFile, sendFile, sendResult, sendResult, sendResult, sendResult, sendResult, sendResult, sendResult, sendResult, sendResult, sendResult, setHeader, setHeaders, setIntHeader, setShortHeader, setTrailer, setTrailers

构造器详细资料

AsyncResponseImpl

public AsyncResponseImpl(esa.httpserver.core.Response res)

方法详细资料

setStatus

public void setStatus(int code)

从接口复制的说明: AsyncResponse

Set the response code

指定者:

setStatus 在接口中 AsyncResponse

参数:

code - code

status

public int status()

从接口复制的说明: AsyncResponse

Get current http response code.

指定者:

status 在接口中 AsyncResponse

返回:

status

isKeepAlive

public boolean isKeepAlive()

从接口复制的说明: AsyncResponse

Is current request should be keepAlive mode.

指定者:

isKeepAlive 在接口中 AsyncResponse

返回:

keepalive

outputStream

public HttpOutputStream outputStream()

从接口复制的说明: AsyncResponse

Get output stream of this response. Create a new implementation of HttpOutputStream if it is null

Note: Once you have called this function you should use this output stream to write your response data rather than using other method such as sendResult(...)

指定者:

outputStream 在接口中 AsyncResponse

返回:

output stream

setBufferSize

public void setBufferSize(int size)

从接口复制的说明: AsyncResponse

Set buffer size of the output stream. it will not be effective unless current output stream is null, which means you'd better call this function before AsyncResponse.outputStream()

advice: always set the buffer size if you have already known the length or the predication of the response data.

指定者:

setBufferSize 在接口中 AsyncResponse

参数:

size - size

bufferSize

public int bufferSize()

从接口复制的说明: AsyncResponse

Get the buffer size of the output stream.

指定者:

bufferSize 在接口中 AsyncResponse

返回:

size

isCommitted

public boolean isCommitted()

从接口复制的说明: AsyncResponse

Is current response has been write.

指定者:

isCommitted 在接口中 AsyncResponse

返回:

isCommitted

reset

public void reset()

从接口复制的说明: AsyncResponse

Reset this response to origin status, which means the values you have changed will be reset such headers, status and so on.

指定者:

reset 在接口中 AsyncResponse

sendResult

public void sendResult(byte[] body,
                       int off,
                       int len)

从接口复制的说明: AsyncResponse

Write the byte data.

Note: Once you have called this function you should use this method call to write your response data rather than using other method such as AsyncResponse.outputStream() sendResult(...)}

this function can be called only once. This method does not modify readerIndex or writerIndex of this buffer.

指定者:

sendResult 在接口中 AsyncResponse

参数:

body - byte data

off - off

len - len

sendResult

public void sendResult(byte[] body)

从接口复制的说明: AsyncResponse

write response

指定者:

sendResult 在接口中 AsyncResponse

另请参阅:

AsyncResponse.sendResult(int, byte[], int, int)

sendResult

public void sendResult(io.netty.buffer.ByteBuf body,
                       boolean autoRelease)

从接口复制的说明: AsyncResponse

This method does not modify readerIndex or writerIndex of this buffer.

指定者:

sendResult 在接口中 AsyncResponse

参数:

body - body

另请参阅:

AsyncResponse.sendResult(int, ByteBuf, int, int)

sendResult

public void sendResult(io.netty.buffer.ByteBuf body,
                       int off,
                       int len,
                       boolean autoRelease)

指定者:

sendResult 在接口中 AsyncResponse

另请参阅:

AsyncResponse.sendResult(int, ByteBuf, int, int, boolean)

sendFile

public void sendFile(File file,
                     long offset,
                     long length)

从接口复制的说明: AsyncResponse

Sends a file to client.

Note that this is an asynchronous method but we do not provides any promise or callback for user.

指定者:

sendFile 在接口中 AsyncResponse

参数:

file - target file to send.

offset - start index to send

length - length.

sendRedirect

public void sendRedirect(String newUri)

从接口复制的说明: AsyncResponse

Sends a temporary redirect response to the client using the given redirect uri.

If the new url is relative without a leading '/' it will be regarded as a relative path to the current request URI. otherwise it will be regarded as a relative path to root path.

指定者:

sendRedirect 在接口中 AsyncResponse

参数:

newUri - target uri

alloc

public io.netty.buffer.ByteBufAllocator alloc()

从接口复制的说明: AsyncResponse

Get current ByteBufAllocator

指定者:

alloc 在接口中 AsyncResponse

返回:

allocator

getHeader

public String getHeader(CharSequence name)

从接口复制的说明: AsyncResponse

Return the value for the specified header, or null if this header has not been set. If more than one value was added for this name, only the first is returned; use AsyncResponse.getHeaders(String) to retrieve all of them.

指定者:

getHeader 在接口中 AsyncResponse

参数:

name - healder name

返回:

value

headerNames

public Collection<String> headerNames()

从接口复制的说明: AsyncResponse

Get the header names set for this HTTP response.

指定者:

headerNames 在接口中 AsyncResponse

返回:

names

getHeaders

public Collection<String> getHeaders(CharSequence name)

从接口复制的说明: AsyncResponse

Return a Collection of all the header values associated with the specified header name.

指定者:

getHeaders 在接口中 AsyncResponse

参数:

name - header name

返回:

value

containsHeader

public boolean containsHeader(CharSequence name)

从接口复制的说明: AsyncResponse

Returns a boolean indicating whether the named response header has already been set.

指定者:

containsHeader 在接口中 AsyncResponse

参数:

name - name

返回:

is contains

addHeader

public void addHeader(CharSequence name,
                      String value)

从接口复制的说明: AsyncResponse

Adds a response header with the given name and value. This method allows response headers to have multiple values.

指定者:

addHeader 在接口中 AsyncResponse

参数:

name - header name

value - value

setHeader

public void setHeader(CharSequence name,
                      String value)

从接口复制的说明: AsyncResponse

Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one.

指定者:

setHeader 在接口中 AsyncResponse

参数:

name - name

value - value

setHeaders

public void setHeaders(CharSequence name,
                       List<String> values)

从接口复制的说明: AsyncResponse

Sets a response headers with the given name and value.

指定者:

setHeaders 在接口中 AsyncResponse

参数:

name - name

values - values

setIntHeader

public void setIntHeader(CharSequence name,
                         int value)

从接口复制的说明: AsyncResponse

Sets a response header with the given name and integer value. If the header had already been set, the new value overwrites the previous one.

指定者:

setIntHeader 在接口中 AsyncResponse

参数:

name - name

value - value

addIntHeader

public void addIntHeader(CharSequence name,
                         int value)

从接口复制的说明: AsyncResponse

Adds a response header with the given name and integer value. This method allows response headers to have multiple values.

指定者:

addIntHeader 在接口中 AsyncResponse

参数:

name - name

value - value

setShortHeader

public void setShortHeader(CharSequence name,
                           short value)

从接口复制的说明: AsyncResponse

Sets a response header with the given name and short value. If the header had already been set, the new value overwrites the previous one.

指定者:

setShortHeader 在接口中 AsyncResponse

参数:

name - name

value - value

addShortHeader

public void addShortHeader(CharSequence name,
                           short value)

从接口复制的说明: AsyncResponse

Adds a response header with the given name and short value. This method allows response headers to have multiple values.

指定者:

addShortHeader 在接口中 AsyncResponse

参数:

name - name

value - value

addTrailer

public void addTrailer(CharSequence name,
                       String value)

从接口复制的说明: AsyncResponse

Adds a trailing header with the given name and value. This method allows response headers to have multiple values.

指定者:

addTrailer 在接口中 AsyncResponse

参数:

name - name

value - value

setTrailer

public void setTrailer(CharSequence name,
                       String value)

从接口复制的说明: AsyncResponse

Sets a trailing header with the given name and value. If the header had already been set, the new value overwrites the previous one.

指定者:

setTrailer 在接口中 AsyncResponse

参数:

name - name

value - value

setTrailers

public void setTrailers(CharSequence name,
                        List<String> values)

从接口复制的说明: AsyncResponse

Sets a trailing headers with the given name and value.

指定者:

setTrailers 在接口中 AsyncResponse

参数:

name - name

values - values

addCookie

public void addCookie(io.netty.handler.codec.http.cookie.Cookie cookie)

从接口复制的说明: AsyncResponse

Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.

指定者:

addCookie 在接口中 AsyncResponse

参数:

cookie - the Cookie to return to the client

addCookie

public void addCookie(String name,
                      String value)

从接口复制的说明: AsyncResponse

Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.

指定者:

addCookie 在接口中 AsyncResponse

参数:

name - cookie name

value - value

onEnd

public void onEnd(Consumer<AsyncResponse> listener)

从接口复制的说明: AsyncResponse

Add a listener to this response, this listener will be called after current response has been write.

指定者:

onEnd 在接口中 AsyncResponse

参数:

listener - listener

toString

public String toString()

覆盖:

toString 在类中 Object