Struct ipworksiot::CoAP

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworksiot::CoAP

Remarks

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

Using the Struct in Client Mode

While in client mode (i.e., the listening property is disabled; its default setting), the struct 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 ssl_enabled to True. UseRawPublicKey can be used to enable Raw Public Key mode.

When DTLS is enabled, relevant handshake details will be reported by the on_ssl_status 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 on_ssl_server_authentication event. If the Accept parameter of the on_ssl_server_authentication 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 ssl_cert 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 request_data, request_content_format, request_e_tag, and request_options properties (if necessary, and as applicable), then call one of the following methods:

• get
• post
• put
• delete
• send_custom_request

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 response_code, response_data, response_content_format, response_e_tag, and response_options properties will be populated, and the on_request_complete 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 start_observing 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 response_code, response_data, response_content_format, response_e_tag, and response_options properties to be populated, and the on_notification event to fire.

To stop observing a resource, either call stop_observing with the same URI value used to call start_observing, or set the on_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 Struct in Server Mode

To operate in server mode, set the local_port to the port the struct should listen on (typically 5683, the standard CoAP port), then enable the listening property. Each time a request arrives, the request_data, request_content_format, request_e_tag, and request_options properties will be populated, and the on_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 ssl_enabled 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 ssl_cert property. Note the certificate must contain a private key.

After doing so, calling start_listening will cause the struct to start listening for incoming connections. The struct will listen on the interface defined by local_host and local_port, if specified. Otherwise, these values will be set by the struct. If applicable, these values must be set before calling start_listening. 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 response_code, response_data, response_content_format, response_e_tag, and response_options properties as desired before the event finishes. Alternatively, the on_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 send_response 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 struct can also support resource observation. When a client attempts to register itself as an observer of a resource, the on_register event will fire; setting this event's Accept parameter to True will cause the struct to accept the registration.

To notify clients that a resource has changed, populate the response_code, response_data, response_content_format, response_e_tag, and response_options properties as desired, and then call the send_notification method, passing it the URI of a resource that has registered observers.

When a client has unregistered from further change notifications, the on_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 struct 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()); }

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksIoT. Due to this, the CoAP struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of CoAP when you have finished using the instance.

Property List

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

Method List

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

Event List

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

Config Settings

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

listening property (CoAP Struct)

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

Syntax

fn listening(&self ) -> Result<bool, IPWorksIoTError> 

Default Value

false

Remarks

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

When this property is false (default), the struct operate in client mode, allowing applications to send requests using the get, post, send_custom_request, etc. methods.

When this property is true, the struct listens on local_port for incoming CoAP requests, firing the on_request event anytime one arrives. Applications can service these requests directly during on_request events, or send separate responses later using the send_response method.

Applications that wish to use the struct in server mode should set the local_port property to the desired listening port (such as 5683, the standard CoAP port) before calling start_listening. Otherwise the system will choose a port at random.

Use the start_listening and stop_listening methods to control whether the struct is listening.

This property is read-only.

Data Type

bool

local_host property (CoAP Struct)

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

Syntax

fn local_host(&self ) -> Result<String, IPWorksIoTError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksIoTError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksIoTError> 

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 struct initiate connections (or accept in the case of server structs) 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 struct is connected, the local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

local_port property (CoAP Struct)

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

Syntax

fn local_port(&self ) -> Result<i32, IPWorksIoTError> 
fn set_local_port(&self, value : i32) ->  Option<IPWorksIoTError> 

Default Value

0

Remarks

The local_port property must be set before UDP is activated (active is set to True). This instructs the struct 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 local_port property after the connection is established.

local_port cannot be changed once the struct is active. Any attempt to set the local_port property when the struct is active will generate an error.

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

Data Type

i32

pending_request_count property (CoAP Struct)

The number of records in the PendingRequest arrays.

Syntax

fn pending_request_count(&self ) -> Result<i32, IPWorksIoTError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• pending_request_id
• pending_request_method
• pending_request_remote_host
• pending_request_remote_port
• pending_request_token
• pending_request_uri

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

This property is read-only.

Data Type

i32

pending_request_method property (CoAP Struct)

The request's method.

Syntax

fn pending_request_method(&self , PendingRequestIndex : i32) -> Result<i32, IPWorksIoTError> 

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.

Data Type

i32

pending_request_remote_host property (CoAP Struct)

The remote host associated with the request.

Syntax

fn pending_request_remote_host(&self , PendingRequestIndex : i32) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

The remote host associated with the request.

This property reflects the remote host associated with the request. When the struct 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 struct 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.

Data Type

String

pending_request_remote_port property (CoAP Struct)

The remote port associated with the request.

Syntax

