CoAP Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksIoT_CoAP

Procedural Interface

 ipworksiot_coap_open();
 ipworksiot_coap_close($res);
 ipworksiot_coap_register_callback($res, $id, $function);
 ipworksiot_coap_get_last_error($res);
 ipworksiot_coap_get_last_error_code($res);
 ipworksiot_coap_set($res, $id, $index, $value);
 ipworksiot_coap_get($res, $id, $index);
 ipworksiot_coap_do_cancelrequest($res, $requestid);
 ipworksiot_coap_do_config($res, $configurationstring);
 ipworksiot_coap_do_delete($res, $uri);
 ipworksiot_coap_do_doevents($res);
 ipworksiot_coap_do_get($res, $uri);
 ipworksiot_coap_do_post($res, $uri);
 ipworksiot_coap_do_put($res, $uri);
 ipworksiot_coap_do_reset($res);
 ipworksiot_coap_do_sendcustomrequest($res, $uri, $method);
 ipworksiot_coap_do_sendnotification($res, $uri);
 ipworksiot_coap_do_sendresponse($res, $requestid);
 ipworksiot_coap_do_startlistening($res);
 ipworksiot_coap_do_startobserving($res, $uri);
 ipworksiot_coap_do_stoplistening($res);
 ipworksiot_coap_do_stopobserving($res, $uri);

Remarks

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

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.

By default, the component operates in NoSec mode as defined by RFC 7252. Certificate mode DTLS can be enabled by setting SSLEnabled to True. UseRawPublicKey can be used to enable Raw Public Key mode.

When DTLS is enabled, relevant handshake details will be reported by the SSLStatus event. Initially, the server will present its certificate to the client. The certificate is validated by the system and the status is provided within the SSLServerAuthentication event. If the Accept parameter of the SSLServerAuthentication event is false, the Status parameter will tell you why. You can then set the Accept parameter to true to manually force acceptance of the server certificate.

In some cases, the server requires the client to present a certificate as well. In this case, a valid certificate will need to be specified via the SSLCert property. This process may look like the following:

coapclient.OnSSLServerAuthentication += (o, e) => { if (e.Accept) return; Console.Write("Server provided the following certificate:\nIssuer: " + e.CertIssuer + "\nSubject: " + e.CertSubject + "\n"); Console.Write("The following problems have been determined for this certificate: " + e.Status + "\n"); Console.Write("Would you like to accept anyways? [y/n] "); if (Console.Read() == 'y') e.Accept = true; }; coapclient.SSLEnabled = true; coapclient.RemoteHost = "remote_ip"; coapclient.RemotePort = 1234; coapclient.Timeout = 30; // if client authentication is applicable coapclient.SSLCert = new Certificate("/path/to/cert.pfx", CertStoreTypes.cstPFXFile, "cert_password", "cert_subject"); To send a request, populate the RequestData, RequestContentFormat, RequestETag, and RequestOptions 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 ResponseOptions 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 ResponseOptions 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 RequestOptions properties will be populated, and the Request event will fire.

By default, the component operates in NoSec mode as defined by RFC 7252. Certificate mode DTLS can be enabled by setting SSLEnabled to True. UseRawPublicKey can be used to enable Raw Public Key mode.

When DTLS is enabled, a valid certificate must be selected before the server can start listening for incoming connections. The certificate can be specified via the SSLCert property. Note the certificate must contain a private key.

After doing so, calling StartListening will cause the class to start listening for incoming connections. The class will listen on the interface defined by LocalHost and LocalPort, if specified. Otherwise, these values will be set by the class. If applicable, these values must be set before calling StartListening. For example:

//coapserver.LocalHost = "some_ip_address"; //coapserver.LocalPort = 1234; coapserver.SSLCert = new Certificate("/path/to/cert.pfx", CertStoreTypes.cstPFXFile, "cert_password", "cert_subject"); coapserver.StartListening(); Console.WriteLine("Listening on: " + coapserver.LocalHost + ":" + coapserver.LocalPort); while (coapserver.Listening) { coapserver.DoEvents(); }

