esa.httpserver.core

接口 Response

public interface Response

An interface defines a http server response.

!Note: It would be uncompleted state which means current Response haven't been completely written(eg. only part of the body is written, and waiting to write the left.) and it could be indicated by the return value of isCommitted() isEnded().

Also, you should know that this response is not designed 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 write(byte[]) or end(byte[]) method if another thread had committed this response(such as calling the write(byte[]) method).

方法概要

限定符和类型	方法和说明
Response	addCookie(esa.commons.http.Cookie cookie) Adds the specified cookie to the response.
Response	addCookie(String name, String value) Adds the specified cookie to the response.
io.netty.buffer.ByteBufAllocator	alloc() Get current allocator.
default io.netty.util.concurrent.Future<Void>	end() Ends current response.
default io.netty.util.concurrent.Future<Void>	end(byte[] data)
default io.netty.util.concurrent.Future<Void>	end(byte[] data, int offset)
io.netty.util.concurrent.Future<Void>	end(byte[] data, int offset, int length) Ends current response with writing given data to the remote.
io.netty.util.concurrent.Future<Void>	end(io.netty.buffer.ByteBuf data) Ends current response with writing given data to the remote.
io.netty.util.concurrent.Future<Void>	endFuture() Returns the Future which is notified when the response is ended.
esa.commons.http.HttpHeaders	headers() Returns the headers of this response.
boolean	isCommitted() Is current response has been write.
boolean	isEnded() Is current response has been write.
boolean	isKeepAlive() Whether response will be written as keepalive on current connection or stream(depends on the version of http protocol)
boolean	isWritable() Returns whether the extra response data is writable.
io.netty.util.concurrent.Future<Void>	onEndFuture() Returns the Future which is notified when the response is about to ending.
default io.netty.util.concurrent.Future<Void>	sendFile(File file)
default io.netty.util.concurrent.Future<Void>	sendFile(File file, long offset)
io.netty.util.concurrent.Future<Void>	sendFile(File file, long offset, long length) Sends a file to client.
default io.netty.util.concurrent.Future<Void>	sendRedirect(String newUri) Sends a temporary redirect response to the client using the given redirect uri.
Response	setStatus(int code) Set the response code
int	status() Get current http response code.
esa.commons.http.HttpHeaders	trailers() Returns the trailing headers of this message.
default io.netty.util.concurrent.Future<Void>	write(byte[] data)
default io.netty.util.concurrent.Future<Void>	write(byte[] data, int offset)
io.netty.util.concurrent.Future<Void>	write(byte[] data, int offset, int length) Writes some data to the remote.
io.netty.util.concurrent.Future<Void>	write(io.netty.buffer.ByteBuf data) Writes some data to the remote.

方法详细资料

status

int status()

Get current http response code.

返回:

status

setStatus

Response setStatus(int code)

Set the response code

参数:

code - code

返回:

this

headers

esa.commons.http.HttpHeaders headers()

Returns the headers of this response.

返回:

headers

trailers

esa.commons.http.HttpHeaders trailers()

Returns the trailing headers of this message.

返回:

trailers

addCookie

Response addCookie(esa.commons.http.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

返回:

this

addCookie

Response 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

返回:

this

isKeepAlive

boolean isKeepAlive()

Whether response will be written as keepalive on current connection or stream(depends on the version of http protocol)

返回:

isKeepAlive

write

default io.netty.util.concurrent.Future<Void> write(byte[] data)

另请参阅:

write(byte[], int, int)

write

default io.netty.util.concurrent.Future<Void> write(byte[] data,
                                                    int offset)

另请参阅:

write(byte[], int, int)

write

io.netty.util.concurrent.Future<Void> write(byte[] data,
                                            int offset,
                                            int length)

Writes some data to the remote.

You may need to check the result of isWritable() before writing.

参数:

data - data to write

offset - offset

length - length

返回:

future

write

io.netty.util.concurrent.Future<Void> write(io.netty.buffer.ByteBuf data)

Writes some data to the remote.

You may need to check the result of isWritable() before writing.

!Note: It is recommended to use this method in current channel event loop, because of the complexity of the ByteBuf allocation/deallocation

参数:

data - data to write

返回:

future

end

default io.netty.util.concurrent.Future<Void> end(byte[] data)

另请参阅:

end(byte[], int, int)

end

default io.netty.util.concurrent.Future<Void> end(byte[] data,
                                                  int offset)

另请参阅:

end(byte[], int, int)

end

io.netty.util.concurrent.Future<Void> end(byte[] data,
                                          int offset,
                                          int length)

Ends current response with writing given data to the remote.

You may need to check the result of isWritable() before writing.

参数:

data - data to write

offset - offset

length - length

返回:

future

end

default io.netty.util.concurrent.Future<Void> end()

Ends current response.

You may need to check the result of isWritable() before writing.

返回:

future

end

io.netty.util.concurrent.Future<Void> end(io.netty.buffer.ByteBuf data)

Ends current response with writing given data to the remote.

You may need to check the result of isWritable() before writing.

!Note: It is recommended to use this method in current channel event loop, because of the complexity of the ByteBuf allocation/deallocation

参数:

data - data to write

返回:

future

sendRedirect

default io.netty.util.concurrent.Future<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

返回:

future

sendFile

default io.netty.util.concurrent.Future<Void> sendFile(File file)

另请参阅:

sendFile(File, long, long)

sendFile

default io.netty.util.concurrent.Future<Void> sendFile(File file,
                                                       long offset)

另请参阅:

sendFile(File, long, long)

sendFile

io.netty.util.concurrent.Future<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.

isWritable

boolean isWritable()

Returns whether the extra response data is writable.

返回:

true if extra response data is writable, otherwise false

isCommitted

boolean isCommitted()

Is current response has been write.

返回:

isCommitted

isEnded

boolean isEnded()

Is current response has been write.

返回:

isCommitted

onEndFuture

io.netty.util.concurrent.Future<Void> onEndFuture()

Returns the Future which is notified when the response is about to ending.

返回:

future

endFuture

io.netty.util.concurrent.Future<Void> endFuture()

Returns the Future which is notified when the response is ended.

返回:

future

alloc

@Beta
io.netty.buffer.ByteBufAllocator alloc()

Get current allocator.

返回:

allocator