Prosody FMP processing: API: sm_fmptx_stop

Prototype Definition

int sm_fmptx_stop(struct sm_fmptx_stop_parms *stopp)

Parameters

*stopp
a structure of the following type: 
typedef struct sm_fmptx_stop_parms {
	tSMFMPtxId fmptx;					/* in */
} SM_FMPTX_STOP_PARMS;

Description

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

Once the FMP[tx] 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_fmptx_destroy() is called.

Fields

fmptx
A tSMFMPtxId that has been previously created by a call to sm_fmptx_create().

Returns

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

This function is part of the Prosody FMP processing API.