CoAP Class

Properties Methods Events Config Settings Errors

An easy-to-use CoAP client and server implementation.

Syntax

CoAP

Remarks

The CoAP class provides a lightweight, fully-featured CoAP client and server implementation.

Using the Class in Client Mode

While in client mode (i.e., the Listening property is disabled; its default setting), the class can be used to send requests to a CoAP server. It can also be used to register as an observer for various server-side resources, causing the server to send notifications anytime said resources change.

To send a request, populate the RequestData, RequestContentFormat, RequestETag, and RequestOption* properties (if necessary, and as applicable), then call one of the following methods:

Get
Post
Put
Delete
SendCustomRequest

The methods above require a URI as a parameter. The format of the URI parameter is coap://hostname:port/resource. The port is optional, and if not specified will default to 5683. For instance coap://myserver/test and coap://myserver:5683/test are equivalent.

Once a response is received, the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOption* properties will be populated, and the RequestComplete event will fire. (If the request times out, the properties are not populated, but the event still fires.) coap.OnRequestComplete += (s, e) => { Console.WriteLine("Request complete!"); Console.WriteLine(coap.ResponseCode); }; // Make a GET request to download a picture. coap.Get("coap://mycoapserver/pictures/animals/cats4.dat?format=png"); // Imaginary function which accepts PNG image data and displays the picture to the user. showPicture(coap.ResponseDataB);

To observe a resource, call the StartObserving method. Assuming the server accepts the observer registration request, it will begin sending notifications for the resource anytime it changes. Each change notification will cause the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOption* properties to be populated, and the Notification event to fire.

To stop observing a resource, either call StopObserving with the same URI value used to call StartObserving, or set the Notification event's StopObserving parameter to True. coap.OnNotification += (s, e) => { // Notifications can arrive out of order; only print to the log if this is the latest one we've received. if (e.IsLatest) { Console.WriteLine("Received notification for the resource at: " + e.URI); Console.WriteLine("New Value: " + coap.ResponseData); } } // Start observing a temperature sensor's data. Assume temperature values are sent back in text format. coap.StartObserving("coap://mycoapserver/home/living_room/sensors/temperature?unit=fahrenheit"); // Assume the server accepts the request and starts sending notifications every so often. // ... // Later, stop observing the resource. coap.StopObserving("coap://mycoapserver/home/living_room/sensors/temperature?unit=fahrenheit");

Using the Class in Server Mode

To operate in server mode, set the LocalPort to the port the class should listen on (typically 5683, the standard CoAP port), then enable the Listening property. Each time a request arrives, the RequestData, RequestContentFormat, RequestETag, and RequestOption* properties will be populated, and the Request event will fire.

A response can be sent by populating the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOption* properties as desired before the event finishes. Alternatively, the Request event's SendResponse parameter can be set to False in order to send a response back later. In this case, the RequestId value from the event should be used to call the SendResponse method later. coap.OnRequest += (s, e) => { // For the purpose of this snippet, assume we only service GET requests, which have a method code of 1. if (e.Method == 1) { Console.WriteLine("GET request received for URI path: " + e.URIPath + " and URI query params: " + e.URIQuery); coap.ResponseCode = "2.05"; // "Content". // Imaginary methods that look up the data and content format of the resource based on the URI path and URI query parameters. coap.ResponseData = lookupResourceData(e.URIPath, e.URIQuery); coap.ResponseContentFormat = lookupResourceContentFormat(e.URIPath, e.URIQuery); } else { coap.ResponseCode = "4.05"; // "Method Not Allowed". coap.ResponseData = "Only GET requests are allowed."; // Include a diagnostic payload. coap.ResponseContentFormat = ""; } // Alternatively, this event could simply save the e.RequestId value somewhere, then some other code could fill in the Response* // properties and call the SendResponse() method later. }; coap.OnResponseComplete += (s, e) => { Console.WriteLine("Response sent for request with Id " + e.RequestId); };

In server mode, the class can also support resource observation. When a client attempts to register itself as an observer of a resource, the Register event will fire; setting this event's Accept parameter to True will cause the class to accept the registration.

To notify clients that a resource has changed, populate the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOption* properties as desired, and then call the SendNotification method, passing it the URI of a resource that has registered observers.

