Prosody Framer: API: sm_framer_get_event

Prototype Definition

int sm_framer_get_event(struct sm_framer_event_parms *eventp)

Parameters

*eventp
a structure of the following type: 
typedef struct sm_framer_event_parms {
	tSMFramerId framer;					/* in */
	tSMEventId event;					/* out */
} SM_FRAMER_EVENT_PARMS;

Description

Returns an event object for the framer that can be waited on using smd_ev_wait() . The event will be signalled when a status change occurs on the framer.

Fields

framer
The framer.
event
The event identifier.

Returns

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

This function is part of the Prosody Framer API.