syseventPut(3EXT)

NAME | SYNOPSIS | API RESTRICTIONS | PARAMETERS | DESCRIPTION | RETURN VALUE | ERRORS | ATTRIBUTES | SEE ALSO

NAME

syseventPut- post a system event

SYNOPSIS

$(NUCLEUS_DIR)/lib/sysevent/sysevent.a
#include <sysevent/chSysevent.h>

int syseventPut(int spaceId, KnSysevent sysevent, unsigned int prio);

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

PARAMETERS

spaceId

Handle pointing to the event space

sysevent

Address of the system event buffer to be posted

prio

Priority of the system event

DESCRIPTION

The syseventPut() function posts a system event buffer to the event queue associated with the pool the buffer comes from. This queue is the one specified when the event buffer was allocated by calling syseventAllocate().

A priority level is associated to the system event. Its value must fall between 0, the lowest priority, and K_MSG_PRIOMAX, the highest priority.

If a thread is blocked while waiting for a message to be posted on that queue, it is awakened and is given the system event immediately. Otherwise, the event is inserted into the event queue according to its priority level.

RETURN VALUE

K_OK is returned on successful completion. Otherwise, a negative error code is returned.

ERRORS

[K_EINVAL]

spaceId is not valid

[K_EADDR]

The sysevent has a null value. Note that if this pointer is a non accessible address, the caller actor crashes itself into PRM or VM memory models. Otherwise, the FLM memory model can behave unpredictably.

[K_EBADMSG]

The sysevent is not a valid system event buffer

ATTRIBUTES

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

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

syseventFree(3EXT), syseventGet(3EXT), syseventGetAny(3EXT), syseventAllocate(3EXT)

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | API RESTRICTIONS | PARAMETERS | DESCRIPTION | RETURN VALUE | ERRORS | ATTRIBUTES | SEE ALSO