appd_iot_def.h

Go to the documentation of this file.

/*
 * Copyright (c) AppDynamics, Inc., and its affiliates
 * 2017
 * All Rights Reserved
 * THIS IS UNPUBLISHED PROPRIETARY CODE OF APPDYNAMICS, INC.
 * The copyright notice above does not evidence any actual or intended publication of such source code
 */

/* @file appd_iot_def.h
 * @brief This file contains the data structure definitions and utility functions used by the SDK
 */


#ifndef _APPD_IOT_DEF_H_
#define _APPD_IOT_DEF_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <string.h>

typedef enum
{
  APPD_IOT_SUCCESS,
  APPD_IOT_ERR_INVALID_INPUT,
  APPD_IOT_ERR_MAX_LIMIT,
  APPD_IOT_ERR_NETWORK_ERROR,
  APPD_IOT_ERR_NETWORK_REJECT,
  APPD_IOT_ERR_NETWORK_UNREACHABLE,
  APPD_IOT_ERR_NETWORK_NOT_AVAILABLE,
  APPD_IOT_ERR_NULL_PTR,
  APPD_IOT_ERR_INTERNAL,
  APPD_IOT_ERR_NOT_SUPPORTED,
  APPD_IOT_ERR_SDK_NOT_ENABLED,
  APPD_IOT_MAX_ERROR_CODES
} appd_iot_error_code_t;


typedef enum
{
  APPD_IOT_SDK_UNINITIALIZED,
  APPD_IOT_SDK_ENABLED,
  APPD_IOT_SDK_DISABLED_KILL_SWITCH,
  APPD_IOT_SDK_DISABLED_LICENSE_EXPIRED,
  APPD_IOT_SDK_DISABLED_DATA_LIMIT_EXCEEDED,
  APPD_IOT_MAX_SDK_STATES
} appd_iot_sdk_state_t;

typedef enum
{
  APPD_IOT_ERR_SEVERITY_ALERT,
  APPD_IOT_ERR_SEVERITY_CRITICAL,
  APPD_IOT_ERR_SEVERITY_FATAL,
  APPD_IOT_ERR_MAX_SEVERITY_LEVELS
} appd_iot_error_severity_t;


typedef enum
{
  APPD_IOT_LOG_OFF,
  APPD_IOT_LOG_ERROR,
  APPD_IOT_LOG_WARN,
  APPD_IOT_LOG_INFO,
  APPD_IOT_LOG_DEBUG,
  APPD_IOT_LOG_VERBOSE,
  APPD_IOT_LOG_ALL,
  APPD_IOT_MAX_LOG_LEVELS
} appd_iot_log_level_t;


typedef void (*appd_iot_log_write_cb_t)(const char* logmsg, size_t logmsg_len);


typedef void (*appd_iot_sdk_state_change_cb_t)(appd_iot_sdk_state_t sdk_state);

typedef struct
{
  const char* appkey;
  const char* eum_collector_url;
  appd_iot_log_level_t log_level;
  appd_iot_log_write_cb_t log_write_cb;
  appd_iot_sdk_state_change_cb_t sdk_state_change_cb;
} appd_iot_sdk_config_t;


typedef struct
{
  const char* device_name;
  const char* device_type;
  const char* device_id;
  const char* hw_version;
  const char* fw_version;
  const char* sw_version;
  const char* os_version;
} appd_iot_device_config_t;


typedef enum
{
  APPD_IOT_INTEGER,
  APPD_IOT_DOUBLE,
  APPD_IOT_STRING,
  APPD_IOT_BOOLEAN,
  APPD_IOT_DATETIME
} appd_iot_data_types_t;


typedef struct
{
  const char* key;
  union
  {
    const char* strval;
    bool boolval;
    int64_t intval;
    double doubleval;
    int64_t datetimeval;
  };
  appd_iot_data_types_t value_type;
} appd_iot_data_t;


