Upstream

Represents the pre-processing of a request. More...

Typedefs
typedef Function< void(HttpResponse &response, const Buffer &inBuffer, Buffer &outBuffer)>	bref::Pipeline::PostReceiveRequestHandler
	A hook called upon reading data on the socket.
typedef Function < PostReceiveRequestHandler(const Environment &environment)>	bref::Pipeline::PostReceiveHook
	Generate a Pipeline::PostRequestHandler.
typedef Function < Buffer::const_iterator(HttpResponse &response, const Buffer &buff, HttpRequest &request)>	bref::Pipeline::ParsingRequestHandler
	The handler called to generate an HttpRequest.
typedef Function < ParsingRequestHandler(Environment &)>	bref::Pipeline::ParsingHook
	Generate a Pipeline::ParsingRequestHandler.
typedef Function< void(HttpResponse &response)>	bref::Pipeline::PostParsingRequestHandler
	Handler called once the request is parsed.
typedef Function < PostParsingRequestHandler(const Environment &environment, HttpRequest &httpRequest, HttpResponse &response)>	bref::Pipeline::PostParsingHook
	Generate a Pipeline::PostParsingRequestHandler.
Variables
std::list< std::pair < PostReceiveHook, float > >	bref::Pipeline::postReceiveHooks
	List of post-read hooks.
std::list< std::pair < ParsingHook, float > >	bref::Pipeline::parsingHooks
	List of parsing hooks.
std::list< std::pair < PostParsingHook, float > >	bref::Pipeline::postParsingHooks
	List of post-parsing hooks.

---

Detailed Description

Represents the pre-processing of a request.

The upstream handles each stage of a request before the Bridge. It performs the parsing of the request and provides a few hooks before and after this step.

---

Typedef Documentation

typedef Function<ParsingRequestHandler (Environment &)> bref::Pipeline::ParsingHook

Generate a Pipeline::ParsingRequestHandler.

Returns:

An empty Pipeline::ParsingRequestHandler when the hook can not process the request, a valid handler otherwise.

See also:

parsingHooks, ParsingRequestHandler

typedef Function<Buffer::const_iterator (HttpResponse & response, const Buffer & buff, HttpRequest & request)> bref::Pipeline::ParsingRequestHandler

The handler called to generate an HttpRequest.

It parses raw data received on the socket and converts it into a structured HttpRequest.

Parameters:

[out]	response	Can be filled with the header of the response and a status code.
[in]	buff	A chunk of raw data.
[out]	request	The HttpRequest to fill with the content of the request.

Returns:

A pointer to the consumed part of the buffer. If the parser finds the "\r\n\r\n" sequence in the middle of the buffer it will return an iterator to the character after the last '
', otherwise an iterator to the beginning of buffer should be returned.

Return values:

buff.begin()

If the parser has not finished the parsing yet.

See also:

parsingHooks, ParsingHook

typedef Function<PostParsingRequestHandler (const Environment & environment, HttpRequest & httpRequest, HttpResponse & response)> bref::Pipeline::PostParsingHook

Generate a Pipeline::PostParsingRequestHandler.

Parameters:

[in]	environment	The environment of the request.
[out]	httpRequest	The HttpRequest to fill with the request header.

Returns:

An empty Pipeline::PostParsingRequestHandler if the hook can not process the request, otherwise a valid handler.

See also:

postParsingHooks, PostParsingRequestHandler

typedef Function<void (HttpResponse & response)> bref::Pipeline::PostParsingRequestHandler

Handler called once the request is parsed.

This hook point can be used for an URL rewrite module for example.

Parameters:

[out]

response

Can be filled with the response header and a status code.

See also:

postParsingHooks, PostParsingHook

typedef Function<PostReceiveRequestHandler (const Environment & environment)> bref::Pipeline::PostReceiveHook

Generate a Pipeline::PostRequestHandler.

Parameters:

[in]

environment

The environment of the request.

Returns:

An empty Pipeline::PostRequestHandler if the hook can not process the request, a valid handler otherwise.

See also:

postReceiveHooks, PostReceiveRequestHandler

typedef Function<void (HttpResponse & response, const Buffer & inBuffer, Buffer & outBuffer)> bref::Pipeline::PostReceiveRequestHandler

A hook called upon reading data on the socket.

This hook is able to transform data received by the socket before it is sent to the parser.

Parameters:

[out]	response	Can be filled with the header of the response and a status code.
[in]	inBuffer	The buffer containing the data received on the socket.
[out]	outBuffer	The buffer containing the data to send to the parser.

See also:

postReceiveHooks, PostReceiveHook

---

Variable Documentation

std::list<std::pair<ParsingHook, float> > bref::Pipeline::parsingHooks

List of parsing hooks.

Only one parser module should return a valid request handler for a given request. If multiple handlers are provided, the one with the highest priority will be used.

See also:

ParsingHook, ParsingRequestHandler

std::list<std::pair<PostParsingHook, float> > bref::Pipeline::postParsingHooks

List of post-parsing hooks.

The server should call these hooks after the parsing step.

See also:

PostParsingRequestHandler, PostParsingHook

std::list<std::pair<PostReceiveHook, float> > bref::Pipeline::postReceiveHooks

List of post-read hooks.

Post-read hooks should be called by the ZIA server after the Pipeline::OnReceiveRequestHandler handlers have generated some data, and before parsingHooks are called.

See also:

PostReceiveHook, PostReceiveRequestHandler