anjay
anjay_dm_handlers_t Struct Reference

#include <dm.h>

Data Fields

anjay_dm_object_read_default_attrs_tobject_read_default_attrs
 
anjay_dm_object_write_default_attrs_tobject_write_default_attrs
 
anjay_dm_list_instances_tlist_instances
 
anjay_dm_instance_reset_tinstance_reset
 
anjay_dm_instance_create_tinstance_create
 
anjay_dm_instance_remove_tinstance_remove
 
anjay_dm_instance_read_default_attrs_tinstance_read_default_attrs
 
anjay_dm_instance_write_default_attrs_tinstance_write_default_attrs
 
anjay_dm_list_resources_tlist_resources
 
anjay_dm_resource_read_tresource_read
 
anjay_dm_resource_write_tresource_write
 
anjay_dm_resource_execute_tresource_execute
 
anjay_dm_resource_reset_tresource_reset
 
anjay_dm_list_resource_instances_tlist_resource_instances
 
anjay_dm_resource_read_attrs_tresource_read_attrs
 
anjay_dm_resource_write_attrs_tresource_write_attrs
 
anjay_dm_transaction_begin_ttransaction_begin
 
anjay_dm_transaction_validate_ttransaction_validate
 
anjay_dm_transaction_commit_ttransaction_commit
 
anjay_dm_transaction_rollback_ttransaction_rollback
 
anjay_dm_resource_instance_read_attrs_tresource_instance_read_attrs
 
anjay_dm_resource_instance_write_attrs_tresource_instance_write_attrs
 

Detailed Description

A struct containing pointers to Object handlers.

Field Documentation

◆ instance_create

anjay_dm_instance_create_t* instance_create

Create an Object Instance, anjay_dm_instance_create_t

Required for handling LwM2M Create operation.

Can be NULL for single instance objects.

◆ instance_read_default_attrs

anjay_dm_instance_read_default_attrs_t* instance_read_default_attrs

Get default Object Instance attributes, anjay_dm_instance_read_default_attrs_t

Required for handling LwM2M Discover and LwM2M Observe operations.

Can be NULL when Attribute Storage feature is enabled. Non-NULL handler overrides Attribute Storage logic.

◆ instance_remove

anjay_dm_instance_remove_t* instance_remove

Delete an Object Instance, anjay_dm_instance_remove_t

Required for handling LwM2M Delete operation performed on Object Instances.

Can be NULL for single instance objects.

◆ instance_reset

anjay_dm_instance_reset_t* instance_reset

Resets an Object Instance, anjay_dm_instance_reset_t

Required for handling LwM2M Write operation in replace mode.

Can be NULL if the object does not contain writable resources.

◆ instance_write_default_attrs

anjay_dm_instance_write_default_attrs_t* instance_write_default_attrs

Set default Object Instance attributes, anjay_dm_instance_write_default_attrs_t

Required for handling LwM2M Write-Attributes operation.

Can be NULL when Attribute Storage feature is enabled. Non-NULL handler overrides Attribute Storage logic.

◆ list_instances

anjay_dm_list_instances_t* list_instances

Enumerate available Object Instances, anjay_dm_list_instances_t

Required for every LwM2M operation.

Must not be NULL. anjay_dm_list_instances_SINGLE can be used here.

◆ list_resource_instances

anjay_dm_list_resource_instances_t* list_resource_instances

Enumerate available Resource Instances, anjay_dm_list_resource_instances_t

Required for LwM2M Read, LwM2M Write and LwM2M Discover operations performed on multiple-instance resources..

Can be NULL if the object does not contain multiple resources.

◆ list_resources

anjay_dm_list_resources_t* list_resources

Enumerate PRESENT Resources in a given Object Instance, anjay_dm_list_resources_t

Required for every LwM2M operation.

Must not be NULL.

◆ object_read_default_attrs

anjay_dm_object_read_default_attrs_t* object_read_default_attrs

Get default Object attributes, anjay_dm_object_read_default_attrs_t

Required for handling LwM2M Discover and LwM2M Observe operations.

Can be NULL if the Attribute Storage feature is enabled. Non-NULL handler overrides Attribute Storage logic.

◆ object_write_default_attrs

