Prosody generic: API: sm_module_get_event

Prototype Definition

int sm_module_get_event(struct sm_module_event_parms *eventp)

Parameters

*eventp
a structure of the following type: 
typedef struct sm_module_event_parms {
	tSMModuleId module_id;					/* in */
	tSMEventId event;					/* out */
} SM_MODULE_EVENT_PARMS;

Description

If the call completes successfully event will hold the tSMEventId belonging to module_id. The tSMEventId is valid until the module is closed using sm_close_module(). This event will be signalled when a status change occurs on the module. When the event is signalled the user must call sm_module_status() to discover the nature of the status change.

Fields

module_id
The module
event
The event identifier

Returns

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

This function is part of the Prosody generic API.