sol_oic_resource Struct Reference

Structure defining an OIC resource. More...

#include <sol-oic-client.h>

Data Fields
const struct sol_network_link_addr	addr
	The resource address. More...
uint16_t	api_version
	API version. More...
const struct sol_str_slice	device_id
	The Device ID as a UUID 16-byte array. More...
const struct sol_vector	interfaces
	List of interfaces implemented by this resource. More...
const bool	observable
	True if server supports observe mode for this resource. More...
const struct sol_str_slice	path
	The path pointing at this resource. More...
const bool	secure
	True if the connection established with this resource's server is secure. More...
const struct sol_vector	types
	List of resource types (sol_str_slice entries) from this resource. More...

Detailed Description

Structure defining an OIC resource.

It's open to the API user to bypass the need for getters for everything, but all fields are marked as const to emphasize that the user must not alter any of them.

Examples:

/src/samples/coap/iotivity-test-client.c, and /src/samples/coap/oic-client.c.

Field Documentation

const struct sol_network_link_addr sol_oic_resource::addr

The resource address.

Examples:

/src/samples/coap/iotivity-test-client.c, and /src/samples/coap/oic-client.c.

Referenced by found_resource(), and found_resource_print().

uint16_t sol_oic_resource::api_version

API version.

const struct sol_str_slice sol_oic_resource::device_id

The Device ID as a UUID 16-byte array.

Examples:

/src/samples/coap/iotivity-test-client.c, and /src/samples/coap/oic-client.c.

Referenced by found_resource(), and found_resource_print().

const struct sol_vector sol_oic_resource::interfaces

List of interfaces implemented by this resource.

Referenced by found_resource(), and found_resource_print().

const bool sol_oic_resource::observable

True if server supports observe mode for this resource.

Examples:

/src/samples/coap/iotivity-test-client.c, and /src/samples/coap/oic-client.c.

Referenced by found_resource(), and found_resource_print().

const struct sol_str_slice sol_oic_resource::path

The path pointing at this resource.

Examples:

/src/samples/coap/iotivity-test-client.c, and /src/samples/coap/oic-client.c.

Referenced by found_resource(), and found_resource_print().

const bool sol_oic_resource::secure

True if the connection established with this resource's server is secure.

Examples:

/src/samples/coap/iotivity-test-client.c, and /src/samples/coap/oic-client.c.

Referenced by found_resource(), and found_resource_print().

const struct sol_vector sol_oic_resource::types

List of resource types (sol_str_slice entries) from this resource.

Examples:

/src/samples/coap/iotivity-test-client.c, and /src/samples/coap/oic-client.c.

Referenced by found_resource(), and found_resource_print().

---

The documentation for this struct was generated from the following file:

• src/lib/comms/include/sol-oic-client.h