Prosody FMP processing: API: sm_fmprx_create

This function is only in Preliminary Documentation.

Prototype Definition

int sm_fmprx_create(struct sm_fmprx_create_parms *fmprxp)

Parameters

*fmprxp

a structure of the following type:

typedef struct sm_fmprx_create_parms {
	tSMFMPrxId fmprx;					/* out */
	tSMModuleId module;					/* in */
	struct in_addr address;					/* in */
} SM_FMPRX_CREATE_PARMS;

Description

Allocates, on a specific module, a new FMP[rx] to receive incoming T.38 data. If the call completes successfully, the parameter fmprx will be set to the identifier for that fmprx.

A FMP[rx] is automatically allocated a port number for incoming RTP data, this information may be obtained by waiting for sm_fmprx_status() to return the port information. The FMP[rx] will discard any incoming packets that do not match it's current configuration settings.

Fields

fmprx (Only in Preliminary Documentation)

The newly created FMP[rx].

module (Only in Preliminary Documentation)

A value obtained from sm_open_module() which indicates the module where the FMP[rx] is to be allocated.

address (Only in Preliminary Documentation)

The address on which this FMP[rx] is to listen.

Returns

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

• ERR_SM_DEVERR - device error
• ERR_SM_NO_RESOURCES - if insufficient resources exist to create the FMP[rx]

This function is part of the Prosody FMP processing API.