syseventCreate(3EXT)

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

NAME

syseventCreate- create a sysevent space

SYNOPSIS

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

int syseventCreate(KnSyseventParm *parm, int *spaceId);

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

parm

Address of a KnSyseventParm structure holding the configuration settings.

spaceId

Address of an integer to receive the event space handle

DESCRIPTION

The syseventCreate() function creates an event space to be shared by all the participants that interact via the sysevent framework. This call also pre-allocates event buffer pools, as described by the parm structure.

The event space being created is named by a global event space identifier. If this global ID is equal to K_PRIVATEID, the event space is private to the invoking actor.

If creation succeeds, an event space handle is copied to the location pointed by spaceId. Note that creation fails if an event space with the same global space identifier as specified in the parm structure already exists.

RETURN VALUE

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

ERRORS

[K_EINVAL]

An event space with the same global ID already exists

[K_EOVERLAP]

No sufficient addressing space to map the event pools

[K_EARGS]

Some of the configuration settings are incorrect

[K_ADDR]

One of the parameters has a null value

[K_ENOMEM]

Cannot allocate the memory needed to create the event space

ATTRIBUTES

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

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

syseventOpen(3EXT), syseventInit(3EXT), syseventGetConf(3EXT)

ChorusOS 5.0  Last Revised December 2001

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