Listening Property

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

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetListening();
int SetListening(int bListening);

Unicode (Windows)
BOOL GetListening();
INT SetListening(BOOL bListening);

@property (nonatomic,readwrite,assign,getter=listening,setter=setListening:) BOOL listening;
- (BOOL)listening;
- (void)setListening:(BOOL)newListening;

#define PID_COAP_LISTENING 1

IPWORKSIOT_EXTERNAL void* IPWORKSIOT_CALL IPWorksIoT_CoAP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSIOT_EXTERNAL int IPWORKSIOT_CALL IPWorksIoT_CoAP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

FALSE

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