Prosody DTLS processing: API: sm_dtlstx_stop

Prototype Definition

int sm_dtlstx_stop(struct sm_dtlstx_stop_parms *stopp)

Parameters

*stopp
a structure of the following type:
typedef struct sm_dtlstx_stop_parms {
	tSMDTLStxId dtlstx;					/* in */
} SM_DTLSTX_STOP_PARMS;

Description

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

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

Fields

dtlstx
A tSMDTLStxId that has been previously created by a call to sm_dtlstx_create().

Returns

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


This function is part of the Prosody DTLS processing API.