syseventInit(3EXT)

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

NAME

syseventInit- initialize a sysevent space

SYNOPSIS

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

int syseventInit(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 syseventInit() function initializes (creates or opens) a system event space. If the event space named by the global identifier held by the parm structure does not exist, it is created with the settings also held by the parm structure. Otherwise, if the event space already exists, it is merely opened.

If this call succeeds, an event space handle is copied to the location pointed to by spaceId.

This call provides a convenient way to join a common event space without placing additional synchronization constraints on the various actors. These constraints regard balancing creating against binding the event space.

RETURN VALUE

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

ERRORS

[K_EOVERLAP]

Insufficient addressing space to map the event pools

[K_EARGS]

The event space does not exist yet, and 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

syseventCreate(3EXT), syseventOpen(3EXT), syseventGetConf(3EXT)

ChorusOS 5.0  Last Revised December 2001

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