apt_pollset.h File Reference

Interruptable APR-Pollset. More...

#include <apr_poll.h>
#include "apt.h"

Go to the source code of this file.

Typedefs
typedef typedefAPT_BEGIN_EXTERN_C struct apt_pollset_t	apt_pollset_t
Functions
apt_pollset_t *	apt_pollset_create (apr_uint32_t size, apr_pool_t *pool)
apt_bool_t	apt_pollset_destroy (apt_pollset_t *pollset)
apt_bool_t	apt_pollset_add (apt_pollset_t *pollset, const apr_pollfd_t *descriptor)
apt_bool_t	apt_pollset_remove (apt_pollset_t *pollset, const apr_pollfd_t *descriptor)
apr_status_t	apt_pollset_poll (apt_pollset_t *pollset, apr_interval_time_t timeout, apr_int32_t *num, const apr_pollfd_t **descriptors)
apt_bool_t	apt_pollset_wakeup (apt_pollset_t *pollset)
apt_bool_t	apt_pollset_is_wakeup (apt_pollset_t *pollset, const apr_pollfd_t *descriptor)

---

Detailed Description

Interruptable APR-Pollset.

---

Typedef Documentation

typedef typedefAPT_BEGIN_EXTERN_C struct apt_pollset_t apt_pollset_t

Wakeup builtin API of the pollset is introduced only in APR-1.4 and it is not available for APR-1.2 and APR-1.3 versions. Thus apt_pollset_t is an extension of apr_pollset_t and provides pollset wakeup capabilities the similar way as it's implemented in APR-1.4 trunk Opaque pollset declaration

---

Function Documentation

apt_bool_t apt_pollset_add	(	apt_pollset_t *	pollset,
		const apr_pollfd_t *	descriptor
	)

Add pollset descriptor to a pollset.

Parameters:

	pollset	the pollset to add the descriptor to
	descriptor	the descriptor to add

apt_pollset_t* apt_pollset_create	(	apr_uint32_t	size,
		apr_pool_t *	pool
	)

Create interruptable pollset on top of APR pollset.

Parameters:

	size	the maximum number of descriptors pollset can hold
	pool	the pool to allocate memory from

apt_bool_t apt_pollset_destroy

(

apt_pollset_t *

pollset

)

Destroy pollset.

Parameters:

pollset

the pollset to destroy

apt_bool_t apt_pollset_is_wakeup	(	apt_pollset_t *	pollset,
		const apr_pollfd_t *	descriptor
	)

Match against builtin wake up descriptor in a pollset.

Parameters:

	pollset	the pollset to use
	descriptor	the descriptor to match

apr_status_t apt_pollset_poll	(	apt_pollset_t *	pollset,
		apr_interval_time_t	timeout,
		apr_int32_t *	num,
		const apr_pollfd_t **	descriptors
	)

Block for activity on the descriptor(s) in a pollset.

Parameters:

	pollset	the pollset to use
	timeout	the timeout in microseconds
	num	the number of signalled descriptors (output parameter)
	descriptors	the array of signalled descriptors (output parameter)

apt_bool_t apt_pollset_remove	(	apt_pollset_t *	pollset,
		const apr_pollfd_t *	descriptor
	)

Remove pollset descriptor from a pollset.

Parameters:

	pollset	the pollset to remove the descriptor from
	descriptor	the descriptor to remove

apt_bool_t apt_pollset_wakeup

(

apt_pollset_t *

pollset

)

Interrupt the blocked poll call.

Parameters:

pollset

the pollset to use