anjay_dm_object_write_default_attrs_t* object_write_default_attrs

Set default Object attributes, anjay_dm_object_write_default_attrs_t

Required for handling LwM2M Write-Attributes operation.

Can be NULL when Attribute Storage feature is enabled. Non-NULL handler overrides Attribute Storage logic.

◆ resource_execute

anjay_dm_resource_execute_t* resource_execute

Perform Execute action on a Resource, anjay_dm_resource_execute_t

Required for LwM2M Execute operation.

Can be NULL if the object does not contain executable resources.

◆ resource_instance_read_attrs

anjay_dm_resource_instance_read_attrs_t* resource_instance_read_attrs

Get Resource Instance attributes, anjay_dm_resource_instance_read_attrs_t

Required for handling LwM2M Discover and LwM2M Observe operations.

Can be NULL if the object does not contain multiple resources, when Attribute Storage feature is enabled, or when the application only targets compliance with LwM2M TS 1.0. Non-NULL handler overrides Attribute Storage logic.

◆ resource_instance_write_attrs

anjay_dm_resource_instance_write_attrs_t* resource_instance_write_attrs

Set Resource Instance attributes, anjay_dm_resource_instance_write_attrs_t

Required for handling LwM2M Write-Attributes operation.

Can be NULL if the object does not contain multiple resources, when Attribute Storage feature is enabled, or when the application only targets compliance with LwM2M TS 1.0. Non-NULL handler overrides Attribute Storage logic.

◆ resource_read

anjay_dm_resource_read_t* resource_read

Get Resource value, anjay_dm_resource_read_t

Required for LwM2M Read operation.

Can be NULL if the object does not contain readable resources.

◆ resource_read_attrs

anjay_dm_resource_read_attrs_t* resource_read_attrs

Get Resource attributes, anjay_dm_resource_read_attrs_t

Required for handling LwM2M Discover and LwM2M Observe operations.

Can be NULL when Attribute Storage feature is enabled. Non-NULL handler overrides Attribute Storage logic.

◆ resource_reset

anjay_dm_resource_reset_t* resource_reset

Remove all Resource Instances from a Multiple Resource, anjay_dm_resource_reset_t

Required for LwM2M Write operation performed on multiple-instance resources.

Can be NULL if the object does not contain multiple writable resources.

◆ resource_write

anjay_dm_resource_write_t* resource_write

Set Resource value, anjay_dm_resource_write_t

Required for LwM2M Write operation.

Can be NULL if the object does not contain writable resources.

◆ resource_write_attrs

anjay_dm_resource_write_attrs_t* resource_write_attrs

Set Resource attributes, anjay_dm_resource_write_attrs_t

Required for handling LwM2M Write-Attributes operation.

Can be NULL when Attribute Storage feature is enabled. Non-NULL handler overrides Attribute Storage logic.

◆ transaction_begin

anjay_dm_transaction_begin_t* transaction_begin

Begin a transaction on this Object, anjay_dm_transaction_begin_t

Required for handling modifying operation: LwM2M Write, LwM2M Create or LwM2M Delete.

Can be NULL for read-only objects. anjay_dm_transaction_NOOP can be used here.

◆ transaction_commit

anjay_dm_transaction_commit_t* transaction_commit

Commit changes made in a transaction, anjay_dm_transaction_commit_t

Required for handling modifying operation: LwM2M Write, LwM2M Create or LwM2M Delete.

Can be NULL for read-only objects. anjay_dm_transaction_NOOP can be used here.

◆ transaction_rollback

anjay_dm_transaction_rollback_t* transaction_rollback

Rollback changes made in a transaction, anjay_dm_transaction_rollback_t

Required for handling modifying operation: LwM2M Write, LwM2M Create or LwM2M Delete.

Can be NULL for read-only objects. anjay_dm_transaction_NOOP can be used here.

◆ transaction_validate

anjay_dm_transaction_validate_t* transaction_validate

Validate whether a transaction on this Object can be cleanly committed. See anjay_dm_transaction_validate_t

Required for handling modifying operation: LwM2M Write, LwM2M Create or LwM2M Delete.

Can be NULL for read-only objects. anjay_dm_transaction_NOOP can be used here.


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