fn pending_request_remote_port(&self , PendingRequestIndex : i32) -> Result<i32, IPWorksIoTError> 

Default Value

0

Remarks

The remote port associated with the request.

This property reflects the remote port associated with the request. Refer to the pending_request_remote_host 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.

Data Type

i32

pending_request_id property (CoAP Struct)

The request's Id.

Syntax

fn pending_request_id(&self , PendingRequestIndex : i32) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

The request's Id.

This property reflects the request's struct-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.

Data Type

String

pending_request_token property (CoAP Struct)

The request's token.

Syntax

fn pending_request_token(&self , PendingRequestIndex : i32) -> Result<Vec<u8>, IPWorksIoTError> 

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.

Data Type

Vec

pending_request_uri property (CoAP Struct)

The request URI.

Syntax

fn pending_request_uri(&self , PendingRequestIndex : i32) -> Result<String, IPWorksIoTError> 

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.

Data Type

String

request_content_format property (CoAP Struct)

The request content format.

Syntax

fn request_content_format(&self ) -> Result<i32, IPWorksIoTError> 
fn set_request_content_format(&self, value : i32) ->  Option<IPWorksIoTError> 

Default Value

-1

Remarks

When the struct 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 struct 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 on_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.

Data Type

i32

request_data property (CoAP Struct)

The request data.

Syntax

fn request_data(&self ) -> Result<Vec<u8>, IPWorksIoTError> 
fn set_request_data(&self, value : Vec<u8>) ->  Option<IPWorksIoTError> 
fn set_request_data_ref(&self, value : &[u8]) ->  Option<IPWorksIoTError> 

Default Value

""

Remarks

When the struct 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 send_custom_request.

When the struct 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 on_request event fires.

Data Type

Vec

request_e_tag property (CoAP Struct)

The request ETag.

Syntax

fn request_e_tag(&self ) -> Result<Vec<u8>, IPWorksIoTError> 
fn set_request_e_tag(&self, value : Vec<u8>) ->  Option<IPWorksIoTError> 
fn set_request_e_tag_ref(&self, value : &[u8]) ->  Option<IPWorksIoTError> 

Default Value

""

Remarks

When the struct 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 struct 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 on_request event fires. It will be empty if an Etag option was not included.

Data Type

Vec

request_option_count property (CoAP Struct)

The number of records in the RequestOption arrays.

Syntax

fn request_option_count(&self ) -> Result<i32, IPWorksIoTError> 
fn set_request_option_count(&self, value : i32) ->  Option<IPWorksIoTError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• request_option_critical
• request_option_no_cache_key
• request_option_number
• request_option_unsafe
• request_option_value
• request_option_value_type

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

Data Type

i32

request_option_critical property (CoAP Struct)

Whether the option is critical.

Syntax

fn request_option_critical(&self , RequestOptionIndex : i32) -> Result<bool, IPWorksIoTError> 

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.

Data Type

bool

request_option_no_cache_key property (CoAP Struct)

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

Syntax

fn request_option_no_cache_key(&self , RequestOptionIndex : i32) -> Result<bool, IPWorksIoTError> 

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.

Data Type

bool

request_option_number property (CoAP Struct)

The option's number.

Syntax

fn request_option_number(&self , RequestOptionIndex : i32) -> Result<i32, IPWorksIoTError> 
fn set_request_option_number(&self, RequestOptionIndex : i32, value : i32) ->  Option<IPWorksIoTError> 

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

Data Type

i32

request_option_unsafe property (CoAP Struct)

Whether the option is unsafe to forward.

Syntax

fn request_option_unsafe(&self , RequestOptionIndex : i32) -> Result<bool, IPWorksIoTError> 

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.

Data Type

bool

request_option_value property (CoAP Struct)

The option's value.

Syntax

fn request_option_value(&self , RequestOptionIndex : i32) -> Result<String, IPWorksIoTError> 
fn set_request_option_value(&self, RequestOptionIndex : i32, value : &str) ->  Option<IPWorksIoTError> 
fn set_request_option_value_ref(&self, RequestOptionIndex : i32, value : &String) ->  Option<IPWorksIoTError> 

Default Value

""

Remarks

The option's value.

This property specifies the option's value. The request_option_value_type 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.

Data Type

String

request_option_value_type property (CoAP Struct)

The option's value data type.

Syntax

fn request_option_value_type(&self , RequestOptionIndex : i32) -> Result<i32, IPWorksIoTError> 
fn set_request_option_value_type(&self, RequestOptionIndex : i32, value : i32) ->  Option<IPWorksIoTError> 

Possible Values

0   // String
1   // UInt
2   // Binary

Default Value

0

Remarks

The option's value data type.

This property specifies the data type of the option's request_option_value. If request_option_number 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 request_option_value.

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

