Prosody Framer: API: sm_framer_status

Prototype Definition

int sm_framer_status(struct sm_framer_status_parms *statusp)

Parameters

*statusp

a structure of the following type:

typedef struct sm_framer_status_parms {
	tSMFramerId framer;					/* in */
	enum kSMFramerStatus {
		kSMFramerStatusRunning,
		kSMFramerStatusStopped,
		kSMFramerStatusNewState,
	} status;						/* out */
	tSM_INT new_state;					/* out */
} SM_FRAMER_STATUS_PARMS;

Description

Returns the status of the Framer.

Fields

framer

The Framer.

status

The status. One of these values:

kSMFramerStatusRunning

The framer is running

kSMFramerStatusStopped

The framer is not running

kSMFramerStatusNewState

The framer has changed state

new_state

The new state of the framer. Only valid when the status field is kSMFramerStatusNewState. If new_state is 0, then the framer is now out of sync. If new_state is 1, then the framer is now in sync.

Returns

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

• ERR_SM_DEVERR - device error

This function is part of the Prosody Framer API.