Prosody SPRT end point: API: sm_sprt_status

Prototype Definition

int sm_sprt_status(struct sm_sprt_status_parms *statusp)

Parameters

*statusp
a structure of the following type: 
typedef struct sm_sprt_status_parms {
	tSMSPRTId sprt;						/* in */
	enum kSMSPRTStatus {
		kSMSPRTStatusRunning,
		kSMSPRTStatusStopped,
		kSMSPRTStatusMessage,
	} status;						/* out */
} SM_SPRT_STATUS_PARMS;

Description

returns the status of the SPRT end point.

Fields

sprt
The SPRT end point.
status
The status. One of these values:
kSMSPRTStatusRunning
The SPRT end point is running
kSMSPRTStatusStopped
The SPRT end point is not running
kSMSPRTStatusMessage
The SPRT end point has a message to be read

Returns

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

This function is part of the Prosody SPRT end point API.