Data Type

i32

response_code property (CoAP Struct)

The response code.

Syntax

fn response_code(&self ) -> Result<String, IPWorksIoTError> 
fn set_response_code(&self, value : &str) ->  Option<IPWorksIoTError> 
fn set_response_code_ref(&self, value : &String) ->  Option<IPWorksIoTError> 

Default Value

""

Remarks

When the struct 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 on_request_complete event fires.

When the struct 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 on_request fires, or later using send_response or send_notification).

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.

Data Type

String

response_content_format property (CoAP Struct)

The response content format.

Syntax

fn response_content_format(&self ) -> Result<i32, IPWorksIoTError> 
fn set_response_content_format(&self, value : i32) ->  Option<IPWorksIoTError> 

Default Value

-1

Remarks

When the struct 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 on_request_complete event fires.

When the struct 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 on_request fires, or later using send_response or send_notification).

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.

Data Type

i32

response_data property (CoAP Struct)

The response data.

Syntax

fn response_data(&self ) -> Result<Vec<u8>, IPWorksIoTError> 
fn set_response_data(&self, value : Vec<u8>) ->  Option<IPWorksIoTError> 
fn set_response_data_ref(&self, value : &[u8]) ->  Option<IPWorksIoTError> 

Default Value

""

Remarks

When the struct 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 on_request_complete event fires.

When the struct 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 on_request fires, or later using send_response or send_notification).

Data Type

Vec

response_e_tag property (CoAP Struct)

The response ETag.

Syntax

fn response_e_tag(&self ) -> Result<Vec<u8>, IPWorksIoTError> 
fn set_response_e_tag(&self, value : Vec<u8>) ->  Option<IPWorksIoTError> 
fn set_response_e_tag_ref(&self, value : &[u8]) ->  Option<IPWorksIoTError> 

Default Value

""

Remarks

When the struct 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 on_request_complete event fires. It will be empty if an Etag option was not included.

When the struct 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 on_request fires, or later using send_response or send_notification). Leave it empty to prevent an Etag option from being included.

Data Type

Vec

response_option_count property (CoAP Struct)

The number of records in the ResponseOption arrays.

Syntax

fn response_option_count(&self ) -> Result<i32, IPWorksIoTError> 
fn set_response_option_count(&self, value : i32) ->  Option<IPWorksIoTError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• response_option_critical
• response_option_no_cache_key
• response_option_number
• response_option_unsafe
• response_option_value
• response_option_value_type

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

Data Type

i32

response_option_critical property (CoAP Struct)

Whether the option is critical.

Syntax

fn response_option_critical(&self , ResponseOptionIndex : i32) -> Result<bool, IPWorksIoTError> 

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.

Data Type

bool

response_option_no_cache_key property (CoAP Struct)

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

Syntax

fn response_option_no_cache_key(&self , ResponseOptionIndex : i32) -> Result<bool, IPWorksIoTError> 

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.

Data Type

bool

response_option_number property (CoAP Struct)

The option's number.

Syntax

fn response_option_number(&self , ResponseOptionIndex : i32) -> Result<i32, IPWorksIoTError> 
fn set_response_option_number(&self, ResponseOptionIndex : i32, value : i32) ->  Option<IPWorksIoTError> 

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

Data Type

i32

response_option_unsafe property (CoAP Struct)

Whether the option is unsafe to forward.

Syntax

fn response_option_unsafe(&self , ResponseOptionIndex : i32) -> Result<bool, IPWorksIoTError> 

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.

Data Type

bool

response_option_value property (CoAP Struct)

The option's value.

Syntax

fn response_option_value(&self , ResponseOptionIndex : i32) -> Result<String, IPWorksIoTError> 
fn set_response_option_value(&self, ResponseOptionIndex : i32, value : &str) ->  Option<IPWorksIoTError> 
fn set_response_option_value_ref(&self, ResponseOptionIndex : i32, value : &String) ->  Option<IPWorksIoTError> 

Default Value

""

Remarks

The option's value.

This property specifies the option's value. The response_option_value_type 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.

Data Type

String

response_option_value_type property (CoAP Struct)

The option's value data type.

Syntax

fn response_option_value_type(&self , ResponseOptionIndex : i32) -> Result<i32, IPWorksIoTError> 
fn set_response_option_value_type(&self, ResponseOptionIndex : i32, value : i32) ->  Option<IPWorksIoTError> 

Possible Values

0   // String
1   // UInt
2   // Binary

Default Value

0

Remarks

The option's value data type.

This property specifies the data type of the option's response_option_value. If response_option_number 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 response_option_value.

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

Data Type

i32