A response can be sent by populating the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOptions 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 ResponseOptions 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.

Method List

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

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.

Config Settings

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

Listening Property (IPWorksIoT_CoAP Class)

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

Object Oriented Interface

public function getListening();
public function setListening($value);

Procedural Interface

ipworksiot_coap_get($res, 1 );
ipworksiot_coap_set($res, 1, $value );

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.

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 (IPWorksIoT_CoAP Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworksiot_coap_get($res, 2 );
ipworksiot_coap_set($res, 2, $value );

Default Value

''

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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 multihomed 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 (IPWorksIoT_CoAP Class)

This property includes the User Datagram Protocol (UDP) port in the local host where UDP binds.

Object Oriented Interface

public function getLocalPort();
public function setLocalPort($value);

Procedural Interface

ipworksiot_coap_get($res, 3 );
ipworksiot_coap_set($res, 3, $value );

Default Value

0

Remarks

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

Setting it to 0 (default) enables the Transmission Control Protocol (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 on the client side.

Data Type

Integer

PendingRequestCount Property (IPWorksIoT_CoAP Class)

The number of records in the PendingRequest arrays.

Object Oriented Interface

public function getPendingRequestCount();

Procedural Interface

ipworksiot_coap_get($res, 4 );

Default Value

0

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 (IPWorksIoT_CoAP Class)

The request's method.

Object Oriented Interface

public function getPendingRequestMethod($pendingrequestindex);

Procedural Interface

ipworksiot_coap_get($res, 5 , $pendingrequestindex);

Default Value

0

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.

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 (IPWorksIoT_CoAP Class)

The remote host associated with the request.

Object Oriented Interface

public function getPendingRequestRemoteHost($pendingrequestindex);

Procedural Interface

ipworksiot_coap_get($res, 6 , $pendingrequestindex);

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 (IPWorksIoT_CoAP Class)

The remote port associated with the request.

Object Oriented Interface

public function getPendingRequestRemotePort($pendingrequestindex);

Procedural Interface

ipworksiot_coap_get($res, 7 , $pendingrequestindex);

Default Value

0

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 (IPWorksIoT_CoAP Class)

The request's Id.

Object Oriented Interface

public function getPendingRequestId($pendingrequestindex);

Procedural Interface

ipworksiot_coap_get($res, 8 , $pendingrequestindex);

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 (IPWorksIoT_CoAP Class)

The request's token.

Object Oriented Interface

public function getPendingRequestToken($pendingrequestindex);

Procedural Interface

ipworksiot_coap_get($res, 9 , $pendingrequestindex);

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 (IPWorksIoT_CoAP Class)

The request URI.

Object Oriented Interface

public function getPendingRequestURI($pendingrequestindex);

Procedural Interface

ipworksiot_coap_get($res, 10 , $pendingrequestindex);

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 (IPWorksIoT_CoAP Class)

The request content format.

Object Oriented Interface

public function getRequestContentFormat();
public function setRequestContentFormat($value);

Procedural Interface

ipworksiot_coap_get($res, 11 );
ipworksiot_coap_set($res, 11, $value );

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.

This property is not available at design time.

Data Type

Integer

RequestData Property (IPWorksIoT_CoAP Class)

The request data.

Object Oriented Interface

public function getRequestData();
public function setRequestData($value);

Procedural Interface

ipworksiot_coap_get($res, 12 );
ipworksiot_coap_set($res, 12, $value );

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 (IPWorksIoT_CoAP Class)

The request ETag.

Object Oriented Interface

public function getRequestETag();
public function setRequestETag($value);

Procedural Interface

ipworksiot_coap_get($res, 13 );
ipworksiot_coap_set($res, 13, $value );

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 (IPWorksIoT_CoAP Class)

The number of records in the RequestOption arrays.

Object Oriented Interface

public function getRequestOptionCount();
public function setRequestOptionCount($value);

Procedural Interface

ipworksiot_coap_get($res, 14 );
ipworksiot_coap_set($res, 14, $value );

Default Value

0

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 (IPWorksIoT_CoAP Class)

Whether the option is critical.

Object Oriented Interface

public function getRequestOptionCritical($requestoptionindex);

Procedural Interface

ipworksiot_coap_get($res, 15 , $requestoptionindex);

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 (IPWorksIoT_CoAP Class)

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

Object Oriented Interface

public function getRequestOptionNoCacheKey($requestoptionindex);

Procedural Interface

ipworksiot_coap_get($res, 16 , $requestoptionindex);

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 (IPWorksIoT_CoAP Class)

The option's number.

Object Oriented Interface

public function getRequestOptionNumber($requestoptionindex);
public function setRequestOptionNumber($requestoptionindex, $value);

Procedural Interface

ipworksiot_coap_get($res, 17 , $requestoptionindex);
ipworksiot_coap_set($res, 17, $value , $requestoptionindex);

Default Value

0

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.

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 (IPWorksIoT_CoAP Class)

Whether the option is unsafe to forward.

Object Oriented Interface

public function getRequestOptionUnsafe($requestoptionindex);

Procedural Interface

ipworksiot_coap_get($res, 18 , $requestoptionindex);

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 (IPWorksIoT_CoAP Class)

The option's value.

Object Oriented Interface

public function getRequestOptionValue($requestoptionindex);
public function setRequestOptionValue($requestoptionindex, $value);

Procedural Interface

ipworksiot_coap_get($res, 19 , $requestoptionindex);
ipworksiot_coap_set($res, 19, $value , $requestoptionindex);

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 (IPWorksIoT_CoAP Class)

The option's value data type.

Object Oriented Interface

public function getRequestOptionValueType($requestoptionindex);
public function setRequestOptionValueType($requestoptionindex, $value);

Procedural Interface

ipworksiot_coap_get($res, 20 , $requestoptionindex);
ipworksiot_coap_set($res, 20, $value , $requestoptionindex);

Default Value

0

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.

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 (IPWorksIoT_CoAP Class)

The response code.

Object Oriented Interface

public function getResponseCode();
public function setResponseCode($value);

Procedural Interface

ipworksiot_coap_get($res, 21 );
ipworksiot_coap_set($res, 21, $value );

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.

This property is not available at design time.

Data Type

String

ResponseContentFormat Property (IPWorksIoT_CoAP Class)

The response content format.

Object Oriented Interface

public function getResponseContentFormat();
public function setResponseContentFormat($value);

Procedural Interface

ipworksiot_coap_get($res, 22 );
ipworksiot_coap_set($res, 22, $value );

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.

This property is not available at design time.

Data Type

Integer

ResponseData Property (IPWorksIoT_CoAP Class)

The response data.

Object Oriented Interface

public function getResponseData();
public function setResponseData($value);

Procedural Interface

ipworksiot_coap_get($res, 23 );
ipworksiot_coap_set($res, 23, $value );

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 (IPWorksIoT_CoAP Class)

The response ETag.

Object Oriented Interface

public function getResponseETag();
public function setResponseETag($value);

Procedural Interface

ipworksiot_coap_get($res, 24 );
ipworksiot_coap_set($res, 24, $value );

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 (IPWorksIoT_CoAP Class)

The number of records in the ResponseOption arrays.

Object Oriented Interface

public function getResponseOptionCount();
public function setResponseOptionCount($value);

Procedural Interface

ipworksiot_coap_get($res, 25 );
ipworksiot_coap_set($res, 25, $value );

Default Value

0

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 (IPWorksIoT_CoAP Class)

Whether the option is critical.

Object Oriented Interface

public function getResponseOptionCritical($responseoptionindex);

Procedural Interface

ipworksiot_coap_get($res, 26 , $responseoptionindex);

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 $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 (IPWorksIoT_CoAP Class)

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

Object Oriented Interface

public function getResponseOptionNoCacheKey($responseoptionindex);

Procedural Interface

ipworksiot_coap_get($res, 27 , $responseoptionindex);

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 (IPWorksIoT_CoAP Class)

The option's number.

Object Oriented Interface

public function getResponseOptionNumber($responseoptionindex);
public function setResponseOptionNumber($responseoptionindex, $value);

Procedural Interface

ipworksiot_coap_get($res, 28 , $responseoptionindex);
ipworksiot_coap_set($res, 28, $value , $responseoptionindex);

Default Value

0

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.

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 (IPWorksIoT_CoAP Class)

Whether the option is unsafe to forward.

Object Oriented Interface

public function getResponseOptionUnsafe($responseoptionindex);

Procedural Interface

ipworksiot_coap_get($res, 29 , $responseoptionindex);

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 (IPWorksIoT_CoAP Class)

The option's value.

Object Oriented Interface

public function getResponseOptionValue($responseoptionindex);
public function setResponseOptionValue($responseoptionindex, $value);

Procedural Interface

ipworksiot_coap_get($res, 30 , $responseoptionindex);
ipworksiot_coap_set($res, 30, $value , $responseoptionindex);

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 (IPWorksIoT_CoAP Class)

The option's value data type.

Object Oriented Interface

public function getResponseOptionValueType($responseoptionindex);
public function setResponseOptionValueType($responseoptionindex, $value);

Procedural Interface

ipworksiot_coap_get($res, 31 , $responseoptionindex);
ipworksiot_coap_set($res, 31, $value , $responseoptionindex);

Default Value

0

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.

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

SSLAcceptServerCertEffectiveDate Property (IPWorksIoT_CoAP Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksiot_coap_get($res, 32 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorksIoT_CoAP Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksiot_coap_get($res, 33 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorksIoT_CoAP Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksiot_coap_get($res, 34 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorksIoT_CoAP Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksiot_coap_get($res, 35 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorksIoT_CoAP Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksiot_coap_get($res, 36 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorksIoT_CoAP Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksiot_coap_get($res, 37 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorksIoT_CoAP Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksiot_coap_get($res, 38 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorksIoT_CoAP Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksiot_coap_get($res, 39 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksIoT_CoAP Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksiot_coap_get($res, 40 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorksIoT_CoAP Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksiot_coap_get($res, 41 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorksIoT_CoAP Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksiot_coap_get($res, 42 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorksIoT_CoAP Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksiot_coap_get($res, 43 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorksIoT_CoAP Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksiot_coap_get($res, 44 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorksIoT_CoAP Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksiot_coap_get($res, 45 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorksIoT_CoAP Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksiot_coap_get($res, 46 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorksIoT_CoAP Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworksiot_coap_get($res, 47 );
ipworksiot_coap_set($res, 47, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorksIoT_CoAP Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworksiot_coap_get($res, 48 );
ipworksiot_coap_set($res, 48, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (IPWorksIoT_CoAP Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworksiot_coap_get($res, 49 );
ipworksiot_coap_set($res, 49, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorksIoT_CoAP Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksiot_coap_get($res, 50 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksIoT_CoAP Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksiot_coap_get($res, 51 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorksIoT_CoAP Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksiot_coap_get($res, 52 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorksIoT_CoAP Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksiot_coap_get($res, 53 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorksIoT_CoAP Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksiot_coap_get($res, 54 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorksIoT_CoAP Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksiot_coap_get($res, 55 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorksIoT_CoAP Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksiot_coap_get($res, 56 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorksIoT_CoAP Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworksiot_coap_get($res, 57 );
ipworksiot_coap_set($res, 57, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorksIoT_CoAP Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksiot_coap_get($res, 58 );
ipworksiot_coap_set($res, 58, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLAuthenticateClients Property (IPWorksIoT_CoAP Class)

If set to True, the server asks the client(s) for a certificate.

Object Oriented Interface

public function getSSLAuthenticateClients();
public function setSSLAuthenticateClients($value);

Procedural Interface

ipworksiot_coap_get($res, 59 );
ipworksiot_coap_set($res, 59, $value );

Default Value

false

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

Data Type

Boolean

SSLCertEffectiveDate Property (IPWorksIoT_CoAP Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksiot_coap_get($res, 60 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorksIoT_CoAP Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksiot_coap_get($res, 61 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorksIoT_CoAP Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksiot_coap_get($res, 62 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorksIoT_CoAP Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksiot_coap_get($res, 63 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorksIoT_CoAP Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksiot_coap_get($res, 64 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorksIoT_CoAP Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksiot_coap_get($res, 65 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorksIoT_CoAP Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksiot_coap_get($res, 66 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorksIoT_CoAP Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksiot_coap_get($res, 67 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorksIoT_CoAP Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksiot_coap_get($res, 68 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorksIoT_CoAP Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksiot_coap_get($res, 69 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorksIoT_CoAP Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksiot_coap_get($res, 70 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorksIoT_CoAP Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksiot_coap_get($res, 71 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorksIoT_CoAP Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksiot_coap_get($res, 72 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorksIoT_CoAP Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksiot_coap_get($res, 73 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorksIoT_CoAP Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksiot_coap_get($res, 74 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorksIoT_CoAP Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworksiot_coap_get($res, 75 );
ipworksiot_coap_set($res, 75, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorksIoT_CoAP Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworksiot_coap_get($res, 76 );
ipworksiot_coap_set($res, 76, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (IPWorksIoT_CoAP Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworksiot_coap_get($res, 77 );
ipworksiot_coap_set($res, 77, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorksIoT_CoAP Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksiot_coap_get($res, 78 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksIoT_CoAP Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksiot_coap_get($res, 79 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorksIoT_CoAP Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksiot_coap_get($res, 80 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorksIoT_CoAP Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksiot_coap_get($res, 81 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorksIoT_CoAP Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksiot_coap_get($res, 82 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorksIoT_CoAP Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksiot_coap_get($res, 83 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorksIoT_CoAP Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksiot_coap_get($res, 84 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorksIoT_CoAP Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworksiot_coap_get($res, 85 );
ipworksiot_coap_set($res, 85, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (IPWorksIoT_CoAP Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworksiot_coap_get($res, 86 );
ipworksiot_coap_set($res, 86, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLEnabled Property (IPWorksIoT_CoAP Class)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Object Oriented Interface

public function getSSLEnabled();
public function setSSLEnabled($value);

Procedural Interface

ipworksiot_coap_get($res, 87 );
ipworksiot_coap_set($res, 87, $value );

Default Value

false

Remarks

This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

Data Type

Boolean

SSLServerCertEffectiveDate Property (IPWorksIoT_CoAP Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksiot_coap_get($res, 88 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorksIoT_CoAP Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksiot_coap_get($res, 89 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorksIoT_CoAP Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksiot_coap_get($res, 90 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorksIoT_CoAP Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksiot_coap_get($res, 91 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorksIoT_CoAP Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksiot_coap_get($res, 92 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorksIoT_CoAP Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksiot_coap_get($res, 93 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorksIoT_CoAP Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksiot_coap_get($res, 94 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorksIoT_CoAP Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksiot_coap_get($res, 95 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorksIoT_CoAP Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksiot_coap_get($res, 96 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorksIoT_CoAP Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksiot_coap_get($res, 97 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorksIoT_CoAP Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksiot_coap_get($res, 98 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorksIoT_CoAP Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksiot_coap_get($res, 99 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorksIoT_CoAP Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksiot_coap_get($res, 100 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorksIoT_CoAP Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksiot_coap_get($res, 101 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorksIoT_CoAP Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksiot_coap_get($res, 102 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorksIoT_CoAP Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworksiot_coap_get($res, 103 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorksIoT_CoAP Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworksiot_coap_get($res, 104 );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorksIoT_CoAP Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworksiot_coap_get($res, 105 );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorksIoT_CoAP Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksiot_coap_get($res, 106 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksIoT_CoAP Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksiot_coap_get($res, 107 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorksIoT_CoAP Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksiot_coap_get($res, 108 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorksIoT_CoAP Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksiot_coap_get($res, 109 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorksIoT_CoAP Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksiot_coap_get($res, 110 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorksIoT_CoAP Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksiot_coap_get($res, 111 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorksIoT_CoAP Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksiot_coap_get($res, 112 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorksIoT_CoAP Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworksiot_coap_get($res, 113 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorksIoT_CoAP Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksiot_coap_get($res, 114 );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

Timeout Property (IPWorksIoT_CoAP Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksiot_coap_get($res, 115 );
ipworksiot_coap_set($res, 115, $value );

Default Value

60

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 (IPWorksIoT_CoAP Class)

Whether to use confirmable message.

Object Oriented Interface

public function getUseConfirmableMessages();
public function setUseConfirmableMessages($value);

Procedural Interface

ipworksiot_coap_get($res, 116 );
ipworksiot_coap_set($res, 116, $value );

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 (IPWorksIoT_CoAP Class)

Cancels a pending request.

Object Oriented Interface

public function doCancelRequest($requestid);

Procedural Interface

ipworksiot_coap_do_cancelrequest($res, $requestid);

Remarks

This method cancels the request in the PendingRequests properties identified by RequestId.

When the class is operating in client mode, the requests in the PendingRequests 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 PendingRequests 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.

Config Method (IPWorksIoT_CoAP Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksiot_coap_do_config($res, $configurationstring);

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.

Delete Method (IPWorksIoT_CoAP Class)

Sends a DELETE request to the server.

Object Oriented Interface

public function doDelete($uri);

Procedural Interface

ipworksiot_coap_do_delete($res, $uri);

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 RequestOptions 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 PendingRequests 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 PendingRequests 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).

DoEvents Method (IPWorksIoT_CoAP Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksiot_coap_do_doevents($res);

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.

Get Method (IPWorksIoT_CoAP Class)

Sends a GET request to the server.

Object Oriented Interface

public function doGet($uri);

Procedural Interface

ipworksiot_coap_do_get($res, $uri);

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 RequestOptions 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 PendingRequests 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 PendingRequests 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).

Post Method (IPWorksIoT_CoAP Class)

Sends a POST request to the server.

Object Oriented Interface

public function doPost($uri);

Procedural Interface

ipworksiot_coap_do_post($res, $uri);

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 RequestOptions 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 PendingRequests 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 PendingRequests 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).

Put Method (IPWorksIoT_CoAP Class)

Sends a PUT request to the server.

Object Oriented Interface

public function doPut($uri);

Procedural Interface

ipworksiot_coap_do_put($res, $uri);

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 RequestOptions 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 PendingRequests 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 PendingRequests 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).

Reset Method (IPWorksIoT_CoAP Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksiot_coap_do_reset($res);

Remarks

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

SendCustomRequest Method (IPWorksIoT_CoAP Class)

Sends a custom request to the server.

Object Oriented Interface

public function doSendCustomRequest($uri, $method);

Procedural Interface

ipworksiot_coap_do_sendcustomrequest($res, $uri, $method);

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.

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 RequestOptions 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 PendingRequests 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 PendingRequests 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).

SendNotification Method (IPWorksIoT_CoAP Class)

Sends a notification to all clients observing a given resource.

Object Oriented Interface

public function doSendNotification($uri);

Procedural Interface

ipworksiot_coap_do_sendnotification($res, $uri);

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 ResponseOptions 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).

SendResponse Method (IPWorksIoT_CoAP Class)

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

Object Oriented Interface

public function doSendResponse($requestid);

Procedural Interface

ipworksiot_coap_do_sendresponse($res, $requestid);

Remarks

This method sends a response for the request in the PendingRequests 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 ResponseOptions 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. The ResponseComplete event will fire once the message receipt is confirmed (or once the retransmission period elapses).

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).

StartListening Method (IPWorksIoT_CoAP Class)

This method starts listening for incoming connections.

Object Oriented Interface

public function doStartListening();

Procedural Interface

ipworksiot_coap_do_startlistening($res);

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.

StartObserving Method (IPWorksIoT_CoAP Class)

Registers the class as an observer for a given resource.

Object Oriented Interface

public function doStartObserving($uri);

Procedural Interface

ipworksiot_coap_do_startobserving($res, $uri);

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.

1. 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.
2. 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).

StopListening Method (IPWorksIoT_CoAP Class)

This method stops listening for new connections.

Object Oriented Interface

public function doStopListening();

Procedural Interface

ipworksiot_coap_do_stoplistening($res);

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.

StopObserving Method (IPWorksIoT_CoAP Class)

Unregisters the class as an observer for a given resource.

Object Oriented Interface

public function doStopObserving($uri);

Procedural Interface

ipworksiot_coap_do_stopobserving($res, $uri);

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:

1. 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.
2. 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 Event (IPWorksIoT_CoAP Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksiot_coap_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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 (IPWorksIoT_CoAP Class)

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksiot_coap_register_callback($res, 2, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'

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:

Notification Event (IPWorksIoT_CoAP Class)

Fires when a notification is received from the server.

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

ipworksiot_coap_register_callback($res, 3, array($this, 'fireNotification'));

Parameter List

 'uri'
 'islatest'
 'stopobserving'

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 ResponseOptions 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 (IPWorksIoT_CoAP Class)

Fires when a client wishes to register for notifications.

Object Oriented Interface

public function fireRegister($param);

Procedural Interface

ipworksiot_coap_register_callback($res, 4, array($this, 'fireRegister'));

Parameter List

 'remotehost'
 'remoteport'
 'uri'
 'urihost'
 'uriport'
 'uripath'
 'uriquery'
 'token'
 'accept'

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 RequestOptions properties.

To correctly handle this event, populate the ResponseCode, ResponseData, ResponseContentFormat, ResponseETag, and ResponseOptions 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 (IPWorksIoT_CoAP Class)

Fires when a request is received from a client.

Object Oriented Interface

public function fireRequest($param);

Procedural Interface

ipworksiot_coap_register_callback($res, 5, array($this, 'fireRequest'));

Parameter List

 'remotehost'
 'remoteport'
 'method'
 'urihost'
 'uriport'
 'uripath'
 'uriquery'
 'token'
 'requestid'
 'sendresponse'

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 RequestOptions.

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 ResponseOptions 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.

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 (IPWorksIoT_CoAP Class)

Fires when a request completes.

Object Oriented Interface

public function fireRequestComplete($param);

Procedural Interface

ipworksiot_coap_register_callback($res, 6, array($this, 'fireRequestComplete'));

Parameter List

 'method'
 'uri'
 'requestid'
 'errorcode'
 'errordescription'

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 ResponseOptions properties.

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.

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 (IPWorksIoT_CoAP Class)

Fires when a response has been sent to a client.

Object Oriented Interface

public function fireResponseComplete($param);

Procedural Interface

ipworksiot_coap_register_callback($res, 7, array($this, 'fireResponseComplete'));

Parameter List

 'requestid'
 'errorcode'
 'errordescription'

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).

SSLClientAuthentication Event (IPWorksIoT_CoAP Class)

This event is fired when the client presents its credentials to the server.

Object Oriented Interface

public function fireSSLClientAuthentication($param);

Procedural Interface

ipworksiot_coap_register_callback($res, 8, array($this, 'fireSSLClientAuthentication'));

Parameter List

 'connectionid'
 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

This event enables the server to decide whether or not to continue. The Accept parameter is a recommendation on whether to continue or to close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

SSLServerAuthentication Event (IPWorksIoT_CoAP Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksiot_coap_register_callback($res, 9, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (IPWorksIoT_CoAP Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksiot_coap_register_callback($res, 10, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Unregistered Event (IPWorksIoT_CoAP Class)

Fires when a client has unregistered from notifications.

Object Oriented Interface

public function fireUnregistered($param);

Procedural Interface

ipworksiot_coap_register_callback($res, 11, array($this, 'fireUnregistered'));

Parameter List

 'remotehost'
 'remoteport'
 'uri'
 'urihost'
 'uriport'
 'uripath'
 'uriquery'

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)

CoAP Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (CoAP Class)

CoAP Errors