Gate

Connections, data reception and sending events handling. More...

Typedefs
typedef Function< bool(HttpResponse &response, const Environment &environment)>	bref::Pipeline::ConnectionRequestHandler
	A hook for the connection of a client.
typedef Function < ConnectionRequestHandler(const Environment &environment)>	bref::Pipeline::ConnectionHook
	Generate a Pipeline::ConnectionRequestHandler.
typedef Function< bool(SocketType socket, Buffer &buffer)>	bref::Pipeline::OnReceiveRequestHandler
	The handler to call when there is pending data on a socket.
typedef Function < OnReceiveRequestHandler(const Environment &environment)>	bref::Pipeline::OnReceiveHook
	Generate a Pipeline::OnReceiveRequestHandler.
typedef Function< bool(SocketType socket, const Buffer &buffer)>	bref::Pipeline::OnSendRequestHandler
	A hook when data need to be sent.
typedef Function < OnSendRequestHandler(const Environment &environment)>	bref::Pipeline::OnSendHook
	Generate a Pipeline::OnSendRequestHandler.
Variables
std::list< std::pair < ConnectionHook, float > >	bref::Pipeline::connectionHooks
	List of connection hooks.
std::list< std::pair < OnReceiveHook, float > >	bref::Pipeline::onReceiveHooks
	List of received hooks.
std::list< std::pair < OnSendHook, float > >	bref::Pipeline::onSendHooks
	List of hooks to run when data needs to be sent.

---

Detailed Description

Connections, data reception and sending events handling.

The gate handles the communication with the outside world. Network events like:

• a connection
  • a notification (by select() for example) saying a socket got data to read
  • when we have to send data to the client.

---

Typedef Documentation

typedef Function<ConnectionRequestHandler (const Environment & environment)> bref::Pipeline::ConnectionHook

Generate a Pipeline::ConnectionRequestHandler.

Parameters:

[in]

environment

The environment of the request.

Returns:

An empty Pipeline::ConnectionRequestHandler when the module can not process the request, otherwise a valid handler that will be called upon connection of a client.

See also:

connectionHooks, ConnectionRequestHandler

typedef Function<bool (HttpResponse & response, const Environment & environment)> bref::Pipeline::ConnectionRequestHandler

A hook for the connection of a client.

Parameters:

[out]	response	Can be filled with the header of the response and a status code.
[in]	environment	The environment of the request.

Return values:

true	If the connection is accepted.
false	If the connection is refused and the socket should be closed by the server.

See also:

connectionHooks, ConnectionHook

typedef Function<OnReceiveRequestHandler (const Environment & environment)> bref::Pipeline::OnReceiveHook

Generate a Pipeline::OnReceiveRequestHandler.

Parameters:

[in]

environment

The environment of the request.

Returns:

An empty handler when the module can not process the request, otherwise a valid handler that will be called upon reception of data.

See also:

onReceiveHooks, OnReceiveRequestHandler

typedef Function<bool (SocketType socket, Buffer & buffer)> bref::Pipeline::OnReceiveRequestHandler

The handler to call when there is pending data on a socket.

The server should call this handler when the socket received some "read event" on the fd, with a function like select().

Parameters:

[in]	socket	The socket with data available.
[out]	buffer	The buffer where data will be stored.

Return values:

true	If everything went fine, the server can pursue the request.
false	When an unrecoverable error happens, the server will take care to remove the socket.

See also:

onReceiveHooks, OnReceiveHook

typedef Function<OnSendRequestHandler (const Environment & environment)> bref::Pipeline::OnSendHook

Generate a Pipeline::OnSendRequestHandler.

Parameters:

[in]

environment

The environment of the request.

Returns:

An empty Pipeline::OnSendRequestHandler when the module can not process the request, otherwise a valid handler that will be called when sending data.

See also:

onSendHooks, OnSendRequestHandler

typedef Function<bool (SocketType socket, const Buffer & buffer)> bref::Pipeline::OnSendRequestHandler

A hook when data need to be sent.

Parameters:

[in]	socket	The socket where buffer need to be sent.
[in]	buffer	The data to send.

Return values:

true	If everything went fine.
false	If an error occured. The server should close the socket.

See also:

onSendHooks, OnSendHook

---

Variable Documentation

std::list<std::pair<ConnectionHook, float> > bref::Pipeline::connectionHooks

List of connection hooks.

Connection hooks should be called by the ZIA server upon the connection of a client.

This hook point can be used for a black listing module for example.

See also:

ConnectionHook, ConnectionRequestHandler

std::list<std::pair<OnReceiveHook, float> > bref::Pipeline::onReceiveHooks

List of received hooks.

OnReceiveHook should be called by the ZIA server when a read event is received on a socket (with a select() or similar a methods).

This hook point can be used for a reading data on the socket. A SLL module seems to be a good example.

See also:

OnReceiveHook, OnReceiveRequestHandler

std::list<std::pair<OnSendHook, float> > bref::Pipeline::onSendHooks

List of hooks to run when data needs to be sent.

The server should call these hooks at the end of the Pipeline, when a response should be sent to the client.

See also:

OnSendRequestHandler, onSendHook