lwm2m_types.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017 ARM Limited. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 * Licensed under the Apache License, Version 2.0 (the License); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef LWM2M_TYPES_H
#define LWM2M_TYPES_H

#include "mbed-client/lwm2m_config.h"
#include <inttypes.h>

#ifdef __cplusplus
extern "C" {
#endif


typedef enum registry_callback_type_e {
    REGISTRY_CALLBACK_NONE = 0, 
    REGISTRY_CALLBACK_VALUE_UPDATED = 1, 
    REGISTRY_CALLBACK_EXECUTE, 
    REGISTRY_CALLBACK_BLOCKMESSAGE_INCOMING, 
    REGISTRY_CALLBACK_BLOCKMESSAGE_OUTGOING, 
    REGISTRY_CALLBACK_NOTIFICATION_STATUS, 
    REGISTRY_CALLBACK_ITEM_REMOVED, 
    REGISTRY_CALLBACK_ITEM_REPLACED, 
    REGISTRY_CALLBACK_ITEM_ADDED 
} registry_callback_type_t;


typedef enum registry_removal_type_e {
    REGISTRY_REMOVE, 
    REGISTRY_REMOVE_FOR_REPLACEMENT, 
    REGISTRY_REMOVE_SKIP_CALLBACK 
} registry_removal_type_t;

typedef enum registry_notification_status_e {
    NOTIFICATION_STATUS_IGNORE = -1,        
    NOTIFICATION_STATUS_INIT = 0,           
    NOTIFICATION_STATUS_BUILD_ERROR,        
    NOTIFICATION_STATUS_RESEND_QUEUE_FULL,  
    NOTIFICATION_STATUS_SENT,               
    NOTIFICATION_STATUS_DELIVERED,          
    NOTIFICATION_STATUS_SEND_FAILED,        
    NOTIFICATION_STATUS_SUBSCRIBED,         
    NOTIFICATION_STATUS_UNSUBSCRIBED,       
#ifdef MBED_CLOUD_CLIENT_DISABLE_REGISTRY
    NOTIFICATION_STATUS_NOT_REGISTERED,     
#endif
} registry_notification_status_t;

typedef struct registry_callback_token_s {
    uint8_t token[8]; 
    unsigned token_size:4; 
} registry_callback_token_t;

typedef struct registry_available_parameters_s {
#if MBED_CLIENT_ENABLE_OBSERVATION_PARAMETERS
    uint8_t pmin:1; 
    uint8_t pmax:1; 
    uint8_t gt:1; 
    uint8_t lt:1; 
    uint8_t st:1; 
    uint8_t time:1; 
    uint8_t previous_value:1; 
#endif
    uint8_t content_type:1; 

} registry_available_parameters_t;

#if MBED_CLIENT_ENABLE_OBSERVATION_PARAMETERS

typedef union registry_observation_value_u {
#if MBED_CLIENT_ENABLE_FLOAT_VALUE
    float float_value; 
#endif
    int64_t int_value; 
} registry_observation_value_t;

#else
typedef void registry_observation_value_t;
#endif //MBED_CLIENT_ENABLE_OBSERVATION_PARAMETERS


typedef struct registry_data_opaque_s {
    uint32_t size; 
    uint8_t data[]; 
} registry_data_opaque_t;

typedef union registry_data_generic_u {
    registry_data_opaque_t *opaque_data; 
    const char *string; 
} registry_data_generic_t;

typedef struct registry_generic_value_s {
    uint8_t free_data;              
    registry_data_generic_t data; 
} registry_generic_value_t;

typedef union registry_object_value_u {

    int64_t int_value; 
#if MBED_CLIENT_ENABLE_FLOAT_VALUE
    float float_value; 
#endif
    registry_generic_value_t generic_value; 
    void *list; 
    uint8_t empty_value; 

} registry_object_value_t;

typedef struct registry_path_s {

    uint16_t object_id; 
    uint16_t object_instance_id; 
    uint16_t resource_id; 
    uint16_t resource_instance_id;

    // this needs only 2 bits, but a bitfield wastes 300 bytes of ROM while saving nothing in RAM
    uint8_t  path_type; 

} registry_path_t;

typedef enum registry_status_e {

    REGISTRY_STATUS_NO_DATA = 1, 
    REGISTRY_STATUS_OK = 0, 
    REGISTRY_STATUS_NOT_FOUND = (-1), 
    REGISTRY_STATUS_NO_MEMORY = (-2), 
    REGISTRY_STATUS_INVALID_INPUT = (-3), 
    REGISTRY_STATUS_ALREADY_EXISTS = (-4) 

} registry_status_t;

typedef enum registry_event_listen_mode_e {

    REGISTRY_EVENT_LISTEN_VALUE_CHANGES = 1, 
    REGISTRY_EVENT_LISTEN_CREATE_REMOVE = 2, 
    REGISTRY_EVENT_LISTEN_EVERY_EVENT = 3 

} registry_event_listen_mode_t;

typedef enum listing_type_e {

    REGISTRY_LISTING_IN_PROGRESS = 0, 
    REGISTRY_LISTING_ALL = 1, 
    REGISTRY_LISTING_DIRECTORY = 2, 
    REGISTRY_LISTING_RECURSIVE = 3, 
    REGISTRY_LISTING_DIRECTORY_IN_PROGRESS = 4 

} listing_type_t;

typedef struct registry_listing_s {

    registry_path_t path;
    uint8_t listing_type;
    uint8_t value_set; 
    uint8_t parameters_set; 
    uint8_t registered; 
    uint8_t set_registered; 

    struct registry_object_s *object;            
    struct registry_object_s *object_instance;   
    struct registry_object_s *resource;          
    struct registry_object_s *resource_instance; 

} registry_listing_t;

#ifdef __cplusplus
}
#endif

#endif //LWM2M_TYPES_H