Prosody Framer: API: sm_framer_create

Prototype Definition

int sm_framer_create(struct sm_framer_create_parms *createp)

Parameters

*createp

a structure of the following type:

typedef struct sm_framer_create_parms {
	tSMFramerId framer;					/* out */
	tSMModuleId module;					/* in */
} SM_FRAMER_CREATE_PARMS;

Description

Creates a Framer .

Fields

framer

The created framer.

module

A value obtained from sm_open_module() which indicates the module on which the framer is to be created.

Returns

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

• ERR_SM_DEVERR - device error
• ERR_SM_NO_RESOURCES - if no suitable output channel free
• ERR_SM_NO_SUCH_MODULE - if invalid module identifier specified

This function is part of the Prosody Framer API.