io.apigee.trireme.net.spi

Interface HttpResponseAdapter

All Superinterfaces:

HttpMessageAdapter

public interface HttpResponseAdapter
extends HttpMessageAdapter

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroy the request prematurely -- this is not required unless there is a problem on the response side.
void	fatalError(String message, String stack) A fatal error occurred while processing the associated request.
int	getStatusCode()
void	send(boolean lastChunk, IOCompletionHandler<Integer> cb) Send the headers, and optionally the data if the data was already set on this object.
void	sendChunk(ByteBuffer data, boolean lastChunk, IOCompletionHandler<Integer> cb) Send just a chunk of data.
void	setStatusCode(int code)
void	setTrailer(String name, String value) Add a trailer -- only valid on a chunked message and sent on the last chunk.

Methods inherited from interface io.apigee.trireme.net.spi.HttpMessageAdapter

addHeader, containsHeader, getClientAttachment, getData, getHeader, getHeaders, getHeaders, getLocalAddress, getLocalPort, getMajorVersion, getMinorVersion, getRemoteAddress, getRemotePort, getScriptObject, hasData, isLocalIPv6, isSelfContained, removeHeader, setClientAttachment, setData, setHeader, setScriptObject, setVersion

Method Detail

getStatusCode

int getStatusCode()

setStatusCode

void setStatusCode(int code)

send

void send(boolean lastChunk,
        IOCompletionHandler<Integer> cb)

Send the headers, and optionally the data if the data was already set on this object. Return true if the I/O completed right away. If "cb" is not null, then the caller must call it once the data has been written to the network. If "cb" is null, then ignore it.

sendChunk

void sendChunk(ByteBuffer data,
             boolean lastChunk,
             IOCompletionHandler<Integer> cb)

Send just a chunk of data. If "send" was not called first, then the behavior is undefined. Return true if the I/O completed right away. If "cb" is not null, then the caller must call it once the data has been written to the network.

fatalError

void fatalError(String message,
              String stack)

A fatal error occurred while processing the associated request. The adapter should respond with an error.

Parameters:

message - the error message generated by the script

stack - if available, the JavaScript stack trace, otherwise null

setTrailer

void setTrailer(String name,
              String value)

Add a trailer -- only valid on a chunked message and sent on the last chunk.

destroy

void destroy()

Destroy the request prematurely -- this is not required unless there is a problem on the response side.