Prosody FMP processing: API: sm_fmprx_get_event

Prototype Definition

int sm_fmprx_get_event(struct sm_fmprx_event_parms *eventp)

Parameters

*eventp
a structure of the following type: 
typedef struct sm_fmprx_event_parms {
	tSMFMPrxId fmprx;					/* in */
	tSMEventId event;					/* out */
} SM_FMPRX_EVENT_PARMS;

Description

If the call completes successfully event will hold a pointer to the tSMEventId belonging to fmprx. The tSMEventId is valid until the FMP[rx] is destroyed using sm_fmprx_destroy(). This event will be signalled when a status change occurs on the FMP[rx]. When the event is signalled the user must call sm_fmprx_status() to discover the nature of the status change.

Fields

fmprx
The FMP[rx]
event
The event identifier

Returns

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

This function is part of the Prosody FMP processing API.