When a client has unregistered from further change notifications, the Unregistered event will fire. coap.OnRegister += (s, e) => { Console.WriteLine("Client " + e.RemoteHost + ":" + e.RemotePort + " has registered for notifications for the URI " + e.URI); // Imaginary method that helps ensure the application keeps track of observed URIs. The class itself maintains the // list of observers for each URI, so the application just needs to know that there are observers in the first place. observerRegisteredForURI(e.URI); e.Accept = true; }; coap.OnUnregistered += (s, e) => { Console.WriteLine("Client " + e.RemoteHost + ":" + e.RemotePort + " has unregistered from notifications for the URI " + e.URI); // As above, imaginary method that helps ensure the application keeps track of observed URIs. observerUnregisteredForURI(e.URI); }; // Somewhere else in the application, this sort of code might get called after a resource changes to inform any observers of // the change. We use another imaginary method here to check if the changed resource is observed, and to get its information. if (isResourceObserved()) { coap.ResponseCode = "2.05"; // "Content". coap.ResponseDataB = getResourceContent(); coap.ResponseContentFormat = getResourceContentFormat(); coap.SendNotification(getResourceURI()); }

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


Listening	Whether the class should operate in server mode by listening for incoming requests.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The UDP port in the local host where UDP binds.
PendingRequestCount	The number of records in the PendingRequest arrays.
PendingRequestMethod	The request's method.
PendingRequestRemoteHost	The remote host associated with the request.
PendingRequestRemotePort	The remote port associated with the request.
PendingRequestId	The request's Id.
PendingRequestToken	The request's token.
PendingRequestURI	The request URI.
RequestContentFormat	The request content format.
RequestData	The request data.
RequestETag	The request ETag.
RequestOptionCount	The number of records in the RequestOption arrays.
RequestOptionCritical	Whether the option is critical.
RequestOptionNoCacheKey	Whether the option is to be excluded from the cache-key.
RequestOptionNumber	The option's number.
RequestOptionUnsafe	Whether the option is unsafe to forward.
RequestOptionValue	The option's value.
RequestOptionValueType	The option's value data type.
ResponseCode	The response code.
ResponseContentFormat	The response content format.
ResponseData	The response data.
ResponseETag	The response ETag.
ResponseOptionCount	The number of records in the ResponseOption arrays.
ResponseOptionCritical	Whether the option is critical.
ResponseOptionNoCacheKey	Whether the option is to be excluded from the cache-key.
ResponseOptionNumber	The option's number.
ResponseOptionUnsafe	Whether the option is unsafe to forward.
ResponseOptionValue	The option's value.
ResponseOptionValueType	The option's value data type.
Timeout	A timeout for the class.
UseConfirmableMessages	Whether to use confirmable message.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


CancelRequest	Cancels a pending request.
Config	Sets or retrieves a configuration setting.
Delete	Sends a DELETE request to the server.
DoEvents	Processes events from the internal message queue.
Get	Sends a GET request to the server.
Post	Sends a POST request to the server.
Put	Sends a PUT request to the server.
Reset	Reset the class.
SendCustomRequest	Sends a custom request to the server.
SendNotification	Sends a notification to all clients observing a given resource.
SendResponse	Sends a response for a given pending request to the corresponding client.
StartListening	This method starts listening for incoming connections.
StartObserving	Registers the class as an observer for a given resource.
StopListening	This method stops listening for new connections.
StopObserving	Unregisters the class as an observer for a given resource.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


Error	Information about errors during data delivery.
Log	Fires once for each log message.
Notification	Fires when a notification is received from the server.
Register	Fires when a client wishes to register for notifications.
Request	Fires when a request is received from a client.
RequestComplete	Fires when a request completes.
ResponseComplete	Fires when a response has been sent to a client.
Unregistered	Fires when a client has unregistered from notifications.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


CaptureIPPacketInfo	Used to capture the packet information.
DelayHostResolution	Whether the hostname is resolved when RemoteHost is set.
DestinationAddress	Used to get the destination address from the packet information.
DontFragment	Used to set the Don't Fragment flag of outgoing packets.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxPacketSize	The maximum length of the packets that can be received.
QOSDSCPValue	Used to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficType	Used to specify QOS/DSCP settings (optional).
ShareLocalPort	If set to True, allows more than one instance of the class to be active on the same local port.
SourceIPAddress	Used to set the source IP address used when sending a packet.
SourceMacAddress	Used to set the source MAC address used when sending a packet.
UseConnection	Determines whether to use a connected socket.
UseIPv6	Whether or not to use IPv6.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

Listening Property (CoAP Class)

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

Syntax

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

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

int ipworksiot_coap_getlistening(void* lpObj);
int ipworksiot_coap_setlistening(void* lpObj, int bListening);

bool GetListening();
int SetListening(bool bListening);

Default Value

FALSE

Remarks

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

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

When this property is true, 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.

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 calling StartListening. Otherwise the system will choose a port at random.

Note: Use the StartListening and StopListening methods to control whether the class is listening.

This property is not available at design time.

Data Type

Boolean

LocalHost Property (CoAP Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksiot_coap_getlocalhost(void* lpObj);
int ipworksiot_coap_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (CoAP Class)

The UDP port in the local host where UDP binds.

Syntax

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworksiot_coap_getlocalport(void* lpObj);
int ipworksiot_coap_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

Remarks

The LocalPort property must be set before UDP is activated (Active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the TCP/IP stack to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.

LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.

The LocalPort property is useful when trying to connect to services that require a trusted port in the client side.

Data Type

Integer

PendingRequestCount Property (CoAP Class)

The number of records in the PendingRequest arrays.

Syntax

ANSI (Cross Platform)
int GetPendingRequestCount();

Unicode (Windows)
INT GetPendingRequestCount();

int ipworksiot_coap_getpendingrequestcount(void* lpObj);

int GetPendingRequestCount();

Default Value

Remarks

This property controls the size of the following arrays:

PendingRequestId
PendingRequestMethod
PendingRequestRemoteHost
PendingRequestRemotePort
PendingRequestToken
PendingRequestURI

The array indices start at 0 and end at PendingRequestCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

PendingRequestMethod Property (CoAP Class)

The request's method.

Syntax

ANSI (Cross Platform)
int GetPendingRequestMethod(int iPendingRequestIndex);

Unicode (Windows)
INT GetPendingRequestMethod(INT iPendingRequestIndex);

int ipworksiot_coap_getpendingrequestmethod(void* lpObj, int pendingrequestindex);

int GetPendingRequestMethod(int iPendingRequestIndex);

Default Value

Remarks

The request's method.

This property reflects the request's method code, which must be a value in the range 0 to 31. The following table provides a (non-exhaustive) list of some of the more common method codes; refer to the IANA's CoAP Method Codes registry for a full list.


Method Code	Name
`1`	GET
`2`	POST
`3`	PUT
`4`	DELETE
`5`	FETCH
`6`	PATCH

The PendingRequestIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PendingRequestCount property.

This property is read-only and not available at design time.

Data Type

Integer

PendingRequestRemoteHost Property (CoAP Class)

The remote host associated with the request.

Syntax

ANSI (Cross Platform)
char* GetPendingRequestRemoteHost(int iPendingRequestIndex);

Unicode (Windows)
LPWSTR GetPendingRequestRemoteHost(INT iPendingRequestIndex);

char* ipworksiot_coap_getpendingrequestremotehost(void* lpObj, int pendingrequestindex);

QString GetPendingRequestRemoteHost(int iPendingRequestIndex);

Default Value

Remarks

The remote host associated with the request.

This property reflects the remote host associated with the request. When the class is operating in client mode (i.e., the Listening property is disabled), this is the remote host to which the request was sent; when the class is operating in server mode (i.e., the Listening property is enabled), this is the remote host from which the request was received.

The PendingRequestIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PendingRequestCount property.

This property is read-only and not available at design time.

Data Type

String

PendingRequestRemotePort Property (CoAP Class)

The remote port associated with the request.

Syntax

ANSI (Cross Platform)
int GetPendingRequestRemotePort(int iPendingRequestIndex);

Unicode (Windows)
INT GetPendingRequestRemotePort(INT iPendingRequestIndex);

int ipworksiot_coap_getpendingrequestremoteport(void* lpObj, int pendingrequestindex);

int GetPendingRequestRemotePort(int iPendingRequestIndex);

Default Value

Remarks

The remote port associated with the request.

This property reflects the remote port associated with the request. Refer to the PendingRequestRemoteHost property's documentation for more information.

The PendingRequestIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PendingRequestCount property.

This property is read-only and not available at design time.

Data Type

Integer

PendingRequestId Property (CoAP Class)

The request's Id.

Syntax

ANSI (Cross Platform)
char* GetPendingRequestId(int iPendingRequestIndex);

Unicode (Windows)
LPWSTR GetPendingRequestId(INT iPendingRequestIndex);

char* ipworksiot_coap_getpendingrequestid(void* lpObj, int pendingrequestindex);

QString GetPendingRequestId(int iPendingRequestIndex);

Default Value

Remarks

The request's Id.

This property reflects the request's class-generated Id.

The PendingRequestIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PendingRequestCount property.

This property is read-only and not available at design time.

Data Type

String

PendingRequestToken Property (CoAP Class)

The request's token.

Syntax

ANSI (Cross Platform)
int GetPendingRequestToken(int iPendingRequestIndex, char* &lpPendingRequestToken, int &lenPendingRequestToken);

Unicode (Windows)
INT GetPendingRequestToken(INT iPendingRequestIndex, LPSTR &lpPendingRequestToken, INT &lenPendingRequestToken);

int ipworksiot_coap_getpendingrequesttoken(void* lpObj, int pendingrequestindex, char** lpPendingRequestToken, int* lenPendingRequestToken);

QByteArray GetPendingRequestToken(int iPendingRequestIndex);

Default Value

Remarks

The request's token.

This property reflects the request's token.

The PendingRequestIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PendingRequestCount property.

This property is read-only and not available at design time.

Data Type

Binary String

PendingRequestURI Property (CoAP Class)

The request URI.

Syntax

ANSI (Cross Platform)
char* GetPendingRequestURI(int iPendingRequestIndex);

Unicode (Windows)
LPWSTR GetPendingRequestURI(INT iPendingRequestIndex);

char* ipworksiot_coap_getpendingrequesturi(void* lpObj, int pendingrequestindex);

QString GetPendingRequestURI(int iPendingRequestIndex);

Default Value

Remarks

The request URI.

This property reflects the request's URI.

The PendingRequestIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PendingRequestCount property.

This property is read-only and not available at design time.

Data Type

String

RequestContentFormat Property (CoAP Class)

The request content format.

Syntax

ANSI (Cross Platform)
int GetRequestContentFormat();
int SetRequestContentFormat(int iRequestContentFormat);

Unicode (Windows)
INT GetRequestContentFormat();
INT SetRequestContentFormat(INT iRequestContentFormat);

int ipworksiot_coap_getrequestcontentformat(void* lpObj);
int ipworksiot_coap_setrequestcontentformat(void* lpObj, int iRequestContentFormat);

int GetRequestContentFormat();
int SetRequestContentFormat(int iRequestContentFormat);

Default Value

-1

Remarks

When the class is operating in client mode (i.e., the Listening property is disabled), this property specifies the content format that should be included in outgoing requests.

When the class is operating in server mode (i.e., the Listening property is enabled), this property is populated with the content format included in incoming requests (if any) anytime the Request event fires.

In either case, the valid set of values for this property is -1, or a value in the range 0 to 65535. -1 prevents a Content-Format option from being included when sending a request, or indicates that one was not included in a received response.

The following table provides a (non-exhaustive) list of some of the more common content formats; refer to the IANA's CoAP Content-Formats registry for a full list.


`-1` (default)	Content-Format option not included.
Value	Media Type	Encoding
`0`	text/plain; charset=utf-8
`40`	application/link-format
`41`	application/xml
`42`	application/octet-stream
`47`	application/exi
`50`	application/json
`51`	application/json-patch+json
`52`	application/merge-patch+json
`60`	application/cbor
`61`	application/cwt
`62`	application/multipart-core
`63`	application/cbor-seq
`11050`	application/json	deflate
`11060`	application/cbor	deflate

This property is not available at design time.

Data Type

Integer

RequestData Property (CoAP Class)

The request data.

Syntax

ANSI (Cross Platform)
int GetRequestData(char* &lpRequestData, int &lenRequestData);
int SetRequestData(const char* lpRequestData, int lenRequestData);

Unicode (Windows)
INT GetRequestData(LPSTR &lpRequestData, INT &lenRequestData);
INT SetRequestData(LPCSTR lpRequestData, INT lenRequestData);

int ipworksiot_coap_getrequestdata(void* lpObj, char** lpRequestData, int* lenRequestData);
int ipworksiot_coap_setrequestdata(void* lpObj, const char* lpRequestData, int lenRequestData);

QByteArray GetRequestData();
int SetRequestData(QByteArray qbaRequestData);

Default Value

Remarks

When the class is operating in client mode (i.e., the Listening property is disabled), this property specifies the data that should be included in requests sent using Post, Put, or SendCustomRequest.

When the class is operating in server mode (i.e., the Listening property is enabled), this property is populated with the data included in incoming requests (if any) anytime the Request event fires.

This property is not available at design time.

Data Type

Binary String

RequestETag Property (CoAP Class)

The request ETag.

Syntax

ANSI (Cross Platform)
int GetRequestETag(char* &lpRequestETag, int &lenRequestETag);
int SetRequestETag(const char* lpRequestETag, int lenRequestETag);

Unicode (Windows)
INT GetRequestETag(LPSTR &lpRequestETag, INT &lenRequestETag);
INT SetRequestETag(LPCSTR lpRequestETag, INT lenRequestETag);

int ipworksiot_coap_getrequestetag(void* lpObj, char** lpRequestETag, int* lenRequestETag);
int ipworksiot_coap_setrequestetag(void* lpObj, const char* lpRequestETag, int lenRequestETag);

QByteArray GetRequestETag();
int SetRequestETag(QByteArray qbaRequestETag);

Default Value

Remarks

When the class is operating in client mode (i.e., the Listening property is disabled), this property specifies the ETag that should be included in outgoing requests. Leave it empty to prevent an Etag option from being included.

When the class is operating in server mode (i.e., the Listening property is enabled), this property is populated with the ETag included in incoming requests (if any) anytime the Request event fires. It will be empty if an Etag option was not included.

This property is not available at design time.

Data Type

Binary String

RequestOptionCount Property (CoAP Class)

The number of records in the RequestOption arrays.

Syntax

ANSI (Cross Platform)
int GetRequestOptionCount();
int SetRequestOptionCount(int iRequestOptionCount);

Unicode (Windows)
INT GetRequestOptionCount();
INT SetRequestOptionCount(INT iRequestOptionCount);

int ipworksiot_coap_getrequestoptioncount(void* lpObj);
int ipworksiot_coap_setrequestoptioncount(void* lpObj, int iRequestOptionCount);

int GetRequestOptionCount();
int SetRequestOptionCount(int iRequestOptionCount);

Default Value

Remarks

This property controls the size of the following arrays:

RequestOptionCritical
RequestOptionNoCacheKey
RequestOptionNumber
RequestOptionUnsafe
RequestOptionValue
RequestOptionValueType

The array indices start at 0 and end at RequestOptionCount - 1.

This property is not available at design time.

Data Type

Integer

RequestOptionCritical Property (CoAP Class)

Whether the option is critical.

Syntax

ANSI (Cross Platform)
int GetRequestOptionCritical(int iRequestOptionIndex);

Unicode (Windows)
BOOL GetRequestOptionCritical(INT iRequestOptionIndex);

int ipworksiot_coap_getrequestoptioncritical(void* lpObj, int requestoptionindex);

bool GetRequestOptionCritical(int iRequestOptionIndex);

Default Value

FALSE

Remarks

Whether the option is critical.

This property reflects whether the option is critical or elective. Receivers that do not recognize a critical option must return a 4.02 "Bad Option" response code back to the sender. Unrecognized elective options can be safely ignored.

The RequestOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestOptionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

RequestOptionNoCacheKey Property (CoAP Class)

Whether the option is to be excluded from the cache-key.

Syntax

ANSI (Cross Platform)
int GetRequestOptionNoCacheKey(int iRequestOptionIndex);

Unicode (Windows)
BOOL GetRequestOptionNoCacheKey(INT iRequestOptionIndex);

int ipworksiot_coap_getrequestoptionnocachekey(void* lpObj, int requestoptionindex);

bool GetRequestOptionNoCacheKey(int iRequestOptionIndex);

Default Value

FALSE

Remarks

Whether the option is to be excluded from the cache-key.

This property reflects whether the option should be excluded from any cache-key calculations. This information is generally only needed for caching and proxying.

The RequestOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestOptionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

RequestOptionNumber Property (CoAP Class)

The option's number.

Syntax

ANSI (Cross Platform)
int GetRequestOptionNumber(int iRequestOptionIndex);
int SetRequestOptionNumber(int iRequestOptionIndex, int iRequestOptionNumber);

Unicode (Windows)
INT GetRequestOptionNumber(INT iRequestOptionIndex);
INT SetRequestOptionNumber(INT iRequestOptionIndex, INT iRequestOptionNumber);

int ipworksiot_coap_getrequestoptionnumber(void* lpObj, int requestoptionindex);
int ipworksiot_coap_setrequestoptionnumber(void* lpObj, int requestoptionindex, int iRequestOptionNumber);

int GetRequestOptionNumber(int iRequestOptionIndex);
int SetRequestOptionNumber(int iRequestOptionIndex, int iRequestOptionNumber);

Default Value

Remarks

The option's number.

The property reflects the option's number, which must be a value in the range 0 to 65535 (inclusive). Setting this property to a recognized option number (see table below) will automatically set the RequestOptionValueType property to the correct value (it should be set manually otherwise).

The following table provides a (non-exhaustive) list of some of the more common option numbers; refer to the IANA's CoAP Option Numbers registry for a full list.


Number	Option
`1`	If-Match
`3`	Uri-Host
`4`	ETag
`5`	If-None-Match
`6`	Observe
`7`	Uri-Port
`8`	Location-Path
`11`	Uri-Path
`12`	Content-Format
`14`	Max-Age
`15`	Uri-Query
`17`	Accept
`20`	Location-Query
`23`	Block2
`27`	Block1
`35`	Proxy-Uri
`39`	Proxy-Scheme
`60`	Size1

The RequestOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestOptionCount property.

This property is not available at design time.

Data Type

Integer

RequestOptionUnsafe Property (CoAP Class)

Whether the option is unsafe to forward.

Syntax

ANSI (Cross Platform)
int GetRequestOptionUnsafe(int iRequestOptionIndex);

Unicode (Windows)
BOOL GetRequestOptionUnsafe(INT iRequestOptionIndex);

int ipworksiot_coap_getrequestoptionunsafe(void* lpObj, int requestoptionindex);

bool GetRequestOptionUnsafe(int iRequestOptionIndex);

Default Value

FALSE

Remarks

Whether the option is unsafe to forward.

This property reflects whether the option is unsafe to forward. This information is generally only needed for proxying.

The RequestOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestOptionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

RequestOptionValue Property (CoAP Class)

The option's value.

Syntax

ANSI (Cross Platform)
char* GetRequestOptionValue(int iRequestOptionIndex);
int SetRequestOptionValue(int iRequestOptionIndex, const char* lpszRequestOptionValue);

Unicode (Windows)
LPWSTR GetRequestOptionValue(INT iRequestOptionIndex);
INT SetRequestOptionValue(INT iRequestOptionIndex, LPCWSTR lpszRequestOptionValue);

char* ipworksiot_coap_getrequestoptionvalue(void* lpObj, int requestoptionindex);
int ipworksiot_coap_setrequestoptionvalue(void* lpObj, int requestoptionindex, const char* lpszRequestOptionValue);

QString GetRequestOptionValue(int iRequestOptionIndex);
int SetRequestOptionValue(int iRequestOptionIndex, QString qsRequestOptionValue);

Default Value

Remarks

The option's value.

This property specifies the option's value. The RequestOptionValueType property specifies the data type of the value.

The RequestOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestOptionCount property.

This property is not available at design time.

Data Type

String

RequestOptionValueType Property (CoAP Class)

The option's value data type.

Syntax

ANSI (Cross Platform)
int GetRequestOptionValueType(int iRequestOptionIndex);
int SetRequestOptionValueType(int iRequestOptionIndex, int iRequestOptionValueType);

Unicode (Windows)
INT GetRequestOptionValueType(INT iRequestOptionIndex);
INT SetRequestOptionValueType(INT iRequestOptionIndex, INT iRequestOptionValueType);

Possible Values

OVT_STRING(0), 
OVT_UINT(1), 
OVT_BINARY(2)

int ipworksiot_coap_getrequestoptionvaluetype(void* lpObj, int requestoptionindex);
int ipworksiot_coap_setrequestoptionvaluetype(void* lpObj, int requestoptionindex, int iRequestOptionValueType);

int GetRequestOptionValueType(int iRequestOptionIndex);
int SetRequestOptionValueType(int iRequestOptionIndex, int iRequestOptionValueType);

Default Value

Remarks

The option's value data type.

This property specifies the data type of the option's RequestOptionValue. If RequestOptionNumber is set to a recognized value (refer to the table in its documentation), this property will automatically be set to the correct value. The table below shows the possible value types, their descriptions, and how to format the data assigned to RequestOptionValue.


Type	Description	Value Format
`ovtString (0)` (default)	String	String
`ovtUInt (1)`	Unsigned integer	0 to 4294967295
`ovtBinary (2)`	Binary data	Hex-encoded byte string

The RequestOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestOptionCount property.

This property is not available at design time.

Data Type

Integer

ResponseCode Property (CoAP Class)

The response code.

Syntax

ANSI (Cross Platform)
char* GetResponseCode();
int SetResponseCode(const char* lpszResponseCode);

Unicode (Windows)
LPWSTR GetResponseCode();
INT SetResponseCode(LPCWSTR lpszResponseCode);

char* ipworksiot_coap_getresponsecode(void* lpObj);
int ipworksiot_coap_setresponsecode(void* lpObj, const char* lpszResponseCode);

QString GetResponseCode();
int SetResponseCode(QString qsResponseCode);

Default Value

Remarks

When the class is operating in client mode (i.e., the Listening property is disabled), this property is populated with the response code included in incoming responses anytime the RequestComplete event fires.

When the class is operating in server mode (i.e., the Listening property is enabled), this property specifies the response code that should be included in outgoing responses (regardless of whether they are sent immediately after Request fires, or later using SendResponse or SendNotification).

In either case, the valid set of values for this property are strings of the format c.dd, where c is a class value in the range 2 to 7, and dd is a detail value in the range 00 to 31.

The following table provides a (non-exhaustive) list of some of the more common response codes; refer to the IANA's CoAP Response Codes registry for a full list.


Code	Description
`2.01`	Created
`2.02`	Deleted
`2.03`	Valid
`2.04`	Changed
`2.05`	Content
`2.31`	Continue
`4.00`	Bad Request
`4.01`	Unauthorized
`4.02`	Bad Option
`4.03`	Forbidden
`4.04`	Not Found
`4.12`	Precondition Failed
`5.00`	Internal Server Error
`5.01`	Not Implemented
`5.02`	Bad Gateway
`5.03`	Service Unavailable
`5.04`	Gateway Timeout

This property is not available at design time.

Data Type

String

ResponseContentFormat Property (CoAP Class)

The response content format.

Syntax

ANSI (Cross Platform)
int GetResponseContentFormat();
int SetResponseContentFormat(int iResponseContentFormat);

Unicode (Windows)
INT GetResponseContentFormat();
INT SetResponseContentFormat(INT iResponseContentFormat);

int ipworksiot_coap_getresponsecontentformat(void* lpObj);
int ipworksiot_coap_setresponsecontentformat(void* lpObj, int iResponseContentFormat);

int GetResponseContentFormat();
int SetResponseContentFormat(int iResponseContentFormat);

Default Value

-1

Remarks

When the class is operating in client mode (i.e., the Listening property is disabled), this property is populated with the content format included in incoming responses anytime the RequestComplete event fires.

When the class is operating in server mode (i.e., the Listening property is enabled), this property specifies the content format that should be included in outgoing responses (regardless of whether they are sent immediately after Request fires, or later using SendResponse or SendNotification).

In either case, the valid set of values for this property is -1, or a value in the range 0 to 65535. -1 prevents a Content-Format option from being included when sending a response, or indicates that one was not included in a received response.

The following table provides a (non-exhaustive) list of some of the more common content formats; refer to the IANA's CoAP Content-Formats registry for a full list.


`-1` (default)	Content-Format option not included.
Value	Media Type	Encoding
`0`	text/plain; charset=utf-8
`40`	application/link-format
`41`	application/xml
`42`	application/octet-stream
`47`	application/exi
`50`	application/json
`51`	application/json-patch+json
`52`	application/merge-patch+json
`60`	application/cbor
`61`	application/cwt
`62`	application/multipart-core
`63`	application/cbor-seq
`11050`	application/json	deflate
`11060`	application/cbor	deflate

This property is not available at design time.

Data Type

Integer

ResponseData Property (CoAP Class)

The response data.

Syntax

ANSI (Cross Platform)
int GetResponseData(char* &lpResponseData, int &lenResponseData);
int SetResponseData(const char* lpResponseData, int lenResponseData);

Unicode (Windows)
INT GetResponseData(LPSTR &lpResponseData, INT &lenResponseData);
INT SetResponseData(LPCSTR lpResponseData, INT lenResponseData);

int ipworksiot_coap_getresponsedata(void* lpObj, char** lpResponseData, int* lenResponseData);
int ipworksiot_coap_setresponsedata(void* lpObj, const char* lpResponseData, int lenResponseData);

QByteArray GetResponseData();
int SetResponseData(QByteArray qbaResponseData);

Default Value

Remarks

When the class is operating in client mode (i.e., the Listening property is disabled), this property is populated with the data included in incoming responses (if any) anytime the RequestComplete event fires.

When the class is operating in server mode (i.e., the Listening property is enabled), this property specifies the data that should be included in outgoing responses (regardless of whether they are sent immediately after Request fires, or later using SendResponse or SendNotification).

This property is not available at design time.

Data Type

Binary String

ResponseETag Property (CoAP Class)

The response ETag.

Syntax

ANSI (Cross Platform)
int GetResponseETag(char* &lpResponseETag, int &lenResponseETag);
int SetResponseETag(const char* lpResponseETag, int lenResponseETag);

Unicode (Windows)
INT GetResponseETag(LPSTR &lpResponseETag, INT &lenResponseETag);
INT SetResponseETag(LPCSTR lpResponseETag, INT lenResponseETag);

int ipworksiot_coap_getresponseetag(void* lpObj, char** lpResponseETag, int* lenResponseETag);
int ipworksiot_coap_setresponseetag(void* lpObj, const char* lpResponseETag, int lenResponseETag);

QByteArray GetResponseETag();
int SetResponseETag(QByteArray qbaResponseETag);

Default Value

Remarks

When the class is operating in client mode (i.e., the Listening property is disabled), this property is populated with the ETag included in incoming responses (if any) anytime the RequestComplete event fires. It will be empty if an Etag option was not included.

When the class is operating in server mode (i.e., the Listening property is enabled), this property specifies the ETag that should be included in outgoing responses (regardless of whether they are sent immediately after Request fires, or later using SendResponse or SendNotification). Leave it empty to prevent an Etag option from being included.

This property is not available at design time.

Data Type

Binary String

ResponseOptionCount Property (CoAP Class)

The number of records in the ResponseOption arrays.

Syntax

ANSI (Cross Platform)
int GetResponseOptionCount();
int SetResponseOptionCount(int iResponseOptionCount);

Unicode (Windows)
INT GetResponseOptionCount();
INT SetResponseOptionCount(INT iResponseOptionCount);

int ipworksiot_coap_getresponseoptioncount(void* lpObj);
int ipworksiot_coap_setresponseoptioncount(void* lpObj, int iResponseOptionCount);

int GetResponseOptionCount();
int SetResponseOptionCount(int iResponseOptionCount);

Default Value

Remarks

This property controls the size of the following arrays:

ResponseOptionCritical
ResponseOptionNoCacheKey
ResponseOptionNumber
ResponseOptionUnsafe
ResponseOptionValue
ResponseOptionValueType

The array indices start at 0 and end at ResponseOptionCount - 1.

This property is not available at design time.

Data Type

Integer

ResponseOptionCritical Property (CoAP Class)

Whether the option is critical.

Syntax

ANSI (Cross Platform)
int GetResponseOptionCritical(int iResponseOptionIndex);

Unicode (Windows)
BOOL GetResponseOptionCritical(INT iResponseOptionIndex);

int ipworksiot_coap_getresponseoptioncritical(void* lpObj, int responseoptionindex);

bool GetResponseOptionCritical(int iResponseOptionIndex);

Default Value

FALSE

Remarks

Whether the option is critical.

The ResponseOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResponseOptionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ResponseOptionNoCacheKey Property (CoAP Class)

Whether the option is to be excluded from the cache-key.

Syntax

ANSI (Cross Platform)
int GetResponseOptionNoCacheKey(int iResponseOptionIndex);

Unicode (Windows)
BOOL GetResponseOptionNoCacheKey(INT iResponseOptionIndex);

int ipworksiot_coap_getresponseoptionnocachekey(void* lpObj, int responseoptionindex);

bool GetResponseOptionNoCacheKey(int iResponseOptionIndex);

Default Value

FALSE

Remarks

Whether the option is to be excluded from the cache-key.

This property reflects whether the option should be excluded from any cache-key calculations. This information is generally only needed for caching and proxying.

The ResponseOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResponseOptionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ResponseOptionNumber Property (CoAP Class)

The option's number.

Syntax

ANSI (Cross Platform)
int GetResponseOptionNumber(int iResponseOptionIndex);
int SetResponseOptionNumber(int iResponseOptionIndex, int iResponseOptionNumber);

Unicode (Windows)
INT GetResponseOptionNumber(INT iResponseOptionIndex);
INT SetResponseOptionNumber(INT iResponseOptionIndex, INT iResponseOptionNumber);

int ipworksiot_coap_getresponseoptionnumber(void* lpObj, int responseoptionindex);
int ipworksiot_coap_setresponseoptionnumber(void* lpObj, int responseoptionindex, int iResponseOptionNumber);

int GetResponseOptionNumber(int iResponseOptionIndex);
int SetResponseOptionNumber(int iResponseOptionIndex, int iResponseOptionNumber);

Default Value

Remarks

The option's number.

The property reflects the option's number, which must be a value in the range 0 to 65535 (inclusive). Setting this property to a recognized option number (see table below) will automatically set the ResponseOptionValueType property to the correct value (it should be set manually otherwise).

The following table provides a (non-exhaustive) list of some of the more common option numbers; refer to the IANA's CoAP Option Numbers registry for a full list.


Number	Option
`1`	If-Match
`3`	Uri-Host
`4`	ETag
`5`	If-None-Match
`6`	Observe
`7`	Uri-Port
`8`	Location-Path
`11`	Uri-Path
`12`	Content-Format
`14`	Max-Age
`15`	Uri-Query
`17`	Accept
`20`	Location-Query
`23`	Block2
`27`	Block1
`35`	Proxy-Uri
`39`	Proxy-Scheme
`60`	Size1

The ResponseOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResponseOptionCount property.

This property is not available at design time.

Data Type

Integer

ResponseOptionUnsafe Property (CoAP Class)

Whether the option is unsafe to forward.

Syntax

ANSI (Cross Platform)
int GetResponseOptionUnsafe(int iResponseOptionIndex);

Unicode (Windows)
BOOL GetResponseOptionUnsafe(INT iResponseOptionIndex);

int ipworksiot_coap_getresponseoptionunsafe(void* lpObj, int responseoptionindex);

bool GetResponseOptionUnsafe(int iResponseOptionIndex);

Default Value

FALSE

Remarks

Whether the option is unsafe to forward.

This property reflects whether the option is unsafe to forward. This information is generally only needed for proxying.

The ResponseOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResponseOptionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ResponseOptionValue Property (CoAP Class)

The option's value.

Syntax

ANSI (Cross Platform)
char* GetResponseOptionValue(int iResponseOptionIndex);
int SetResponseOptionValue(int iResponseOptionIndex, const char* lpszResponseOptionValue);

Unicode (Windows)
LPWSTR GetResponseOptionValue(INT iResponseOptionIndex);
INT SetResponseOptionValue(INT iResponseOptionIndex, LPCWSTR lpszResponseOptionValue);

char* ipworksiot_coap_getresponseoptionvalue(void* lpObj, int responseoptionindex);
int ipworksiot_coap_setresponseoptionvalue(void* lpObj, int responseoptionindex, const char* lpszResponseOptionValue);

QString GetResponseOptionValue(int iResponseOptionIndex);
int SetResponseOptionValue(int iResponseOptionIndex, QString qsResponseOptionValue);

Default Value

Remarks

The option's value.

This property specifies the option's value. The ResponseOptionValueType property specifies the data type of the value.

The ResponseOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResponseOptionCount property.

This property is not available at design time.

Data Type

String

ResponseOptionValueType Property (CoAP Class)

The option's value data type.

Syntax

ANSI (Cross Platform)
int GetResponseOptionValueType(int iResponseOptionIndex);
int SetResponseOptionValueType(int iResponseOptionIndex, int iResponseOptionValueType);

Unicode (Windows)
INT GetResponseOptionValueType(INT iResponseOptionIndex);
INT SetResponseOptionValueType(INT iResponseOptionIndex, INT iResponseOptionValueType);

Possible Values

OVT_STRING(0), 
OVT_UINT(1), 
OVT_BINARY(2)

int ipworksiot_coap_getresponseoptionvaluetype(void* lpObj, int responseoptionindex);
int ipworksiot_coap_setresponseoptionvaluetype(void* lpObj, int responseoptionindex, int iResponseOptionValueType);

int GetResponseOptionValueType(int iResponseOptionIndex);
int SetResponseOptionValueType(int iResponseOptionIndex, int iResponseOptionValueType);

Default Value

Remarks

The option's value data type.

This property specifies the data type of the option's ResponseOptionValue. If ResponseOptionNumber is set to a recognized value (refer to the table in its documentation), this property will automatically be set to the correct value. The table below shows the possible value types, their descriptions, and how to format the data assigned to ResponseOptionValue.


Type	Description	Value Format
`ovtString (0)` (default)	String	String
`ovtUInt (1)`	Unsigned integer	0 to 4294967295
`ovtBinary (2)`	Binary data	Hex-encoded byte string

The ResponseOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResponseOptionCount property.

This property is not available at design time.

Data Type

Integer

Timeout Property (CoAP Class)

A timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworksiot_coap_gettimeout(void* lpObj);
int ipworksiot_coap_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

Remarks

This property specifies the number of seconds that the class should wait, synchronously, for a response to be received. A value of 0 means that the class will send the request data (when operating in client mode) or the response data (when operating in server mode) asynchronously, and then wait indefinitely, firing the applicable event once complete.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, ensuring that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the response has not yet been received, the class throws an exception.

Data Type

Integer

UseConfirmableMessages Property (CoAP Class)

Whether to use confirmable message.

Syntax

ANSI (Cross Platform)
int GetUseConfirmableMessages();
int SetUseConfirmableMessages(int bUseConfirmableMessages);

Unicode (Windows)
BOOL GetUseConfirmableMessages();
INT SetUseConfirmableMessages(BOOL bUseConfirmableMessages);

int ipworksiot_coap_getuseconfirmablemessages(void* lpObj);
int ipworksiot_coap_setuseconfirmablemessages(void* lpObj, int bUseConfirmableMessages);

bool GetUseConfirmableMessages();
int SetUseConfirmableMessages(bool bUseConfirmableMessages);

Default Value

TRUE

Remarks

This property specifies whether the class should send requests (if operating in client mode; i.e., when the Listening property is disabled) or responses (if operating in server mode; i.e., when the Listening property is enabled) using confirmable messages instead of unconfirmable messages.

Using confirmable messages increases reliability, since the class will automatically retransmit a message until it receives a confirmation from the remote host that the message was received. Note that the retransmission period is not infinite; eventually the class will assume that the message is undeliverable and time out the retransmission process.

Using non-confirmable messages reduces the amount of network traffic, but at the cost of reliability, since the class has no way to know whether a given message was received by the remote host, or lost in transit.

Data Type

Boolean

CancelRequest Method (CoAP Class)

Cancels a pending request.

Syntax

ANSI (Cross Platform)
int CancelRequest(const char* lpszRequestId);

Unicode (Windows)
INT CancelRequest(LPCWSTR lpszRequestId);

int ipworksiot_coap_cancelrequest(void* lpObj, const char* lpszRequestId);

int CancelRequest(const QString& qsRequestId);

Remarks

This method cancels the request in the PendingRequest* properties identified by RequestId.

When the class is operating in client mode, the requests in the PendingRequest* properties represent outgoing requests for which responses have not yet been received. Canceling one will cause the RequestComplete event to fire with an appropriate ErrorCode and ErrorDescription.

When the class is operating in server mode, the requests in the PendingRequest* properties represent incoming requests for which responses have not yet been sent. Canceling one will cause the ResponseComplete event to fire with an appropriate ErrorCode and ErrorDescription.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (CoAP Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksiot_coap_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Delete Method (CoAP Class)

Sends a DELETE request to the server.

Syntax

ANSI (Cross Platform)
char* Delete(const char* lpszURI);

Unicode (Windows)
LPWSTR Delete(LPCWSTR lpszURI);

char* ipworksiot_coap_delete(void* lpObj, const char* lpszURI);

QString Delete(const QString& qsURI);

Remarks

This method sends the server a DELETE request for the resource identified by URI. If the RequestETag property is non-empty, its value will be used to include an Etag option in the request. Any additional options present in the RequestOption* properties will be included as well.

The format of the URI parameter is coap://hostname:port/resource. The port is optional, and if not specified will default to 5683. For instance coap://myserver/test and coap://myserver:5683/test are equivalent.

If the UseConfirmableMessages property is enabled when this method is called, the class will automatically retransmit the request message (if necessary) until it receives confirmation from the server that it was received. Note that the retransmission period is not infinite; eventually the class will assume that the message is undeliverable and time out the request.

If the Timeout property is greater than 0, this method will block until either a response is received, the specified timeout interval elapses, or (if UseConfirmableMessages is enabled) the retransmission period elapses; whichever occurs first. It will then return empty string.

If the Timeout property is 0, a record of the request will be added to the PendingRequest* properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the CancelRequest method will cancel the request (assuming it is still pending at that time).

Once a response is received, or the request times out, the class will do the following:

Populate the Response* properties (unless the request timed out).
Remove the request record from the PendingRequest* properties, if necessary.
Fire the RequestComplete event.

Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).

Error Handling (C++)

DoEvents Method (CoAP Class)

Processes events from the internal message queue.

Syntax

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksiot_coap_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

Get Method (CoAP Class)

Sends a GET request to the server.

Syntax

ANSI (Cross Platform)
char* Get(const char* lpszURI);

Unicode (Windows)
LPWSTR Get(LPCWSTR lpszURI);

char* ipworksiot_coap_get(void* lpObj, const char* lpszURI);

QString Get(const QString& qsURI);

Remarks

This method sends the server a GET request for the resource identified by URI. If the RequestETag property is non-empty, its value will be used to include an Etag option in the request. Any additional options present in the RequestOption* properties will be included as well.

Once a response is received, or the request times out, the class will do the following:

Populate the Response* properties (unless the request timed out).
Remove the request record from the PendingRequest* properties, if necessary.
Fire the RequestComplete event.

Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).

Error Handling (C++)

Post Method (CoAP Class)

Sends a POST request to the server.

Syntax

ANSI (Cross Platform)
char* Post(const char* lpszURI);

Unicode (Windows)
LPWSTR Post(LPCWSTR lpszURI);

char* ipworksiot_coap_post(void* lpObj, const char* lpszURI);

QString Post(const QString& qsURI);

Remarks

This method sends the server a POST request for the resource identified by URI. The RequestData property specifies the data that will be sent in the request. If the RequestContentFormat and/or RequestETag properties are non-empty, their values will be used to include Content-Format and Etag options in the request (respectively). Any additional options present in the RequestOption* properties will be included as well.

Once a response is received, or the request times out, the class will do the following:

Populate the Response* properties (unless the request timed out).
Remove the request record from the PendingRequest* properties, if necessary.
Fire the RequestComplete event.

Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).

Error Handling (C++)

Put Method (CoAP Class)

Sends a PUT request to the server.

Syntax

ANSI (Cross Platform)
char* Put(const char* lpszURI);

Unicode (Windows)
LPWSTR Put(LPCWSTR lpszURI);

char* ipworksiot_coap_put(void* lpObj, const char* lpszURI);

QString Put(const QString& qsURI);

Remarks

This method sends the server a PUT request for the resource identified by URI. The RequestData property specifies the data that will be sent in the request. If the RequestContentFormat and/or RequestETag properties are non-empty, their values will be used to include Content-Format and Etag options in the request (respectively). Any additional options present in the RequestOption* properties will be included as well.

Once a response is received, or the request times out, the class will do the following:

Populate the Response* properties (unless the request timed out).
Remove the request record from the PendingRequest* properties, if necessary.
Fire the RequestComplete event.

Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).

