Prosody FMP processing: API: sm_fmptx_get_event

Prototype Definition

int sm_fmptx_get_event(struct sm_fmptx_event_parms *eventp)

Parameters

*eventp
a structure of the following type: 
typedef struct sm_fmptx_event_parms {
	tSMFMPtxId fmptx;					/* in */
	tSMEventId event;					/* out */
} SM_FMPTX_EVENT_PARMS;

Description

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

Fields

fmptx
The FMP[tx]
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.