typedef struct
{
  const char* type;
  const char* summary;
  int64_t timestamp_ms;
  int duration_ms;
  int data_count;
  appd_iot_data_t* data;
} appd_iot_custom_event_t;


typedef struct
{
  const char* url;
  const char* error;
  int duration_ms;
  int req_content_length;
  int resp_content_length;
  int resp_code;
  int resp_headers_count;
  appd_iot_data_t* resp_headers;
  int64_t timestamp_ms;
  int data_count;
  appd_iot_data_t* data;
} appd_iot_network_request_event_t;


typedef struct
{
  const char* symbol_name;
  const char* package_name;
  const char* file_name;
  int lineno;
  uint64_t absolute_addr;
  int image_offset;
  int symbol_offset;
} appd_iot_stack_frame_t;


typedef struct
{
  const char* thread;
  appd_iot_stack_frame_t* stack_frame;
  int stack_frame_count;
} appd_iot_stack_trace_t;


typedef struct
{
  const char* name;
  const char* message;
  appd_iot_error_severity_t severity;
  int64_t timestamp_ms;
  int duration_ms;
  int stack_trace_count;
  int error_stack_trace_index;
  appd_iot_stack_trace_t* stack_trace;
  int data_count;
  appd_iot_data_t* data;
} appd_iot_error_event_t;


typedef struct
{
  const char* url;
  int headers_count;
  appd_iot_data_t* headers;
  const char* type;
  const char* data;
} appd_iot_http_req_t;


typedef struct
{
  int resp_code;
  /* Optional - Indicates time taken to execute the request */
  int duration_ms;
  int headers_count;
  appd_iot_data_t* headers;
  size_t content_len;
  const char* content;
  const void* user_data;
  appd_iot_error_code_t error;
} appd_iot_http_resp_t;


typedef appd_iot_http_resp_t* (*appd_iot_http_req_send_cb_t)(const appd_iot_http_req_t* http_req);


typedef void (*appd_iot_http_resp_done_cb_t)(appd_iot_http_resp_t* http_resp);


typedef struct
{
  appd_iot_http_req_send_cb_t http_req_send_cb;
  appd_iot_http_resp_done_cb_t http_resp_done_cb;
} appd_iot_http_cb_t;


#define APPD_IOT_NUM_SERVER_CORRELATION_HEADERS 2

static inline void appd_iot_data_set_integer(appd_iot_data_t* data, const char* key, int64_t value)
{
  data->key = key;
  data->intval = value;
  data->value_type = APPD_IOT_INTEGER;
}

static inline void appd_iot_data_set_double(appd_iot_data_t* data, const char* key, double value)
{
  data->key = key;
  data->doubleval = value;
  data->value_type = APPD_IOT_DOUBLE;
}

static inline void appd_iot_data_set_datetime(appd_iot_data_t* data, const char* key, int64_t value)
{
  data->key = key;
  data->datetimeval = value;
  data->value_type = APPD_IOT_DATETIME;
}

static inline void appd_iot_data_set_boolean(appd_iot_data_t* data, const char* key, bool value)
{
  data->key = key;
  data->boolval = value;
  data->value_type = APPD_IOT_BOOLEAN;
}

static inline void appd_iot_data_set_string(appd_iot_data_t* data, const char* key, const char* value)
{
  data->key = key;
  data->strval = value;
  data->value_type = APPD_IOT_STRING;
}

static inline void appd_iot_init_to_zero(void* ptr, size_t size)
{
  memset(ptr, 0, size);
}

const char* appd_iot_error_code_to_str(appd_iot_error_code_t error_code) __APPD_IOT_API;

const char* appd_iot_sdk_state_to_str(appd_iot_sdk_state_t sdk_state) __APPD_IOT_API;

const appd_iot_data_t* appd_iot_get_server_correlation_headers(void) __APPD_IOT_API;

#ifdef __cplusplus
} /* extern "C" */
#endif  /* defined(__cplusplus) */

#endif /* appd_iot_def_h */