Error Handling (C++)

Reset Method (CoAP Class)

Reset the class.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksiot_coap_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

SendCustomRequest Method (CoAP Class)

Sends a custom request to the server.

Syntax

ANSI (Cross Platform)
char* SendCustomRequest(const char* lpszURI, int iMethod);

Unicode (Windows)
LPWSTR SendCustomRequest(LPCWSTR lpszURI, INT iMethod);

char* ipworksiot_coap_sendcustomrequest(void* lpObj, const char* lpszURI, int iMethod);

QString SendCustomRequest(const QString& qsURI, int iMethod);

Remarks

This method sends the server a custom request for the resource identified by URI. The Method parameter specifies the request's method code. The following table provides a (non-exhaustive) list of some of the more common method codes; refer to the IANA's CoAP Method Codes registry for a full list.


Method Code	Name
`1`	GET
`2`	POST
`3`	PUT
`4`	DELETE
`5`	FETCH
`6`	PATCH

The RequestData property specifies the data that will be sent in the request. If the RequestContentFormat and/or RequestETag properties are non-empty, their values will be used to include Content-Format and Etag options in the request (respectively). Any additional options present in the RequestOption* properties will be included as well.

Once a response is received, or the request times out, the class will do the following:

Populate the Response* properties (unless the request timed out).
Remove the request record from the PendingRequest* properties, if necessary.
Fire the RequestComplete event.

Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).

