Prosody generic: API: sm_collector_get_event

This function is only in Preliminary Documentation.

Prototype Definition

int sm_collector_get_event(struct sm_collector_event_parms *eventp)

Parameters

*eventp

a structure of the following type:

typedef struct sm_collector_event_parms {
	tSMCollectorId collector;				/* in */
	tSMEventId event;					/* out */
} SM_COLLECTOR_EVENT_PARMS;

Description

If the call completes successfully event will hold the tSMEventId belonging to collector. The tSMEventId is valid until the collector is destroyed using sm_collector_destroy(). This event will be signalled when a status change occurs on the collector. When the event is signalled the user must call sm_collector_status() to discover the nature of the status change.

Fields

collector (Only in Preliminary Documentation)

The collector

event (Only in Preliminary Documentation)

The event identifier

Returns

0 if call completed successfully, otherwise a standard error such as:

• ERR_SM_DEVERR - device error

This function is part of the Prosody generic API.