ssl_accept_server_cert_effective_date property (CoAP Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_expiration_date property (CoAP Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_extended_key_usage property (CoAP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_fingerprint property (CoAP Struct)

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

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_fingerprint_sha1 property (CoAP Struct)

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

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_fingerprint_sha256 property (CoAP Struct)

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

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_issuer property (CoAP Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_private_key property (CoAP Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (CoAP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, IPWorksIoTError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (CoAP Struct)

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

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (CoAP Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_public_key_algorithm property (CoAP Struct)

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

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_public_key_length property (CoAP Struct)

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

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, IPWorksIoTError> 

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

i32

ssl_accept_server_cert_serial_number property (CoAP Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_signature_algorithm property (CoAP Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_store property (CoAP Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksIoTError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksIoTError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksIoTError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject 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

Vec

ssl_accept_server_cert_store_password property (CoAP Struct)

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

Syntax

fn ssl_accept_server_cert_store_password(&self ) -> Result<String, IPWorksIoTError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<IPWorksIoTError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksIoTError> 

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

ssl_accept_server_cert_store_type property (CoAP Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, IPWorksIoTError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<IPWorksIoTError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (CoAP Struct)

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

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (CoAP Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_thumbprint_sha1 property (CoAP Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_thumbprint_sha256 property (CoAP Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_usage property (CoAP Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

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

ssl_accept_server_cert_usage_flags property (CoAP Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, IPWorksIoTError> 

Default Value

0

Remarks

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

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

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

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (CoAP Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_accept_server_cert_subject property (CoAP Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self ) -> Result<String, IPWorksIoTError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<IPWorksIoTError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<IPWorksIoTError> 

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

String

ssl_accept_server_cert_encoded property (CoAP Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksIoTError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksIoTError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksIoTError> 

Default Value

""

Remarks

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

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

Data Type

Vec

ssl_authenticate_clients property (CoAP Struct)

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

Syntax

fn ssl_authenticate_clients(&self ) -> Result<bool, IPWorksIoTError> 
fn set_ssl_authenticate_clients(&self, value : bool) ->  Option<IPWorksIoTError> 

Default Value

false

Remarks

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

Data Type

bool

ssl_cert_effective_date property (CoAP Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_expiration_date property (CoAP Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_extended_key_usage property (CoAP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_fingerprint property (CoAP Struct)

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

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_fingerprint_sha1 property (CoAP Struct)

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

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_fingerprint_sha256 property (CoAP Struct)

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

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_issuer property (CoAP Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_private_key property (CoAP Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (CoAP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksIoTError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (CoAP Struct)

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

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_public_key property (CoAP Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_public_key_algorithm property (CoAP Struct)

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

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_public_key_length property (CoAP Struct)

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

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksIoTError> 

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

i32

ssl_cert_serial_number property (CoAP Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_signature_algorithm property (CoAP Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_store property (CoAP Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, IPWorksIoTError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksIoTError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksIoTError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject 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

Vec

ssl_cert_store_password property (CoAP Struct)

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

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, IPWorksIoTError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksIoTError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksIoTError> 

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

ssl_cert_store_type property (CoAP Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, IPWorksIoTError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksIoTError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

i32

ssl_cert_subject_alt_names property (CoAP Struct)

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

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (CoAP Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_thumbprint_sha1 property (CoAP Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_thumbprint_sha256 property (CoAP Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_usage property (CoAP Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

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

ssl_cert_usage_flags property (CoAP Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksIoTError> 

Default Value

0

Remarks

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

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

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

This property is read-only.

Data Type

i32

ssl_cert_version property (CoAP Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_cert_subject property (CoAP Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, IPWorksIoTError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksIoTError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksIoTError> 

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

String

ssl_cert_encoded property (CoAP Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksIoTError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksIoTError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksIoTError> 

Default Value

""

Remarks

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

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

Data Type

Vec

ssl_enabled property (CoAP Struct)

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

Syntax

fn ssl_enabled(&self ) -> Result<bool, IPWorksIoTError> 
fn set_ssl_enabled(&self, value : bool) ->  Option<IPWorksIoTError> 

Default Value

false

Remarks

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

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

Data Type

bool

ssl_server_cert_effective_date property (CoAP Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_expiration_date property (CoAP Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_extended_key_usage property (CoAP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_fingerprint property (CoAP Struct)

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

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_fingerprint_sha1 property (CoAP Struct)

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

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_fingerprint_sha256 property (CoAP Struct)

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

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_issuer property (CoAP Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_private_key property (CoAP Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (CoAP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, IPWorksIoTError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (CoAP Struct)

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

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (CoAP Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_public_key_algorithm property (CoAP Struct)

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

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_public_key_length property (CoAP Struct)

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

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, IPWorksIoTError> 

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

i32

ssl_server_cert_serial_number property (CoAP Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_signature_algorithm property (CoAP Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_store property (CoAP Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksIoTError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject 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

Vec

ssl_server_cert_store_password property (CoAP Struct)

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

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_store_type property (CoAP Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, IPWorksIoTError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (CoAP Struct)

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

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (CoAP Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_thumbprint_sha1 property (CoAP Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_thumbprint_sha256 property (CoAP Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_usage property (CoAP Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, IPWorksIoTError> 

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

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

ssl_server_cert_usage_flags property (CoAP Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, IPWorksIoTError> 

Default Value

0

Remarks

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

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

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

This property is read-only.

Data Type

i32

ssl_server_cert_version property (CoAP Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, IPWorksIoTError> 

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

ssl_server_cert_subject property (CoAP Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, IPWorksIoTError> 

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=example@email.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

ssl_server_cert_encoded property (CoAP Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksIoTError> 

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

Vec

timeout property (CoAP Struct)

A timeout for the struct.

Syntax

fn timeout(&self ) -> Result<i32, IPWorksIoTError> 
fn set_timeout(&self, value : i32) ->  Option<IPWorksIoTError> 

Default Value

60

Remarks

This property specifies the number of seconds that the struct should wait, synchronously, for a response to be received. A value of 0 means that the struct 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 struct will use do_events 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 struct throws an exception.

Data Type

i32

use_confirmable_messages property (CoAP Struct)

Whether to use confirmable message.

Syntax

fn use_confirmable_messages(&self ) -> Result<bool, IPWorksIoTError> 
fn set_use_confirmable_messages(&self, value : bool) ->  Option<IPWorksIoTError> 

Default Value

true

Remarks

This property specifies whether the struct 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 struct 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 struct 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 struct has no way to know whether a given message was received by the remote host, or lost in transit.

Data Type

bool

cancel_request method (CoAP Struct)

Cancels a pending request.

Syntax

fn cancel_request(&self, request_id : &str) -> Result<(), IPWorksIoTError>

Remarks

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

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

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

config method (CoAP Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksIoTError>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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 (CoAP Struct)

Sends a DELETE request to the server.

Syntax

fn delete(&self, uri : &str) ->  Result<String, IPWorksIoTError>

Remarks

This method sends the server a DELETE request for the resource identified by URI. If the request_e_tag property is non-empty, its value will be used to include an Etag option in the request. Any additional options present in the request_options 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 use_confirmable_messages property is enabled when this method is called, the struct 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 struct 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 use_confirmable_messages 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 pending_requests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the cancel_request method will cancel the request (assuming it is still pending at that time).

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

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

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

do_events method (CoAP Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksIoTError>

Remarks

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

get method (CoAP Struct)

Sends a GET request to the server.

Syntax

fn get(&self, uri : &str) ->  Result<String, IPWorksIoTError>

Remarks

This method sends the server a GET request for the resource identified by URI. If the request_e_tag property is non-empty, its value will be used to include an Etag option in the request. Any additional options present in the request_options 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 use_confirmable_messages property is enabled when this method is called, the struct 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 struct 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 use_confirmable_messages 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 pending_requests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the cancel_request method will cancel the request (assuming it is still pending at that time).

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

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

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

post method (CoAP Struct)

Sends a POST request to the server.

Syntax

fn post(&self, uri : &str) ->  Result<String, IPWorksIoTError>

Remarks

This method sends the server a POST request for the resource identified by URI. The request_data property specifies the data that will be sent in the request. If the request_content_format and/or request_e_tag 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 request_options 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 use_confirmable_messages property is enabled when this method is called, the struct 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 struct 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 use_confirmable_messages 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 pending_requests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the cancel_request method will cancel the request (assuming it is still pending at that time).

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

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

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

put method (CoAP Struct)

Sends a PUT request to the server.

Syntax

fn put(&self, uri : &str) ->  Result<String, IPWorksIoTError>

Remarks

This method sends the server a PUT request for the resource identified by URI. The request_data property specifies the data that will be sent in the request. If the request_content_format and/or request_e_tag 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 request_options 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 use_confirmable_messages property is enabled when this method is called, the struct 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 struct 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 use_confirmable_messages 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 pending_requests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the cancel_request method will cancel the request (assuming it is still pending at that time).

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

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

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

reset method (CoAP Struct)

This method will reset the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksIoTError>

Remarks

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

send_custom_request method (CoAP Struct)

Sends a custom request to the server.

Syntax

fn send_custom_request(&self, uri : &str, method : i32) ->  Result<String, IPWorksIoTError>

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 request_data property specifies the data that will be sent in the request. If the request_content_format and/or request_e_tag 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 request_options 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 use_confirmable_messages property is enabled when this method is called, the struct 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 struct 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 use_confirmable_messages 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 pending_requests properties, and this method will finish immediately, returning an Id for the request. Passing this Id to the cancel_request method will cancel the request (assuming it is still pending at that time).

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

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

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

send_notification method (CoAP Struct)

Sends a notification to all clients observing a given resource.

Syntax

fn send_notification(&self, uri : &str) -> Result<(), IPWorksIoTError>

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 struct will automatically unregister all observers when a non-2.xx notification is sent.

The response_data property specifies the data that will be sent in the response, and the response_code property specifies the response code. If the response_content_format and/or response_e_tag 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 response_options properties will be included as well.

If the use_confirmable_messages property is enabled when this method is called, the struct 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 struct will assume that the message is undeliverable and time out the response.

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

send_response method (CoAP Struct)

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

Syntax

fn send_response(&self, request_id : &str) -> Result<(), IPWorksIoTError>

Remarks

This method sends a response for the request in the pending_requests properties identified by RequestId. The response_data property specifies the data that will be sent in the response, and the response_code property specifies the response code. If the response_content_format and/or response_e_tag 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 response_options properties will be included as well.

If the use_confirmable_messages property is enabled when this method is called, the struct 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 struct will assume that the message is undeliverable and time out the response. The on_response_complete event will fire once the message receipt is confirmed (or once the retransmission period elapses).

If the use_confirmable_messages property is disabled, the on_response_complete 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 struct is operating in server mode (i.e., when the listening property is enabled).

start_listening method (CoAP Struct)

This method starts listening for incoming connections.

Syntax

fn start_listening(&self) -> Result<(), IPWorksIoTError>

Remarks

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

To stop listening for new connections, call stop_listening. To stop listening for new connections and to disconnect all existing clients, call shutdown.

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

To stop listening for new connections, call stop_listening. To stop listening for new connections and to disconnect all existing clients, call shutdown.

start_observing method (CoAP Struct)

Registers the struct as an observer for a given resource.

Syntax

fn start_observing(&self, uri : &str) ->  Result<String, IPWorksIoTError>

Remarks

This method registers the struct as an observer for the resource identified by URI. If the server accepts the registration, then it will periodically notify the struct about any changes to the specified resource. These "change notifications" are exposed via the on_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 struct automatically includes an Observe option. The presence of this option is what indicates to the server that the struct wishes to register itself as an observer for the specified resource.
2. When the server receives the request, its response causes the on_notification event to fire instead of the on_request_complete event. (Unless it decides to reject the registration, in which case it will handle the request just like a normal GET request, and the on_request_complete event will fire when its response is received, just like it would if get had been called.)

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

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

stop_listening method (CoAP Struct)

This method stops listening for new connections.

Syntax

fn stop_listening(&self) -> Result<(), IPWorksIoTError>

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.

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.

stop_observing method (CoAP Struct)

Unregisters the struct as an observer for a given resource.

Syntax

fn stop_observing(&self, uri : &str) -> Result<(), IPWorksIoTError>

Remarks

This method unregisters the struct 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 struct automatically includes an Observe option with a value of 1. The presence of this option indicates to the server that the struct 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 struct is operating in client mode (i.e., when the listening property is disabled).

on_error event (CoAP Struct)

Fired when information is available about errors during data delivery.

Syntax

// CoAPErrorEventArgs carries the CoAP Error event's parameters.
pub struct CoAPErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// CoAPErrorEvent defines the signature of the CoAP Error event's handler function.
pub trait CoAPErrorEvent {
  fn on_error(&self, sender : CoAP, e : &mut CoAPErrorEventArgs);
}

impl <'a> CoAP<'a> {
  pub fn on_error(&self) -> &'a dyn CoAPErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn CoAPErrorEvent);
  ...
}

Remarks

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

The error_code 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.

on_log event (CoAP Struct)

Fires once for each log message.

Syntax

// CoAPLogEventArgs carries the CoAP Log event's parameters.
pub struct CoAPLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
}

// CoAPLogEvent defines the signature of the CoAP Log event's handler function.
pub trait CoAPLogEvent {
  fn on_log(&self, sender : CoAP, e : &mut CoAPLogEventArgs);
}

impl <'a> CoAP<'a> {
  pub fn on_log(&self) -> &'a dyn CoAPLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn CoAPLogEvent);
  ...
}

Remarks

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

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

on_notification event (CoAP Struct)

Fires when a notification is received from the server.

Syntax

// CoAPNotificationEventArgs carries the CoAP Notification event's parameters.
pub struct CoAPNotificationEventArgs {
  fn uri(&self) -> &String
  fn is_latest(&self) -> bool
  fn stop_observing(&self) -> bool
  fn set_stop_observing(&self, value : bool)
}

// CoAPNotificationEvent defines the signature of the CoAP Notification event's handler function.
pub trait CoAPNotificationEvent {
  fn on_notification(&self, sender : CoAP, e : &mut CoAPNotificationEventArgs);
}

impl <'a> CoAP<'a> {
  pub fn on_notification(&self) -> &'a dyn CoAPNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn CoAPNotificationEvent);
  ...
}

Remarks

This event fires when the struct receives a notification from that server that some observed resource has changed. Query the response_code, response_data, response_content_format, response_e_tag, and response_options 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 response_code 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 struct should stop observing the resource identified by URI. This parameter is False by default, set it to True to have the struct 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 struct is operating in client mode (i.e., when the listening property is disabled).

on_register event (CoAP Struct)

Fires when a client wishes to register for notifications.

Syntax

// CoAPRegisterEventArgs carries the CoAP Register event's parameters.
pub struct CoAPRegisterEventArgs {
  fn remote_host(&self) -> &String
  fn remote_port(&self) -> i32
  fn uri(&self) -> &String
  fn uri_host(&self) -> &String
  fn uri_port(&self) -> i32
  fn uri_path(&self) -> &String
  fn uri_query(&self) -> &String
  fn token(&self) -> &[u8]
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// CoAPRegisterEvent defines the signature of the CoAP Register event's handler function.
pub trait CoAPRegisterEvent {
  fn on_register(&self, sender : CoAP, e : &mut CoAPRegisterEventArgs);
}

impl <'a> CoAP<'a> {
  pub fn on_register(&self) -> &'a dyn CoAPRegisterEvent;
  pub fn set_on_register(&mut self, value : &'a dyn CoAPRegisterEvent);
  ...
}

Remarks

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

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

To correctly handle this event, populate the response_code, response_data, response_content_format, response_e_tag, and response_options 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 send_notification 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 struct 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 struct to add the client to its internal list of registered observers for the specified URI.

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

on_request event (CoAP Struct)

Fires when a request is received from a client.

Syntax

// CoAPRequestEventArgs carries the CoAP Request event's parameters.
pub struct CoAPRequestEventArgs {
  fn remote_host(&self) -> &String
  fn remote_port(&self) -> i32
  fn method(&self) -> i32
  fn uri_host(&self) -> &String
  fn uri_port(&self) -> i32
  fn uri_path(&self) -> &String
  fn uri_query(&self) -> &String
  fn token(&self) -> &[u8]
  fn request_id(&self) -> &String
  fn send_response(&self) -> bool
  fn set_send_response(&self, value : bool)
}

// CoAPRequestEvent defines the signature of the CoAP Request event's handler function.
pub trait CoAPRequestEvent {
  fn on_request(&self, sender : CoAP, e : &mut CoAPRequestEventArgs);
}

impl <'a> CoAP<'a> {
  pub fn on_request(&self) -> &'a dyn CoAPRequestEvent;
  pub fn set_on_request(&mut self, value : &'a dyn CoAPRequestEvent);
  ...
}

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: request_data, request_content_format, request_e_tag, and request_options.

A response can either be sent back to the client immediately when the event finishes, or later using the send_response method. Refer to the RequestId and SendResponse parameters' documentation, below, for more information. If a response is to be sent back immediately, populate the response_code, response_data, response_content_format, response_e_tag, and response_options 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 struct-generated Id for the request. If the final value of the SendResponse parameter is False, this Id can be passed to the send_response method later to send a response. (Alternatively, it can be passed to the cancel_request later to ignore the request.)

The SendResponse parameter specifies whether the struct 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 struct is operating in server mode (i.e., when the listening property is enabled).

on_request_complete event (CoAP Struct)

Fires when a request completes.

Syntax

// CoAPRequestCompleteEventArgs carries the CoAP RequestComplete event's parameters.
pub struct CoAPRequestCompleteEventArgs {
  fn method(&self) -> i32
  fn uri(&self) -> &String
  fn request_id(&self) -> &String
  fn error_code(&self) -> i32
  fn error_description(&self) -> &String
}

// CoAPRequestCompleteEvent defines the signature of the CoAP RequestComplete event's handler function.
pub trait CoAPRequestCompleteEvent {
  fn on_request_complete(&self, sender : CoAP, e : &mut CoAPRequestCompleteEventArgs);
}

impl <'a> CoAP<'a> {
  pub fn on_request_complete(&self) -> &'a dyn CoAPRequestCompleteEvent;
  pub fn set_on_request_complete(&mut self, value : &'a dyn CoAPRequestCompleteEvent);
  ...
}

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 use_confirmable_messages property is enabled, and the struct did not receive confirmation that the request was received before the retransmission period elapsed.
• If timeout property is greater than 0, and the struct 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 response_code, response_data, response_content_format, response_e_tag, and response_options 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 struct is operating in client mode (i.e., when the listening property is disabled).

on_response_complete event (CoAP Struct)

Fires when a response has been sent to a client.

Syntax

// CoAPResponseCompleteEventArgs carries the CoAP ResponseComplete event's parameters.
pub struct CoAPResponseCompleteEventArgs {
  fn request_id(&self) -> &String
  fn error_code(&self) -> i32
  fn error_description(&self) -> &String
}

// CoAPResponseCompleteEvent defines the signature of the CoAP ResponseComplete event's handler function.
pub trait CoAPResponseCompleteEvent {
  fn on_response_complete(&self, sender : CoAP, e : &mut CoAPResponseCompleteEventArgs);
}

impl <'a> CoAP<'a> {
  pub fn on_response_complete(&self) -> &'a dyn CoAPResponseCompleteEvent;
  pub fn set_on_response_complete(&mut self, value : &'a dyn CoAPResponseCompleteEvent);
  ...
}

Remarks

This event fires anytime a response has been sent to a client. If the use_confirmable_messages 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 use_confirmable_messages 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 struct-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 struct is operating in server mode (i.e., when the listening property is enabled).

on_ssl_client_authentication event (CoAP Struct)

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

Syntax

// CoAPSSLClientAuthenticationEventArgs carries the CoAP SSLClientAuthentication event's parameters.
pub struct CoAPSSLClientAuthenticationEventArgs {
  fn connection_id(&self) -> i32
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// CoAPSSLClientAuthenticationEvent defines the signature of the CoAP SSLClientAuthentication event's handler function.
pub trait CoAPSSLClientAuthenticationEvent {
  fn on_ssl_client_authentication(&self, sender : CoAP, e : &mut CoAPSSLClientAuthenticationEventArgs);
}

impl <'a> CoAP<'a> {
  pub fn on_ssl_client_authentication(&self) -> &'a dyn CoAPSSLClientAuthenticationEvent;
  pub fn set_on_ssl_client_authentication(&mut self, value : &'a dyn CoAPSSLClientAuthenticationEvent);
  ...
}

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

on_ssl_server_authentication event (CoAP Struct)

Fired after the server presents its certificate to the client.

Syntax

// CoAPSSLServerAuthenticationEventArgs carries the CoAP SSLServerAuthentication event's parameters.
pub struct CoAPSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// CoAPSSLServerAuthenticationEvent defines the signature of the CoAP SSLServerAuthentication event's handler function.
pub trait CoAPSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : CoAP, e : &mut CoAPSSLServerAuthenticationEventArgs);
}

impl <'a> CoAP<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn CoAPSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn CoAPSSLServerAuthenticationEvent);
  ...
}

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.

on_ssl_status event (CoAP Struct)

Fired when secure connection progress messages are available.

Syntax

// CoAPSSLStatusEventArgs carries the CoAP SSLStatus event's parameters.
pub struct CoAPSSLStatusEventArgs {
  fn message(&self) -> &String
}

// CoAPSSLStatusEvent defines the signature of the CoAP SSLStatus event's handler function.
pub trait CoAPSSLStatusEvent {
  fn on_ssl_status(&self, sender : CoAP, e : &mut CoAPSSLStatusEventArgs);
}

impl <'a> CoAP<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn CoAPSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn CoAPSSLStatusEvent);
  ...
}

Remarks

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

on_unregistered event (CoAP Struct)

Fires when a client has unregistered from notifications.

Syntax

// CoAPUnregisteredEventArgs carries the CoAP Unregistered event's parameters.
pub struct CoAPUnregisteredEventArgs {
  fn remote_host(&self) -> &String
  fn remote_port(&self) -> i32
  fn uri(&self) -> &String
  fn uri_host(&self) -> &String
  fn uri_port(&self) -> i32
  fn uri_path(&self) -> &String
  fn uri_query(&self) -> &String
}

// CoAPUnregisteredEvent defines the signature of the CoAP Unregistered event's handler function.
pub trait CoAPUnregisteredEvent {
  fn on_unregistered(&self, sender : CoAP, e : &mut CoAPUnregisteredEventArgs);
}

impl <'a> CoAP<'a> {
  pub fn on_unregistered(&self) -> &'a dyn CoAPUnregisteredEvent;
  pub fn set_on_unregistered(&mut self, value : &'a dyn CoAPUnregisteredEvent);
  ...
}

Remarks

This event fires anytime a client has unregistered itself from further notifications for the resource identified by URI. Refer to the start_observing and send_notification methods, as well as the on_notification and on_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 struct is operating in server mode (i.e., when the listening property is enabled).

Config Settings (CoAP Struct)

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

CoAP Errors