Error Handling (C++)

SendNotification Method (CoAP Class)

Sends a notification to all clients observing a given resource.

Syntax

ANSI (Cross Platform)
int SendNotification(const char* lpszURI);

Unicode (Windows)
INT SendNotification(LPCWSTR lpszURI);

int ipworksiot_coap_sendnotification(void* lpObj, const char* lpszURI);

int SendNotification(const QString& qsURI);

Remarks

This method sends a notification to all clients observing the resource identified by URI, notifying them of its latest state. Clients should be notified whenever a resource's content changes (or periodically, if it changes very often) by sending a 2.xx response code; typically 2.03 "Valid" or 2.05 "Content". Clients should also be notified if a resource can no longer be observed (e.g., when it is deleted) by sending a notification with a non-2.xx response code (e.g., 4.04 "Not Found"). The class will automatically unregister all observers when a non-2.xx notification is sent.

The ResponseData property specifies the data that will be sent in the response, and the ResponseCode property specifies the response code. If the ResponseContentFormat and/or ResponseETag properties are non-empty, their values will be used to include Content-Format and Etag options in the response (respectively). Any additional options present in the ResponseOption* properties will be included as well.

If the UseConfirmableMessages property is enabled when this method is called, the class will automatically retransmit the response message (if necessary) until it receives confirmation from the client that it was received. Note that the retransmission period is not infinite; eventually the class will assume that the message is undeliverable and time out the response.

