Mistake on this page? Email us
pt_common_api.h File Reference

Contains common structures and definitions for the protocol translator client. More...

#include <stdint.h>
#include "common/constants.h"
#include "common/default_message_id_generator.h"

Go to the source code of this file.

Macros

#define PT_API_VERSION   2
 
#define PT_COMMON_API_H
 
#define PT_API_CONNECTION_ID_INVALID   -1
 

Typedefs

typedef struct pt_api_mutex_s pt_api_mutex_t
 
typedef int32_t connection_id_t
 
typedef struct pt_client_data_s pt_client_t
 

Enumerations

enum  queuemode_t { NONE, QUEUE, NONE, QUEUE }
 
enum  pt_status_t {
  PT_STATUS_SUCCESS = 0, PT_STATUS_ERROR, PT_STATUS_ITEM_EXISTS, PT_STATUS_INVALID_PARAMETERS,
  PT_STATUS_ALLOCATION_FAIL, PT_STATUS_NOT_CONNECTED, PT_STATUS_SUCCESS = 0, PT_STATUS_ERROR,
  PT_STATUS_UNNECESSARY, PT_STATUS_ITEM_EXISTS, PT_STATUS_INVALID_PARAMETERS, PT_STATUS_ALLOCATION_FAIL,
  PT_STATUS_NOT_CONNECTED, PT_STATUS_NOT_FOUND, PT_STATUS_FEATURE_INITIALIZATION_FAIL
}
 Enumeration containing the possible return status codes for Protocol API functions.
 
enum  pt_device_state_e { PT_STATE_UNREGISTERED, PT_STATE_REGISTERING, PT_STATE_REGISTERED, PT_STATE_UNREGISTERING }
 Enumeration contain device registration states.
 
enum  pt_device_feature_e { PT_DEVICE_FEATURE_NONE = 0, PT_DEVICE_FEATURE_CERTIFICATE_RENEWAL = (1 << 1), PT_DEVICE_FEATURE_FIRMWARE_UPDATE = (1 << 2) }
 Enumeration contain device feature flags.
 

Detailed Description

Contains common structures and definitions for the protocol translator client.