Prosody DTLS processing: API: sm_dtlstx_status

Prototype Definition

int sm_dtlstx_status(struct sm_dtlstx_status_parms *statusp)

Parameters

*statusp

a structure of the following type:

typedef struct sm_dtlstx_status_parms {
	tSMDTLStxId dtlstx;					/* in */
	enum kSMDTLStxStatus {
		kSMDTLStxStatusRunning,
		kSMDTLStxStatusStopped,
		kSMDTLStxStatusHasCapacity,
	} status;						/* out */
} SM_DTLSTX_STATUS_PARMS;

Description

Returns the current status of the DTLS[tx] or an error to indicate that a problem occurred during start-up.

Fields

dtlstx

The DTLS[tx] to interrogate

status

One of these values:

kSMDTLStxStatusRunning

Indicates that there is nothing significant to report

kSMDTLStxStatusStopped

Indicates that the DTLS[tx] has stopped transmitting DTLS and that it is safe to destroy

kSMDTLStxStatusHasCapacity

The DTLS[tx] has capacity to buffer another packet.

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 DTLS[tx]

This function is part of the Prosody DTLS processing API.