Include dependency graph for tcpd.c:

Functions
hpd_error_t	hpd_tcpd_conn_close (hpd_tcpd_conn_t *conn)
	Close a connection, after the remaining data has been sent. More...

hpd_error_t	hpd_tcpd_conn_get_ip (hpd_tcpd_conn_t conn, const char *ip)
	Get the IP address of the client. More...

hpd_error_t	hpd_tcpd_conn_keep_open (hpd_tcpd_conn_t *conn)
	Disable timeout on connection. More...

hpd_error_t	hpd_tcpd_conn_kill (hpd_tcpd_conn_t *conn)
	Kill and clean up after a connection. More...

hpd_error_t	hpd_tcpd_conn_sendf (hpd_tcpd_conn_t conn, const char fmt,...)
	Send message on connection. More...

hpd_error_t	hpd_tcpd_conn_vsendf (hpd_tcpd_conn_t conn, const char fmt, va_list vp)
	Send message on connection. More...

hpd_error_t	hpd_tcpd_create (hpd_tcpd_t *tcpd, hpd_tcpd_settings_t settings, const hpd_module_t context, hpd_ev_loop_t loop)
	Create new tcpd instance. More...

hpd_error_t	hpd_tcpd_destroy (hpd_tcpd_t *tcpd)
	Destroy tcpd and free used memory. More...

hpd_error_t	hpd_tcpd_start (hpd_tcpd_t *tcpd)
	Start the tcpd. More...

hpd_error_t	hpd_tcpd_stop (hpd_tcpd_t *tcpd)
	Stop an already running tcpd. More...

static void *	tcpd_get_in_addr (struct sockaddr *sa)
	Get the in_addr from a sockaddr (IPv4 or IPv6) More...

static void	tcpd_on_ev_conn (hpd_ev_loop_t loop, struct ev_io watcher, int revents)
	Initialise and accept connection. More...

static void	tcpd_on_ev_recv (hpd_ev_loop_t loop, struct ev_io watcher, int revents)
	Recieve callback for io-watcher. More...

static void	tcpd_on_ev_send (hpd_ev_loop_t loop, struct ev_io watcher, int revents)
	Send callback for io-watcher. More...

static void	tcpd_on_ev_timeout (hpd_ev_loop_t loop, struct ev_timer watcher, int revents)
	Timeout callback for timeout watcher. More...

Function Documentation

hpd_error_t hpd_tcpd_conn_close ( hpd_tcpd_conn_t * conn )

Close a connection, after the remaining data has been sent.

This sets the close flag on a connection. The connection will be closed after the remaining messages has been sent. If there is no waiting messages the connection will be closed instantly.

Parameters

conn	The connection to close

Definition at line 581 of file tcpd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

hpd_error_t hpd_tcpd_conn_get_ip	(	hpd_tcpd_conn_t *	conn,
		const char **	ip
	)

Get the IP address of the client.

Parameters

conn	The connection on which the client is connected.

Returns: The IP address in a string.

Definition at line 459 of file tcpd.c.

Here is the caller graph for this function:

hpd_error_t hpd_tcpd_conn_keep_open ( hpd_tcpd_conn_t * conn )

Disable timeout on connection.

Every connection have per default a timeout value, which is set in hpd_tcpd_settings_t. If there is no activity on the connection before the timeout run out the connection is killed. This function disables the timeout, so connections will stay open. A connection will still be killed when the client closes the connection, or kill/close is called.

Parameters

conn	The connection to keep open

Definition at line 479 of file tcpd.c.

Here is the caller graph for this function:

hpd_error_t hpd_tcpd_conn_kill ( hpd_tcpd_conn_t * conn )

Kill and clean up after a connection.

This function stops the LibEV watchers, closes the socket, and frees the data structures used by a connection.

Note that you should use hpd_tcpd_conn_close for a graceful closure of the connection, where the remaining data is sent.

Parameters

conn	The connection to kill.

Definition at line 608 of file tcpd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

hpd_error_t hpd_tcpd_conn_sendf	(	hpd_tcpd_conn_t *	conn,
		const char *	fmt,
			...
	)

Send message on connection.

This function is used similary to the standard printf function, with a format string and variable arguments. It calls hpd_tcpd_conn_vsendf() to handle the actually sending, see this for more information.

Connection is kept open for further communication, use hpd_tcpd_conn_close to close it.

Parameters

conn	Connection to send on
fmt	Format string

Returns: The same as hpd_tcpd_conn_vsendf()

Definition at line 503 of file tcpd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

hpd_error_t hpd_tcpd_conn_vsendf	(	hpd_tcpd_conn_t *	conn,
		const char *	fmt,
		va_list	vp
	)

