Prosody FMP processing: API: sm_fmprx_status

This function is only in Preliminary Documentation.

Prototype Definition

int sm_fmprx_status(struct sm_fmprx_status_parms *statusp)

Parameters

*statusp

a structure of the following type:

typedef struct sm_fmprx_status_parms {
	tSMFMPrxId fmprx;					/* in */
	enum kSMFMPrxStatus {
		kSMFMPrxStatusRunning,
		kSMFMPrxStatusStopped,
		kSMFMPrxStatusGotPorts,
		kSMFMPrxStatusSource,
	} status;						/* out */
	union {
		struct {
			int T38_port;				/* out */
			struct in_addr address;			/* out */
		} port;						/* out */
		struct {
			struct in_addr address;			/* out */
			int port;				/* out */
		} source;					/* out */
	} u;							/* out */
} SM_FMPRX_STATUS_PARMS;

Description

Returns the current status of the FMP[rx] or an error to indicate that an error has occurred.

When the event, obtained from sm_fmprx_get_event(), is signalled the user must call this function to determine the nature of the status change. The change in status may indicate that an error occurred whilst processing a user request or it may be notifiying the user of a change to the previous state of the FMP[rx].

Fields

fmprx (Only in Preliminary Documentation)

The FMP[rx] to interrogate

status (Only in Preliminary Documentation)

One of these values:

kSMFMPrxStatusRunning

Indicates that there is nothing significant to report

kSMFMPrxStatusStopped

Indicates that the FMP[rx] has stopped processing T.38 and that it can be safely destroyed

kSMFMPrxStatusGotPorts

Indicates that port information is available.

kSMFMPrxStatusSource

Indicates that source address and port information is available.

u (Only in Preliminary Documentation)

port

This field is only valid if the status is kSMFMPrxStatusGotPorts.

T38_port

The UDP port number on which this FMP[rx] is listening for T.38 packets

address

The address on which this FMP[rx] is listening

source

This field is only valid if the status is kSMFMPrxStatusSource.

address

The address from which the T.38 data is being received.

port

The UDP port number from which the T.38 data is being received.

Returns

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

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

This function is part of the Prosody FMP processing API.