Note: This method can only be called when the class is operating in server mode (i.e., when the Listening property is enabled).

Error Handling (C++)

SendResponse Method (CoAP Class)

Sends a response for a given pending request to the corresponding client.

Syntax

ANSI (Cross Platform)
int SendResponse(const char* lpszRequestId);

Unicode (Windows)
INT SendResponse(LPCWSTR lpszRequestId);

int ipworksiot_coap_sendresponse(void* lpObj, const char* lpszRequestId);

int SendResponse(const QString& qsRequestId);

Remarks

This method sends a response for the request in the PendingRequest* properties identified by RequestId. The ResponseData property specifies the data that will be sent in the response, and the ResponseCode property specifies the response code. If the ResponseContentFormat and/or ResponseETag properties are non-empty, their values will be used to include Content-Format and Etag options in the response (respectively). Any additional options present in the ResponseOption* properties will be included as well.

If the UseConfirmableMessages property is disabled, the ResponseComplete event will fire immediately instead, since there is no way to know whether the client received the response.

Note: This method can only be called when the class is operating in server mode (i.e., when the Listening property is enabled).

Error Handling (C++)

StartListening Method (CoAP Class)

This method starts listening for incoming connections.

Syntax

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();

int ipworksiot_coap_startlistening(void* lpObj);

