Prosody data communications: API: smdc_rx_stop

Prototype Definition

int smdc_rx_stop(struct smdc_stop_parms *pp)

Parameters

*pp
a structure of the following type:
typedef struct smdc_stop_parms {
	tSMChannelId channel;					/* in */
} SMDC_STOP_PARMS;

Description

This stops the receive protocol configured on a channel. Unlike the kSMDCLineCtlCmdDisconnect command of smdc_line_control(), this does not use any disconnection procedures of the protocol - it simply stops immediately. It is intended for situations where there is no need to disconnect properly, such as when call control indicates that the remote party has cleared the call.

When the input half of a channel has stopped, smdc_rx_status() returns the status kSMDCRxStatusFinished.

See also the document Prosody Data Communcations Protocols and Encodings for details of behaviour specific to individual protocols and encodings.

Fields

channel
The data communication channel.

Returns

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


This function is part of the Prosody data communications API.