Prosody DTLS processing: API: sm_dtlsrx_stop

Prototype Definition

int sm_dtlsrx_stop(struct sm_dtlsrx_stop_parms *stopp)

Parameters

*stopp
a structure of the following type:
typedef struct sm_dtlsrx_stop_parms {
	tSMDTLSrxId dtlsrx;					/* in */
} SM_DTLSRX_STOP_PARMS;

Description

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

Once the DTLS[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_dtlsrx_destroy() is called.

Fields

dtlsrx
A tSMDTLSrxId that has been previously created by a call to sm_dtlsrx_create().

Returns

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


This function is part of the Prosody DTLS processing API.