int StartListening();

Remarks

This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

Error Handling (C++)

StartObserving Method (CoAP Class)

Registers the class as an observer for a given resource.

Syntax

ANSI (Cross Platform)
char* StartObserving(const char* lpszURI);

Unicode (Windows)
LPWSTR StartObserving(LPCWSTR lpszURI);

char* ipworksiot_coap_startobserving(void* lpObj, const char* lpszURI);

QString StartObserving(const QString& qsURI);

Remarks

This method registers the class as an observer for the resource identified by URI. If the server accepts the registration, then it will periodically notify the class about any changes to the specified resource. These "change notifications" are exposed via the Notification event.

This method operates in the exact same manner as the Get method, with the exception of the two things listed below. Refer to the Get method's documentation for more information.

When constructing the request, the class automatically includes an Observe option. The presence of this option is what indicates to the server that the class wishes to register itself as an observer for the specified resource.
When the server receives the request, its response causes the Notification event to fire instead of the RequestComplete event. (Unless it decides to reject the registration, in which case it will handle the request just like a normal GET request, and the RequestComplete event will fire when its response is received, just like it would if Get had been called.)

Once the class has successfully registered itself as an observer, the server will continue to deliver change notifications for the specified resource until the class unregisters, or the resource can no longer be observed (e.g., if it is deleted). To unregister, either call the StopObserving method with the same URI value, or set the Notification event's StopObserving parameter to True.

Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).

Error Handling (C++)

StopListening Method (CoAP Class)

This method stops listening for new connections.

Syntax

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();

int ipworksiot_coap_stoplistening(void* lpObj);

int StopListening();

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

Error Handling (C++)

StopObserving Method (CoAP Class)

Unregisters the class as an observer for a given resource.

Syntax

ANSI (Cross Platform)
int StopObserving(const char* lpszURI);

Unicode (Windows)
INT StopObserving(LPCWSTR lpszURI);

int ipworksiot_coap_stopobserving(void* lpObj, const char* lpszURI);

int StopObserving(const QString& qsURI);

Remarks

This method unregisters the class as an observer for the resource identified by URI. This method operates in the exact same manner as the Get method, with the exception of the two things below; refer to the Get method's documentation for more information:

When constructing the request, the class automatically includes an Observe option with a value of 1. The presence of this option indicates to the server that the class wishes to unregister from further change notifications.
This method, unlike Get, does not return a request Id.

Note: This method can only be called when the class is operating in client mode (i.e., when the Listening property is disabled).

Error Handling (C++)

