AsyncResponse (Restlight :: Server

所有已知实现类:

AsyncResponseImpl
```
public interface AsyncResponse
```
An interface defines a http server response.
!Note: This response is not designed as thread-safe, but it does a special committing control that only one thread is allowed to commit this response, which means you can not commit this response by calling sendResult(int) method if another thread had committed this response(such as using the outputStream() to write data).

嵌套类概要

嵌套类
限定符和类型接口和说明

static interface AsyncResponse.EndListener
已过时。

嵌套类
限定符和类型	接口和说明
`static interface`	`AsyncResponse.EndListener` 已过时。

字段概要

字段
限定符和类型字段和说明

static int DEFAULT_BUFFER_SIZE
Default buffer size of output stream.

字段
限定符和类型	字段和说明
`static int`	`DEFAULT_BUFFER_SIZE` Default buffer size of output stream.

方法概要

所有方法实例方法抽象方法默认方法已过时的方法
限定符和类型	方法和说明
`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.
`default void`	`addEndListener(AsyncResponse.EndListener endListener)` 已过时。 use `onEnd(Consumer)`
`void`	`addHeader(CharSequence name, String value)` Adds a response header with the given name and value.
`default void`	`addHeader(String name, String value)`
`void`	`addIntHeader(CharSequence name, int value)` Adds a response header with the given name and integer value.
`default void`	`addIntHeader(String name, int value)`
`void`	`addShortHeader(CharSequence name, short value)` Adds a response header with the given name and short value.
`default void`	`addShortHeader(String name, short value)`
`void`	`addTrailer(CharSequence name, String value)` Adds a trailing header with the given name and value.
`default void`	`addTrailer(String name, String 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.
`default boolean`	`containsHeader(String name)`
`default int`	`getBufferSize()` 已过时。 use `bufferSize()`
`String`	`getHeader(CharSequence name)` Return the value for the specified header, or `null` if this header has not been set.
`default String`	`getHeader(String name)` Return the value for the specified header, or `null` if this header has not been set.
`default Collection<String>`	`getHeaderNames()` 已过时。 use `headerNames()`
`Collection<String>`	`getHeaders(CharSequence name)` Return a Collection of all the header values associated with the specified header name.
`default Collection<String>`	`getHeaders(String name)`
`default HttpOutputStream`	`getOutputStream()` 已过时。 use `outputStream()`
`default int`	`getStatus()` 已过时。 use `status()`
`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.
`default void`	`sendFile(File file)`
`default void`	`sendFile(File file, long offset)`
`void`	`sendFile(File file, long offset, long length)` Sends a file to client.
`default void`	`sendRedirect(String newUri)` Sends a temporary redirect response to the client using the given redirect uri.
`default void`	`sendResult()` This method does not modify `readerIndex` or `writerIndex` of this buffer.
`default void`	`sendResult(byte[] body)` write response
`void`	`sendResult(byte[] body, int off, int len)` Write the byte data.
`default void`	`sendResult(io.netty.buffer.ByteBuf body)` This method does not modify `readerIndex` or `writerIndex` of this buffer.
`default void`	`sendResult(io.netty.buffer.ByteBuf body, boolean autoRelease)` This method does not modify `readerIndex` or `writerIndex` of this buffer.
`default void`	`sendResult(io.netty.buffer.ByteBuf body, int off, int len)`
`void`	`sendResult(io.netty.buffer.ByteBuf body, int off, int len, boolean autoRelease)`
`default void`	`sendResult(int code)` This method does not modify `readerIndex` or `writerIndex` of this buffer.
`default void`	`sendResult(int code, byte[] body)`
`default void`	`sendResult(int code, byte[] body, int off, int len)`
`default void`	`sendResult(int code, io.netty.buffer.ByteBuf body)` This method does not modify `readerIndex` or `writerIndex` of this buffer.
`default void`	`sendResult(int code, io.netty.buffer.ByteBuf body, boolean autoRelease)` This method does not modify `readerIndex` or `writerIndex` of this buffer.
`default void`	`sendResult(int code, io.netty.buffer.ByteBuf body, int off, int len)`
`default void`	`sendResult(int code, io.netty.buffer.ByteBuf body, int off, int len, boolean autoRelease)` Write the ByteBuf data.
`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 `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.
`default void`	`setHeader(String name, String value)`
`void`	`setHeaders(CharSequence name, List<String> values)` Sets a response headers with the given name and value.
`default void`	`setHeaders(String 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.
`default void`	`setIntHeader(String name, int value)`
`void`	`setShortHeader(CharSequence name, short value)` Sets a response header with the given name and short value.
`default void`	`setShortHeader(String name, 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.
`default void`	`setTrailer(String name, String value)`
`void`	`setTrailers(CharSequence name, List<String> values)` Sets a trailing headers with the given name and value.
`default void`	`setTrailers(String name, List<String> values)`
`int`	`status()` Get current http response code.

- 字段详细资料
  - DEFAULT_BUFFER_SIZE
```
static final int DEFAULT_BUFFER_SIZE
```
    Default buffer size of output stream. It means that the chunk size of current response is also equals this value.
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - setStatus
```
void setStatus(int code)
```
    Set the response code
    
    参数:
    
    code - code
  - status
```
int status()
```
    Get current http response code.
    
    返回:
    
    status
  - isKeepAlive
```
boolean isKeepAlive()
```
    Is current request should be keepAlive mode.
    
    返回:
    
    keepalive
  - outputStream
```
HttpOutputStream outputStream()
```
    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(...)
    
    返回:
    
    output stream
  - setBufferSize
```
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 outputStream()
    advice: always set the buffer size if you have already known the length or the predication of the response data.
    
    参数:
    
    size - size
  - bufferSize
```
int bufferSize()
```
    Get the buffer size of the output stream.
    
    返回:
    
    size
  - isCommitted
```
boolean isCommitted()
```
    Is current response has been write.
    
    返回:
    
    isCommitted
  - reset
```
void reset()
```
    Reset this response to origin status, which means the values you have changed will be reset such headers, status and so on.
  - sendResult
```
void sendResult(byte[] body,
                int off,
                int len)
```
    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 outputStream() sendResult(...)}
    this function can be called only once. This method does not modify readerIndex or writerIndex of this buffer.
    
    参数:
    
    body - byte data
    
    off - off
    
    len - len
    
    抛出:
    
    IllegalStateException - if response has committed
  - sendResult
```
default void sendResult(int code,
                        byte[] body,
                        int off,
                        int len)
```
    抛出:
    
    IllegalStateException - if response has committed
    
    另请参阅:
    
    sendResult(byte[], int, int)
  - sendResult
```
default void sendResult(byte[] body)
```
    write response
    
    另请参阅:
    
    sendResult(int, byte[], int, int)
  - sendResult
```
default void sendResult(int code,
                        byte[] body)
```
    另请参阅:
    
    sendResult(int, byte[], int, int)
  - sendResult
```
default void sendResult(int code)
```
    This method does not modify readerIndex or writerIndex of this buffer.
    
    参数:
    
    code - code
    
    另请参阅:
    
    sendResult(int, byte[], int, int)
  - sendResult
```
default void sendResult()
```
    This method does not modify readerIndex or writerIndex of this buffer.
    
    另请参阅:
    
    sendResult(int, byte[], int, int)
  - sendResult
```
void sendResult(io.netty.buffer.ByteBuf body,
                int off,
                int len,
                boolean autoRelease)
```
    另请参阅:
    
    sendResult(int, ByteBuf, int, int, boolean)
  - sendResult
```
default void sendResult(int code,
                        io.netty.buffer.ByteBuf body,
                        int off,
                        int len,
                        boolean autoRelease)
```
    Write the ByteBuf 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 outputStream() sendResult(...)}
    this function can be called only once. This method does not modify readerIndex or writerIndex of this buffer.
    
    参数:
    
    code - code
    
    body - byte data
    
    off - off
    
    len - len
    
    autoRelease - is automatically release this body ByteBuf even though this method call is retuning with a Exception
    
    抛出:
    
    IllegalStateException - if response has committed
  - sendResult
```
default void sendResult(int code,
                        io.netty.buffer.ByteBuf body,
                        int off,
                        int len)
```
    另请参阅:
    
    sendResult(int, ByteBuf, int, int, boolean)
  - sendResult
```
default void sendResult(io.netty.buffer.ByteBuf body,
                        int off,
                        int len)
```
    另请参阅:
    
    sendResult(int, ByteBuf, int, int, boolean)
  - sendResult
```
default void sendResult(io.netty.buffer.ByteBuf body,
                        boolean autoRelease)
```
    This method does not modify readerIndex or writerIndex of this buffer.
    
    参数:
    
    body - body
    
    另请参阅:
    
    sendResult(int, ByteBuf, int, int)
  - sendResult
```
default void sendResult(int code,
                        io.netty.buffer.ByteBuf body,
                        boolean autoRelease)
```
    This method does not modify readerIndex or writerIndex of this buffer.
    
    参数:
    
    code - code
    
    body - body
    
    另请参阅:
    
    sendResult(int, ByteBuf, int, int)
  - sendResult
```
default void sendResult(int code,
                        io.netty.buffer.ByteBuf body)
```
    This method does not modify readerIndex or writerIndex of this buffer.
    
    参数:
    
    code - code
    
    body - body
    
    另请参阅:
    
    sendResult(int, ByteBuf, int, int)
  - sendResult
```
default void sendResult(io.netty.buffer.ByteBuf body)
```
    This method does not modify readerIndex or writerIndex of this buffer.
    
    参数:
    
    body - body
    
    另请参阅:
    
    sendResult(int, ByteBuf, int, int)
  - sendRedirect
```
default void sendRedirect(String newUri)
```
    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.
    
    参数:
    
    newUri - target uri
  - sendFile
```
default void sendFile(File file)
```
    另请参阅:
    
    sendFile(File, long, long)
  - sendFile
```
default void sendFile(File file,
                      long offset)
```
    另请参阅:
    
    sendFile(File, long, long)
  - sendFile
```
void sendFile(File file,
              long offset,
              long length)
```
    Sends a file to client.
    Note that this is an asynchronous method but we do not provides any promise or callback for user.
    
    参数:
    
    file - target file to send.
    
    offset - start index to send
    
    length - length.
  - alloc
```
@Beta
io.netty.buffer.ByteBufAllocator alloc()
```
    Get current ByteBufAllocator
    
    返回:
    
    allocator
  - getHeader
```
default String getHeader(String name)
```
    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 getHeaders(String) to retrieve all of them.
    
    参数:
    
    name - healder name
    
    返回:
    
    value
  - getHeader
```
String getHeader(CharSequence name)
```
    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 getHeaders(String) to retrieve all of them.
    
    参数:
    
    name - healder name
    
    返回:
    
    value
  - headerNames
```
Collection<String> headerNames()
```
    Get the header names set for this HTTP response.
    
    返回:
    
    names
  - getHeaders
```
Collection<String> getHeaders(CharSequence name)
```
    Return a Collection of all the header values associated with the specified header name.
    
    参数:
    
    name - header name
    
    返回:
    
    value
  - getHeaders
```
default Collection<String> getHeaders(String name)
```
    返回:
    
    value
    
    另请参阅:
    
    getHeaders(CharSequence)
  - containsHeader
```
boolean containsHeader(CharSequence name)
```
    Returns a boolean indicating whether the named response header has already been set.
    
    参数:
    
    name - name
    
    返回:
    
    is contains
  - containsHeader
```
default boolean containsHeader(String name)
```
    另请参阅:
    
    containsHeader(CharSequence)
  - addHeader
```
void addHeader(CharSequence name,
               String value)
```
    Adds a response header with the given name and value. This method allows response headers to have multiple values.
    
    参数:
    
    name - header name
    
    value - value
  - addHeader
```
default void addHeader(String name,
                       String value)
```
    另请参阅:
    
    addHeader(CharSequence, String)
  - setHeader
```
void setHeader(CharSequence name,
               String value)
```
    Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one.
    
    参数:
    
    name - name
    
    value - value
  - setHeader
```
default void setHeader(String name,
                       String value)
```
    另请参阅:
    
    setHeader(CharSequence, String)
  - setHeaders
```
void setHeaders(CharSequence name,
                List<String> values)
```
    Sets a response headers with the given name and value.
    
    参数:
    
    name - name
    
    values - values
  - setHeaders
```
default void setHeaders(String name,
                        List<String> values)
```
    Sets a response headers with the given name and value.
    
    参数:
    
    name - name
    
    values - values
  - setIntHeader
```
void setIntHeader(CharSequence name,
                  int value)
```
    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.
    
    参数:
    
    name - name
    
    value - value
  - setIntHeader
```
default void setIntHeader(String name,
                          int value)
```
    另请参阅:
    
    setIntHeader(CharSequence, int)
  - addIntHeader
```
void addIntHeader(CharSequence name,
                  int value)
```
    Adds a response header with the given name and integer value. This method allows response headers to have multiple values.
    
    参数:
    
    name - name
    
    value - value
  - addIntHeader
```
default void addIntHeader(String name,
                          int value)
```
    另请参阅:
    
    addIntHeader(CharSequence, int)
  - setShortHeader
```
void setShortHeader(CharSequence name,
                    short value)
```
    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.
    
    参数:
    
    name - name
    
    value - value
  - setShortHeader
```
default void setShortHeader(String name,
                            short value)
```
    另请参阅:
    
    setShortHeader(CharSequence, short)
  - addShortHeader
```
void addShortHeader(CharSequence name,
                    short value)
```
    Adds a response header with the given name and short value. This method allows response headers to have multiple values.
    
    参数:
    
    name - name
    
    value - value
  - addShortHeader
```
default void addShortHeader(String name,
                            short value)
```
    另请参阅:
    
    addShortHeader(CharSequence, short)
  - addTrailer
```
void addTrailer(CharSequence name,
                String value)
```
    Adds a trailing header with the given name and value. This method allows response headers to have multiple values.
    
    参数:
    
    name - name
    
    value - value
  - addTrailer
```
default void addTrailer(String name,
                        String value)
```
    另请参阅:
    
    addTrailer(CharSequence, String)
  - setTrailer
```
void setTrailer(CharSequence name,
                String value)
```
    Sets a trailing header with the given name and value. If the header had already been set, the new value overwrites the previous one.
    
    参数:
    
    name - name
    
    value - value
  - setTrailer
```
default void setTrailer(String name,
                        String value)
```
    另请参阅:
    
    setTrailer(CharSequence, String)
  - setTrailers
```
void setTrailers(CharSequence name,
                 List<String> values)
```
    Sets a trailing headers with the given name and value.
    
    参数:
    
    name - name
    
    values - values
  - setTrailers
```
default void setTrailers(String name,
                         List<String> values)
```
    另请参阅:
    
    setTrailers(CharSequence, List)
  - addCookie
```
void addCookie(io.netty.handler.codec.http.cookie.Cookie cookie)
```
    Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.
    
    参数:
    
    cookie - the Cookie to return to the client
  - addCookie
```
void addCookie(String name,
               String value)
```
    Adds the specified cookie to the response. This method can be called multiple times to set more than one cookie.
    
    参数:
    
    name - cookie name
    
    value - value
  - onEnd
```
void onEnd(Consumer<AsyncResponse> listener)
```
    Add a listener to this response, this listener will be called after current response has been write.
    
    参数:
    
    listener - listener
  - addEndListener
```
@Deprecated
default void addEndListener(AsyncResponse.EndListener endListener)
```
    已过时。 use onEnd(Consumer)
    
    Add a listener to this response, this listener will be called after current response has been write.
    
    参数:
    
    endListener - listener
  - getStatus
```
@Deprecated
default int getStatus()
```
    已过时。 use status()
    
    Get current http response code.
    
    返回:
    
    status
  - getOutputStream
```
@Deprecated
default HttpOutputStream getOutputStream()
```
    已过时。 use outputStream()
    
    返回:
    
    output stream
  - getBufferSize
```
@Deprecated
default int getBufferSize()
```
    已过时。 use bufferSize()
  - getHeaderNames
```
@Deprecated
default Collection<String> getHeaderNames()
```
    已过时。 use headerNames()
    
    返回:
    
    names

接口 AsyncResponse

嵌套类概要

字段概要

方法概要

字段详细资料

DEFAULT_BUFFER_SIZE

方法详细资料

setStatus

status

isKeepAlive

outputStream

setBufferSize

bufferSize

isCommitted

reset

sendResult

sendResult

sendResult

sendResult

sendResult

sendResult

sendResult

sendResult

sendResult

sendResult

sendResult

sendResult

sendResult

sendResult

sendRedirect

sendFile

sendFile

sendFile

alloc

getHeader

getHeader

headerNames

getHeaders

getHeaders

containsHeader

containsHeader

addHeader

addHeader

setHeader

setHeader

setHeaders

setHeaders

setIntHeader

setIntHeader

addIntHeader

addIntHeader

setShortHeader

setShortHeader

addShortHeader

addShortHeader

addTrailer

addTrailer

setTrailer

setTrailer

setTrailers

setTrailers

addCookie

addCookie

onEnd

addEndListener

getStatus

getOutputStream

getBufferSize

getHeaderNames