Send message on connection.

This function is simiar to the standard vprintf function, with a format string and a list of variable arguments.

Note that this function only schedules the message to be send. A send watcher on the event loop will trigger the actual sending, when the connection is ready for it.

Connection is kept open for further communication, use hpd_tcpd_conn_close to close it.

Parameters

conn	Connection to send on
fmt	Format string
arg	List of arguments

Returns: zero on success, -1 or the return value of vsprintf on failure

Definition at line 534 of file tcpd.c.

Here is the caller graph for this function:

hpd_error_t hpd_tcpd_create	(	hpd_tcpd_t **	tcpd,
		hpd_tcpd_settings_t *	settings,
		const hpd_module_t *	context,
		hpd_ev_loop_t *	loop
	)

Create new tcpd instance.

This creates a new tcpd instances, that can be started with hpd_tcpd_start() and stopped with hpd_tcpd_stop(). The instance should be destroyed with hpd_tcpd_destroy when not longer needed.

Parameters

settings	The settings for the tcpd.
loop	The event loop to run tcpd on.

Returns: The new tcpd instance.

Definition at line 269 of file tcpd.c.

Here is the caller graph for this function:

hpd_error_t hpd_tcpd_destroy ( hpd_tcpd_t * tcpd )

Destroy tcpd and free used memory.

This function destroys and frees all connections are instances. The tcpd should be stopped before destroy to properly close all connections and sockets first.

Parameters

instance The tcpd instance to destroy

Definition at line 297 of file tcpd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

hpd_error_t hpd_tcpd_start ( hpd_tcpd_t * tcpd )

Start the tcpd.

The libev-based tcpd is added to an event loop by a call to this function. It is the caller's resposibility to start the event loop.

To stop the tcpd again, one may call hpd_tcpd_stop().

Parameters

instance The tcpd instance to start. Created with hpd_tcpd_create();

Returns: 0 on success, 1 on error.

Definition at line 318 of file tcpd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

hpd_error_t hpd_tcpd_stop ( hpd_tcpd_t * tcpd )

Stop an already running tcpd.

The tcpd, started with hpd_tcpd_start(), may be stopped by calling this function. It will take the tcpd off the event loop and clean up after it.

This includes killing all connections without waiting for remaining data to be sent.

Parameters

instance The tcpd instance to stop.

Definition at line 428 of file tcpd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static void* tcpd_get_in_addr ( struct sockaddr * sa )

static

Get the in_addr from a sockaddr (IPv4 or IPv6)

Get the in_addr for either IPv4 or IPv6. The type depends on the protocal, which is why this returns a void pointer. It works nicely to pass the result of this function as the second argument to inet_ntop().

Parameters

sa	The sockaddr

Returns: An in_addr or in6_addr depending on the protocol.

Definition at line 52 of file tcpd.c.

Here is the caller graph for this function:

static void tcpd_on_ev_conn	(	hpd_ev_loop_t *	loop,
		struct ev_io *	watcher,
		int	revents
	)

static

Initialise and accept connection.

This function is designed to be used as a callback function within LibEV. It will accept the conncetion as described inside the file descripter within the watcher. It will also add timeout and io watchers to the loop, which will handle the further communication with the connection.

Parameters

loop	The running event loop.
watcher	The watcher that was tiggered on the connection.
revents	Not used.

Definition at line 193 of file tcpd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static void tcpd_on_ev_recv	(	hpd_ev_loop_t *	loop,
		struct ev_io *	watcher,
		int	revents
	)

static

Recieve callback for io-watcher.

Recieves up to max_data_size (from hpd_tcpd_settings_t) of data from a connection and calls on_recieve with it. Also resets the timeout for the connection, if one.

Parameters

loop	The event loop
watcher	The io watcher causing the call
revents	Not used

Definition at line 74 of file tcpd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static void tcpd_on_ev_send	(	hpd_ev_loop_t *	loop,
		struct ev_io *	watcher,
		int	revents
	)

static

Send callback for io-watcher.

Sends message stored in send_msg on the connection. If not all the data could be sent at once, the remainer is store in send_msg again and the watcher is not stopped. If a connection is flaggted with close, the connection is closed when all the data has been sent.

Parameters

loop	The event loop
watcher	The io watcher causing the call
revents	Not used

Definition at line 128 of file tcpd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static void tcpd_on_ev_timeout	(	hpd_ev_loop_t *	loop,
		struct ev_timer *	watcher,
		int	revents
	)

static

Timeout callback for timeout watcher.

Kills the connection on timeout

Parameters

loop	The event loop
watcher	The io watcher causing the call
revents	Not used

Definition at line 171 of file tcpd.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Functions

Function Documentation