Error Event (CoAP Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(CoAPErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} CoAPErrorEventParams;


Unicode (Windows)
virtual INT FireError(CoAPErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} CoAPErrorEventParams;

#define EID_COAP_ERROR 1

virtual INT IPWORKSIOT_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class CoAPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(CoAPErrorEventParams *e);

// Or, subclass CoAP and override this emitter function.
virtual int FireError(CoAPErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (CoAP Class)

Fires once for each log message.

Syntax

ANSI (Cross Platform)
virtual int FireLog(CoAPLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  int reserved;
} CoAPLogEventParams;


Unicode (Windows)
virtual INT FireLog(CoAPLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  INT reserved;
} CoAPLogEventParams;

#define EID_COAP_LOG 2

virtual INT IPWORKSIOT_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage);

class CoAPLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(CoAPLogEventParams *e);

// Or, subclass CoAP and override this emitter function.
virtual int FireLog(CoAPLogEventParams *e) {...}

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of the Message. Possible values are:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data is logged.
3 (Debug)	Debug data is logged.

Notification Event (CoAP Class)

Fires when a notification is received from the server.

Syntax

ANSI (Cross Platform)
virtual int FireNotification(CoAPNotificationEventParams *e);

typedef struct {
  const char *URI;
  int IsLatest;
  int StopObserving;
  int reserved;
} CoAPNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(CoAPNotificationEventParams *e);

typedef struct {
  LPCWSTR URI;
  BOOL IsLatest;
  BOOL StopObserving;
  INT reserved;
} CoAPNotificationEventParams;

#define EID_COAP_NOTIFICATION 3

virtual INT IPWORKSIOT_CALL FireNotification(LPSTR &lpszURI, BOOL &bIsLatest, BOOL &bStopObserving);

class CoAPNotificationEventParams {
public:
  const QString &URI();

  bool IsLatest();

  bool StopObserving();
  void SetStopObserving(bool bStopObserving);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(CoAPNotificationEventParams *e);

// Or, subclass CoAP and override this emitter function.
virtual int FireNotification(CoAPNotificationEventParams *e) {...}

Remarks

This event fires when the class receives a notification from that server that some observed resource has changed. Query the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOption* properties to obtain the new resource information.

Note that, in some cases, the server may no longer be able to deliver notifications for a resource (e.g., if it is deleted). In such cases, the ResponseCode property will be populated with a non-2.xx code (e.g., 4.04 "Not Found") to indicate why the resource can no longer be observed. No further notifications will be delivered for the resource after such a notification arrives.

The URI parameter identifies the resource that has changed.

The IsLatest parameter reflects whether this notification actually has the most recent resource information available, since it is possible for notifications to arrive out of order under certain circumstances.

The StopObserving parameter specifies whether the class should stop observing the resource identified by URI. This parameter is False by default, set it to True to have the class unregister itself from further notifications. (Note: in the event of a non-2.xx notification, this parameter will be True by default instead, and changing it to False will have no effect.)

Note: This event is only used when the class is operating in client mode (i.e., when the Listening property is disabled).

Register Event (CoAP Class)

Fires when a client wishes to register for notifications.

Syntax

ANSI (Cross Platform)
virtual int FireRegister(CoAPRegisterEventParams *e);

typedef struct {
  const char *RemoteHost;
  int RemotePort;
  const char *URI;
  const char *URIHost;
  int URIPort;
  const char *URIPath;
  const char *URIQuery;
  const char *Token;
  int lenToken;
  int Accept;
  int reserved;
} CoAPRegisterEventParams;


Unicode (Windows)
virtual INT FireRegister(CoAPRegisterEventParams *e);

typedef struct {
  LPCWSTR RemoteHost;
  INT RemotePort;
  LPCWSTR URI;
  LPCWSTR URIHost;
  INT URIPort;
  LPCWSTR URIPath;
  LPCWSTR URIQuery;
  LPCSTR Token;
  INT lenToken;
  BOOL Accept;
  INT reserved;
} CoAPRegisterEventParams;

#define EID_COAP_REGISTER 4

virtual INT IPWORKSIOT_CALL FireRegister(LPSTR &lpszRemoteHost, INT &iRemotePort, LPSTR &lpszURI, LPSTR &lpszURIHost, INT &iURIPort, LPSTR &lpszURIPath, LPSTR &lpszURIQuery, LPSTR &lpToken, INT &lenToken, BOOL &bAccept);

class CoAPRegisterEventParams {
public:
  const QString &RemoteHost();

  int RemotePort();

  const QString &URI();

  const QString &URIHost();

  int URIPort();

  const QString &URIPath();

  const QString &URIQuery();

  const QByteArray &Token();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Register(CoAPRegisterEventParams *e);

// Or, subclass CoAP and override this emitter function.
virtual int FireRegister(CoAPRegisterEventParams *e) {...}

Remarks

This event fires anytime a client wishes to register itself as an observer for the resource identified by URI. Refer to the StartObserving and SendNotification methods, as well as the Notification event, for more information about observing resources and resource change notifications.

Any options included in the request can be obtained by querying the RequestOption* properties.

To correctly handle this event, populate the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOption* properties as desired before this event finishes. (This must be done regardless of the Accept parameter's final value; see below for more information on why).

The RemoteHost parameter reflects the client's IP address or hostname.

The RemotePort parameter reflects the client's port.

The URI parameter reflects the exact resource URI that the client wishes to observe (the CoAP specification states that the full URI must be used to track observers). This value must be passed exactly as-is to the SendNotification method to notify observers of changes to the resource.

The URIHost, URIPort, URIPath, and URIQuery parameters are provided for additional convenience

The Token parameter reflects the token included in the registration request.

The Accept parameter specifies whether the class should accept the registration. By default, it is False, and the request will be treated like a normal GET request. Setting it to True will cause the class to add the client to its internal list of registered observers for the specified URI.

Note: This event is only used when the class is operating in server mode (i.e., when the Listening property is enabled).

Request Event (CoAP Class)

Fires when a request is received from a client.

Syntax

ANSI (Cross Platform)
virtual int FireRequest(CoAPRequestEventParams *e);

typedef struct {
  const char *RemoteHost;
  int RemotePort;
  int Method;
  const char *URIHost;
  int URIPort;
  const char *URIPath;
  const char *URIQuery;
  const char *Token;
  int lenToken;
  const char *RequestId;
  int SendResponse;
  int reserved;
} CoAPRequestEventParams;


Unicode (Windows)
virtual INT FireRequest(CoAPRequestEventParams *e);

typedef struct {
  LPCWSTR RemoteHost;
  INT RemotePort;
  INT Method;
  LPCWSTR URIHost;
  INT URIPort;
  LPCWSTR URIPath;
  LPCWSTR URIQuery;
  LPCSTR Token;
  INT lenToken;
  LPCWSTR RequestId;
  BOOL SendResponse;
  INT reserved;
} CoAPRequestEventParams;

#define EID_COAP_REQUEST 5

virtual INT IPWORKSIOT_CALL FireRequest(LPSTR &lpszRemoteHost, INT &iRemotePort, INT &iMethod, LPSTR &lpszURIHost, INT &iURIPort, LPSTR &lpszURIPath, LPSTR &lpszURIQuery, LPSTR &lpToken, INT &lenToken, LPSTR &lpszRequestId, BOOL &bSendResponse);

class CoAPRequestEventParams {
public:
  const QString &RemoteHost();

  int RemotePort();

  int Method();

  const QString &URIHost();

  int URIPort();

  const QString &URIPath();

  const QString &URIQuery();

  const QByteArray &Token();

  const QString &RequestId();

  bool SendResponse();
  void SetSendResponse(bool bSendResponse);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Request(CoAPRequestEventParams *e);

// Or, subclass CoAP and override this emitter function.
virtual int FireRequest(CoAPRequestEventParams *e) {...}

Remarks

This event fires anytime a request is received from a client. Information about the request is exposed both via this event's parameters and the following properties: RequestData, RequestContentFormat, RequestETag, and RequestOption*.

A response can either be sent back to the client immediately when the event finishes, or later using the SendResponse method. Refer to the RequestId and SendResponse parameters' documentation, below, for more information. If a response is to be sent back immediately, populate the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOption* properties as desired before this event finishes.

The RemoteHost parameter reflects the client's IP address or hostname.

The RemotePort parameter reflects the client's port.

The Method parameter reflects the request method code. The following table provides a (non-exhaustive) list of some of the more common method codes; refer to the IANA's CoAP Method Codes registry for a full list.


Method Code	Name
`1`	GET
`2`	POST
`3`	PUT
`4`	DELETE
`5`	FETCH
`6`	PATCH

The URIHost, URIPort, URIPath, and URIQuery parameters, when taken together, identify the resource that the client is making a request against. This event exposes the URI in pieces for convenience.

The Token parameter reflects the token included in the request.

The RequestId parameter reflects the class-generated Id for the request. If the final value of the SendResponse parameter is False, this Id can be passed to the SendResponse method later to send a response. (Alternatively, it can be passed to the CancelRequest later to ignore the request.)

The SendResponse parameter specifies whether the class should send a response back to the client immediately; it is True by default. Set it to False to send the response later instead.

Note: This event is only used when the class is operating in server mode (i.e., when the Listening property is enabled).

RequestComplete Event (CoAP Class)

Fires when a request completes.

Syntax

ANSI (Cross Platform)
virtual int FireRequestComplete(CoAPRequestCompleteEventParams *e);

typedef struct {
  int Method;
  const char *URI;
  const char *RequestId;
  int ErrorCode;
  const char *ErrorDescription;
  int reserved;
} CoAPRequestCompleteEventParams;


Unicode (Windows)
virtual INT FireRequestComplete(CoAPRequestCompleteEventParams *e);

typedef struct {
  INT Method;
  LPCWSTR URI;
  LPCWSTR RequestId;
  INT ErrorCode;
  LPCWSTR ErrorDescription;
  INT reserved;
} CoAPRequestCompleteEventParams;

#define EID_COAP_REQUESTCOMPLETE 6

virtual INT IPWORKSIOT_CALL FireRequestComplete(INT &iMethod, LPSTR &lpszURI, LPSTR &lpszRequestId, INT &iErrorCode, LPSTR &lpszErrorDescription);

class CoAPRequestCompleteEventParams {
public:
  int Method();

  const QString &URI();

  const QString &RequestId();

  int ErrorCode();

  const QString &ErrorDescription();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void RequestComplete(CoAPRequestCompleteEventParams *e);

// Or, subclass CoAP and override this emitter function.
virtual int FireRequestComplete(CoAPRequestCompleteEventParams *e) {...}

Remarks

This event fires when a request completes. Usually, a request is considered complete when a response has been received. However, requests can also be considered "complete" if either of the following occurs:

If the UseConfirmableMessages property is enabled, and the class did not receive confirmation that the request was received before the retransmission period elapsed.
If Timeout property is greater than 0, and the class did not receive a response before the timeout period elapsed.

Assuming a response was received (i.e., the ErrorCode parameter is either 0 or 709; see below), then the response code, payload, and options can be obtained by querying the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOption* properties.


Method Code	Name
`1`	GET
`2`	POST
`3`	PUT
`4`	DELETE
`5`	FETCH
`6`	PATCH

The URI parameter reflects the requested resource's URI.

The ErrorCode parameter indicates whether the request encountered an error. If no error was encountered, it will be 0; if the server returned a non-2.xx response code, it will be 709; if some other error occurred (e.g., the request timed out), it will be another non-zero value.

The ErrorDescription parameter provides a description of the error that occurred (or, if ErrorCode is 709, a string version of the response code returned by the server). It will be empty if no error was encountered.

Note: This event is only used when the class is operating in client mode (i.e., when the Listening property is disabled).

ResponseComplete Event (CoAP Class)

Fires when a response has been sent to a client.

Syntax

ANSI (Cross Platform)
virtual int FireResponseComplete(CoAPResponseCompleteEventParams *e);

typedef struct {
  const char *RequestId;
  int ErrorCode;
  const char *ErrorDescription;
  int reserved;
} CoAPResponseCompleteEventParams;


Unicode (Windows)
virtual INT FireResponseComplete(CoAPResponseCompleteEventParams *e);

typedef struct {
  LPCWSTR RequestId;
  INT ErrorCode;
  LPCWSTR ErrorDescription;
  INT reserved;
} CoAPResponseCompleteEventParams;

#define EID_COAP_RESPONSECOMPLETE 7

virtual INT IPWORKSIOT_CALL FireResponseComplete(LPSTR &lpszRequestId, INT &iErrorCode, LPSTR &lpszErrorDescription);

class CoAPResponseCompleteEventParams {
public:
  const QString &RequestId();

  int ErrorCode();

  const QString &ErrorDescription();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ResponseComplete(CoAPResponseCompleteEventParams *e);

// Or, subclass CoAP and override this emitter function.
virtual int FireResponseComplete(CoAPResponseCompleteEventParams *e) {...}

Remarks

This event fires anytime a response has been sent to a client. If the UseConfirmableMessages property is enabled, then the response is considered complete once the client has confirmed that it received the response (or once the retransmission period elapses). If the UseConfirmableMessages property is disabled, the response is considered complete immediately (since there is no way to know if the client received it).

The RequestId parameter reflects the class-generated Id of the request for which the response was sent.

The ErrorCode parameter indicates whether the response encountered an error (e.g., transmission timed out). If no error was encountered, it will be 0.

The ErrorDescription parameter provides a description of the error that occurred. It will be empty if no error was encountered.

Note: This event is only used when the class is operating in server mode (i.e., when the Listening property is enabled).

Unregistered Event (CoAP Class)

Fires when a client has unregistered from notifications.

Syntax

ANSI (Cross Platform)
virtual int FireUnregistered(CoAPUnregisteredEventParams *e);

typedef struct {
  const char *RemoteHost;
  int RemotePort;
  const char *URI;
  const char *URIHost;
  int URIPort;
  const char *URIPath;
  const char *URIQuery;
  int reserved;
} CoAPUnregisteredEventParams;


Unicode (Windows)
virtual INT FireUnregistered(CoAPUnregisteredEventParams *e);

typedef struct {
  LPCWSTR RemoteHost;
  INT RemotePort;
  LPCWSTR URI;
  LPCWSTR URIHost;
  INT URIPort;
  LPCWSTR URIPath;
  LPCWSTR URIQuery;
  INT reserved;
} CoAPUnregisteredEventParams;

#define EID_COAP_UNREGISTERED 8

virtual INT IPWORKSIOT_CALL FireUnregistered(LPSTR &lpszRemoteHost, INT &iRemotePort, LPSTR &lpszURI, LPSTR &lpszURIHost, INT &iURIPort, LPSTR &lpszURIPath, LPSTR &lpszURIQuery);

class CoAPUnregisteredEventParams {
public:
  const QString &RemoteHost();

  int RemotePort();

  const QString &URI();

  const QString &URIHost();

  int URIPort();

  const QString &URIPath();

  const QString &URIQuery();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Unregistered(CoAPUnregisteredEventParams *e);

// Or, subclass CoAP and override this emitter function.
virtual int FireUnregistered(CoAPUnregisteredEventParams *e) {...}

Remarks

This event fires anytime a client has unregistered itself from further notifications for the resource identified by URI. Refer to the StartObserving and SendNotification methods, as well as the Notification and Register events, for more information about observing resources and resource change notifications.

The RemoteHost parameter reflects the client's IP address or hostname.

The RemotePort parameter reflects the client's port.

The URI parameter identifies the resource that the client has stopped observing.

The URIHost, URIPort, URIPath, and URIQuery parameters are provided for additional convenience

Note: This event is only used when the class is operating in server mode (i.e., when the Listening property is enabled).

Config Settings (CoAP Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

UDP Config Settings

CaptureIPPacketInfo: Used to capture the packet information.

If this is set to true, the component will capture the IP packet information.

The default value for this setting is False.

Note: This setting is only available in Windows.

DelayHostResolution: Whether the hostname is resolved when RemoteHost is set.

This setting specifies whether a hostname is resolved immediately when RemoteHost is set. If true the class will resolve the hostname and the IP address will be present in the RemoteHost property. If false, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may called to manually resolve the value in RemoteHost at any time.

The default value is false.

DestinationAddress: Used to get the destination address from the packet information.

If CaptureIPPacketInfo is set to true, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event.

Note: This setting is only available in Windows.

DontFragment: Used to set the Don't Fragment flag of outgoing packets.

When set to True, packets sent by the class will have the Don't Fragment flag set. The default value is False.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxPacketSize: The maximum length of the packets that can be received.

This setting specifies the maximum size of the datagrams that the class will accept without truncation.

QOSDSCPValue: Used to specify an arbitrary QOS/DSCP setting (optional).

UseConnection must be True to use this setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value the component will not set a DSCP value.

Note: This setting uses the qWAVE API is only available on Windows 7, Windows Server 2008 R2, and later.

QOSTrafficType: Used to specify QOS/DSCP settings (optional).

UseConnection must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).

Note: This setting uses the qWAVE API which is only available on Windows Vista and Windows Server 2008 or above.

Note: QOSTrafficType must be set before setting Active to true.

ShareLocalPort: If set to True, allows more than one instance of the class to be active on the same local port.

This option must be set before the class is activated through the Active property or it will have no effect.

The default value for this setting is False.

SourceIPAddress: Used to set the source IP address used when sending a packet.

This configuration setting can be used to override the source IP address when sending a packet.

Note: This setting is only available in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

SourceMacAddress: Used to set the source MAC address used when sending a packet.

This configuration setting can be used to override the source MAC address when sending a packet.

Note: This setting is only available in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

UseConnection: Determines whether to use a connected socket.

UseConnection specifies whether the class should use a connected socket or not. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional TCP sense. What it means is only that the class will send and receive data only to and from the specified destination.

The default value for this setting is False.

UseIPv6: Whether or not to use IPv6.

By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True.

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (CoAP Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CoAP Errors


	700 Invalid or malformed URI.
	701 Invalid or malformed option.
	702 Invalid block.
	703 Malformed message.
	704 Message transmission timed out.
	705 Message rejected by remote host.
	706 Invalid/unexpected request Id.
	707 Invalid response code.
	708 "Reset" message received from remote host.
	709 Error response received from server. Refer to the error message for more information.
	710 Observation not supported for the requested URI.
	711 Request canceled.
	712 The requested operation cannot be performed in the current mode.