sysevent_get_event(3EXT)

NAME | SYNOPSIS | PARAMETERS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO

NAME

sysevent_get_event, _sysevent_get_event- get posted events

SYNOPSIS

$(OS_DIR)/lib/libsysevent.a
#include <sys/sysevent.h>
#include <libsysevent.h>

sysevent_t *sysevent_get_event(struct timeval * timeout);
sysevent_t *sysevent_get_event(int queue, struct timeval *timeout);

PARAMETERS

timeout

Pointer to the timeout

queue

Event queue identifier

DESCRIPTION

The sysevent_get_event() function attempts to retrieve a system event posted to any event queue, up to the specified timeout interval.

The _sysevent_get_event() function behaves like sysevent_get_event() , except that the event queue to wait on must be specified.

At least four event queues are available:

SE_NUCLEUS

Used by the microkernel to publish events

SE_DRIVER

Used by the device drivers to publish events

SE_OS

Used by the operating system to publish events

SE_USER

Used by user-level applications to publish events

In addition to these predefined queues, a number of extra event queues may be optionally configured at the core system event level. These optional queues are identified by an index number that starts at 0 for the first extra queue.

The _sysevent_get_event() function can be explicitly requested to wait for system events on all the valid event queues at the same time, by setting the queue parameter to SE_ANY_QUEUE .

The timeout parameter can also be set to the following values:

SE_NOBLOCK

To request a non-blocking attempt

SE_NOTIMEOUT

To request unbounded wait

RETURN VALUES

Upon successful completion, sysevent_get_event() and _sysevent_get_event() return a system event handle; otherwise they return NULL and set errno to indicate one of the following error conditions.

ERRORS

[EINVAL]

Invalid argument; notably set if one of the following conditions is met

[ETIMEDOUT]

No system event queue posted within the specified timeout

[EPERM]

Permission denied

[ENOXIO]

The system event feature is not configured or no system event server is available.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

sysevent_post_event(3EXT) , _sysevent_post_event(3EXT)

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | PARAMETERS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO