Prosody FMP processing: API: sm_fmprx_stop

Prototype Definition

int sm_fmprx_stop(struct sm_fmprx_stop_parms *stopp)

Parameters

*stopp
a structure of the following type: 
typedef struct sm_fmprx_stop_parms {
	tSMFMPrxId fmprx;					/* in */
} SM_FMPRX_STOP_PARMS;

Description

Requests that a FMP[rx] stops executing. The user will be notified that a FMP[rx] has terminated by a final status event. Once the final status notification has been received the FMP[rx] can be destroyed using sm_fmprx_destroy().

Once the FMP[rx] has stopped the event should no longer be used to wait for status notifications as it will be signalled permanently. The event is invalidated when sm_fmprx_destroy() is called.

Fields

fmprx
A tSMFMPrxId that has been previously created by a call to sm_fmprx_create().

Returns

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

This function is part of the Prosody FMP processing API.