Listening Property

Whether the class should operate in server mode by listening for incoming requests.

Syntax

 coap.getListening([callback])
 coap.setListening( listening, [callback])

Default Value

FALSE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getListening([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setListening([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property controls whether the class operates in server mode or client mode.

When this property is disabled (default), the class operate in client mode, allowing applications to send requests using the Get, Post, SendCustomRequest, etc. methods.

When this property is enabled, the class listens on LocalPort for incoming CoAP requests, firing the Request event anytime one arrives. Applications can service these requests directly during Request events, or send separate responses later using the SendResponse method.

Note: Applications that wish to use the class in server mode should set the LocalPort property to the desired listening port (such as 5683, the standard CoAP port) before enabling this property. Otherwise the system will choose a port at random.

This property is not available at design time.

Data Type

Boolean