syseventGet(3EXT)

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

NAME

syseventGet- retrieve a sysevent buffer

SYNOPSIS

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

int syseventGet(int spaceId, int queueId, KnTimeval *waitLimit, 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

queueId

Identifier of the event queue to wait on

waitLimit

Timeout, if there is no free event buffer immediately available

sysevent

Address of a pointer to where the event buffer address is stored

DESCRIPTION

The syseventGet() function returns the first system event with the highest priority waiting in the event queue named by queueId.

If an event is pending behind the specified queue, this call sets the address of the event into sysevent and returns K_OK. Otherwise, syseventGet() may wait for the posting of an event, according to the value of waitLimit. If waitLimit is set to K_NOBLOCK, syseventGet() immediately returns with a K_ETIMEOUT error code. Otherwise, the caller is blocked until an event is posted to the specified queue by syseventPut(), or until the timeout expires.

RETURN VALUE

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

ERRORS

[K_EINVAL]

spaceId is not valid

[K_EARGS]

queueId is not valid event queue identifier

[K_ETIMEOUT]

The maximum waiting time expired

[K_EADDR]

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

[K_EABORT]

The invoking thread was aborted while waiting for an event

ATTRIBUTES

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

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

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

ChorusOS 5.0  Last Revised December 2001

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