syseventFree(3EXT)

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

NAME

syseventFree- free a sysevent buffer

SYNOPSIS

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

int syseventFree(int spaceId, KnSysevent *sysevent);

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 freed

DESCRIPTION

The syseventFree() function frees a system event buffer. The event buffer is returned to the event pool to which it belongs, allowing its further use by a call to syseventAllocate(). If a thread is waiting for an event buffer from the same event pool, it is awakened and is allocated the freed event buffer. Otherwise, the event buffer is appended to the pool.

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

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

ChorusOS 5.0  Last Revised December 2001

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