beacon.hpp File Reference

#include <string>
#include <map>
#include <list>
#include "appd_iot_interface.h"

Go to the source code of this file.

Data Structures
struct	data_t
struct	custom_event_t
struct	network_request_event_t
struct	stack_frame_t
struct	stack_trace_t
struct	error_event_t
struct	device_cfg_t
struct	beacon_t

Macros
#define	APPD_IOT_MAX_CUSTOM_EVENTS   200
#define	APPD_IOT_MAX_NETWORK_EVENTS   200
#define	APPD_IOT_MAX_ERROR_EVENTS   200

Functions
appd_iot_error_code_t	appd_iot_init_device_config (appd_iot_device_config_t devcfg)
	Initializes Device Configuration It is madatory to set Device ID and Device Type. More...
appd_iot_error_code_t	appd_iot_add_custom_event_to_beacon (custom_event_t event)
	Adds Custom Event to Beacon. More...
appd_iot_error_code_t	appd_iot_add_network_request_event_to_beacon (network_request_event_t event)
	Adds Network Request Event to Beacon. More...
appd_iot_error_code_t	appd_iot_add_error_event_to_beacon (error_event_t event)
	Adds Error Event to Beacon. More...
appd_iot_error_code_t	appd_iot_send_all_beacons (void)
	Sends Beacons in memory to collector. More...
appd_iot_error_code_t	appd_iot_clear_all_beacons (void)
	Clears Beacons in memory. More...

Macro Definition Documentation

APPD_IOT_MAX_CUSTOM_EVENTS

#define APPD_IOT_MAX_CUSTOM_EVENTS   200

APPD_IOT_MAX_NETWORK_EVENTS

#define APPD_IOT_MAX_NETWORK_EVENTS   200

APPD_IOT_MAX_ERROR_EVENTS

#define APPD_IOT_MAX_ERROR_EVENTS   200

Function Documentation

appd_iot_init_device_config()

appd_iot_error_code_t appd_iot_init_device_config

(

appd_iot_device_config_t

devcfg

)

Initializes Device Configuration
It is madatory to set Device ID and Device Type.

Parameters

devcfg

contains device configuration

Returns

appd_iot_error_code_t indicating function execution status

{

  if (devcfg.device_type == NULL)
  {
    appd_iot_log(APPD_IOT_LOG_ERROR, "Device Type cannot be NULL");
    return APPD_IOT_ERR_INVALID_INPUT;
  }

  global_beacon.devcfg.device_type = appd_iot_remove_character(devcfg.device_type, '|');

  if (devcfg.device_id != NULL)
  {
    global_beacon.devcfg.device_id = devcfg.device_id;
  }
  else
  {
    appd_iot_log(APPD_IOT_LOG_WARN, "Device ID is NULL");
  }

  if (devcfg.device_name != NULL)
  {
    global_beacon.devcfg.device_name = devcfg.device_name;
  }

  if (devcfg.fw_version != NULL)
  {
    global_beacon.devcfg.fw_version = devcfg.fw_version;
  }

  if (devcfg.hw_version != NULL)
  {
    global_beacon.devcfg.hw_version = devcfg.hw_version;
  }

  if (devcfg.os_version != NULL)
  {
    global_beacon.devcfg.os_version = devcfg.os_version;
  }

  if (devcfg.sw_version != NULL)
  {
    global_beacon.devcfg.sw_version = devcfg.sw_version;
  }

  return APPD_IOT_SUCCESS;
}

appd_iot_add_custom_event_to_beacon()

appd_iot_error_code_t appd_iot_add_custom_event_to_beacon

(

custom_event_t

event

)

Adds Custom Event to Beacon.

Parameters

event

contains custom event data to be sent to collector

Returns

appd_iot_error_code_t indicating function execution status

{
  if (global_beacon.custom_event_list.size() < APPD_IOT_MAX_CUSTOM_EVENTS)
  {
    global_beacon.custom_event_list.push_back(event);

    appd_iot_log(APPD_IOT_LOG_INFO, "Custom Event Added, Size:%zu", global_beacon.custom_event_list.size());

    return APPD_IOT_SUCCESS;
  }
  else
  {
    appd_iot_log(APPD_IOT_LOG_ERROR,
                 "Max Custom Events (%d) in Buffer. Send Events in Buffer to Collector before adding new events",
                 APPD_IOT_MAX_CUSTOM_EVENTS);

    return APPD_IOT_ERR_MAX_LIMIT;
  }
}

appd_iot_add_network_request_event_to_beacon()

appd_iot_error_code_t appd_iot_add_network_request_event_to_beacon

(

network_request_event_t

event

)

Adds Network Request Event to Beacon.

Parameters

event

contains network request event data to be sent to collector

Returns

appd_iot_error_code_t indicating function execution status

{
  if (global_beacon.network_request_event_list.size() < APPD_IOT_MAX_NETWORK_EVENTS)
  {
    global_beacon.network_request_event_list.push_back(event);

    appd_iot_log(APPD_IOT_LOG_INFO, "Network Event Added, Size:%zu",
                 global_beacon.network_request_event_list.size());

    return APPD_IOT_SUCCESS;
  }
  else
  {
    appd_iot_log(APPD_IOT_LOG_ERROR,
                 "Max Network Events (%d) in Buffer. Send Events in Buffer to Collector before adding new events",
                 APPD_IOT_MAX_NETWORK_EVENTS);

    return APPD_IOT_ERR_MAX_LIMIT;
  }
}

appd_iot_add_error_event_to_beacon()

appd_iot_error_code_t appd_iot_add_error_event_to_beacon

(

error_event_t

event

)

Adds Error Event to Beacon.

Parameters

event

contains error event data to be sent to collector

Returns

appd_iot_error_code_t indicating function execution status

{
  if (global_beacon.error_event_list.size() < APPD_IOT_MAX_ERROR_EVENTS)
  {
    global_beacon.error_event_list.push_back(event);

    appd_iot_log(APPD_IOT_LOG_INFO, "Error Event Added, Size:%zu", global_beacon.error_event_list.size());

    return APPD_IOT_SUCCESS;
  }
  else
  {
    appd_iot_log(APPD_IOT_LOG_ERROR,
                 "Max Error Events (%d) in Buffer. Send Events in Buffer to Collector before adding new events",
                 APPD_IOT_MAX_ERROR_EVENTS);

    return APPD_IOT_ERR_MAX_LIMIT;
  }

}

appd_iot_send_all_beacons()

appd_iot_error_code_t appd_iot_send_all_beacons

(

void

)

Sends Beacons in memory to collector.

Returns

appd_iot_error_code_t indicating function execution status

Sends Beacons in memory to collector.

Returns

appd_iot_error_code_t indicating function execution status

{

  if (global_beacon.custom_event_list.size() == 0 &&
      global_beacon.network_request_event_list.size() == 0 &&
      global_beacon.error_event_list.size() == 0)
  {
    appd_iot_log(APPD_IOT_LOG_INFO, "No Events Present");
    return APPD_IOT_SUCCESS;
  }

  appd_iot_log(APPD_IOT_LOG_INFO, "Sending All Beacons");
  appd_iot_log(APPD_IOT_LOG_INFO, "Sending %zu Custom Events", global_beacon.custom_event_list.size());
  appd_iot_log(APPD_IOT_LOG_INFO, "Sending %zu Network Events",
               global_beacon.network_request_event_list.size());
  appd_iot_log(APPD_IOT_LOG_INFO, "Sending %zu Error Events", global_beacon.error_event_list.size());

  /* Init all the data structures - REQ and RESP */
  appd_iot_http_req_t http_req;
  appd_iot_http_resp_t* http_resp = NULL;
  std::string jsondata;
  appd_iot_error_code_t retcode = APPD_IOT_SUCCESS;
  appd_iot_http_req_send_cb_t http_req_send_cb = appd_iot_get_http_req_send_cb();
  appd_iot_http_resp_done_cb_t http_resp_done_cb = appd_iot_get_http_resp_done_cb();

  if (http_req_send_cb == NULL)
  {
    appd_iot_log(APPD_IOT_LOG_ERROR, "Network Interface Not Available");
    return APPD_IOT_ERR_NETWORK_NOT_AVAILABLE;
  }

  jsondata = appd_iot_serialize_beacon_to_json(global_beacon);

  if (jsondata.empty())
  {
    appd_iot_log(APPD_IOT_LOG_ERROR, "Failed to Serialize Data to JSON Format");
    return APPD_IOT_ERR_NULL_PTR;
  }

  char jsonlen_buf[10];
  snprintf(jsonlen_buf, sizeof(jsonlen_buf), "%lu", jsondata.length());

  appd_iot_init_to_zero(&http_req, sizeof(http_req));

  http_req.data = jsondata.c_str();
  http_req.type = "POST";
  http_req.url = appd_iot_get_eum_collector_url();
  http_req.headers_count = 3;
  http_req.headers = (appd_iot_data_t*)calloc(http_req.headers_count, sizeof(appd_iot_data_t));

  if (http_req.headers == NULL)
  {
    appd_iot_log(APPD_IOT_LOG_ERROR, "Failed to Create HTTP Request Headers");
    return APPD_IOT_ERR_NULL_PTR;
  }

  appd_iot_data_set_string(&http_req.headers[0], "Accept", "application/json");
  appd_iot_data_set_string(&http_req.headers[1], "Content-Type", "application/json");
  appd_iot_data_set_string(&http_req.headers[2], "Content-Length", jsonlen_buf);

  appd_iot_log(APPD_IOT_LOG_INFO, "Content Len:%lu", jsondata.length());

  http_resp = http_req_send_cb(&http_req);

  free(http_req.headers);

  /* check if any error present in http response */
  if (http_resp != NULL)
  {
    retcode = http_resp->error;
  }
  else
  {
    appd_iot_log(APPD_IOT_LOG_ERROR, "NULL HTTP Response Returned");
    retcode = APPD_IOT_ERR_NULL_PTR;
  }

  /* Return if there is an error executing http req */
  if (retcode != APPD_IOT_SUCCESS)
  {
    appd_iot_log(APPD_IOT_LOG_ERROR, "Error Executing HTTP Request:%s",
                 appd_iot_error_code_to_str(retcode));

    if (http_resp_done_cb != NULL)
    {
      http_resp_done_cb(http_resp);
    }

    return retcode;
  }

  /* Read http response headers, content and response code */
  for (int i = 0; i < http_resp->headers_count; i++)
  {
    if ((http_resp->headers + i) == NULL)
    {
      continue;
    }

    if (http_resp->headers[i].key == NULL || http_resp->headers[i].strval == NULL ||
        http_resp->headers[i].value_type != APPD_IOT_STRING)
    {
      continue;
    }

    appd_iot_log(APPD_IOT_LOG_INFO, "Response Header%d (%s:%s)", i, http_resp->headers[i].key,
                 http_resp->headers[i].strval);
  }

  if (http_resp->content_len > 0)
  {
    appd_iot_log(APPD_IOT_LOG_INFO, "Response Content Len:%lu", http_resp->content_len);
    appd_iot_log(APPD_IOT_LOG_INFO, "Response Content:%s", http_resp->content);
  }


  if (http_resp->resp_code >= 200 && http_resp->resp_code < 300)
  {
    appd_iot_log(APPD_IOT_LOG_INFO, "RespCode:%d Beacon Sent Successfully", http_resp->resp_code);
    appd_iot_clear_all_beacons();
    retcode = APPD_IOT_SUCCESS;
  }
  else if ((http_resp->resp_code == 402) ||
           (http_resp->resp_code == 403) ||
           (http_resp->resp_code == 429))
  {
    appd_iot_clear_all_beacons();
    appd_iot_disable_sdk(http_resp->resp_code);
    retcode = APPD_IOT_ERR_NETWORK_REJECT;
  }
  else
  {
    appd_iot_log(APPD_IOT_LOG_ERROR, "Resp Code:%d Send Beacons Network Request Failed", http_resp->resp_code);
    retcode = APPD_IOT_ERR_NETWORK_ERROR;
  }

  if (http_resp_done_cb != NULL)
  {
    http_resp_done_cb(http_resp);
  }

  return retcode;
}

appd_iot_clear_all_beacons()

appd_iot_error_code_t appd_iot_clear_all_beacons

(

void

)

Clears Beacons in memory.

Returns

appd_iot_error_code_t indicating function execution status

{
  appd_iot_log(APPD_IOT_LOG_INFO, "Clearing All Beacons");
  appd_iot_log(APPD_IOT_LOG_INFO, "Clearing %zu Custom Events", global_beacon.custom_event_list.size());
  appd_iot_log(APPD_IOT_LOG_INFO, "Clearing %zu Network Events",
               global_beacon.network_request_event_list.size());
  appd_iot_log(APPD_IOT_LOG_INFO, "Clearing %zu Error Events", global_beacon.error_event_list.size());

  global_beacon.custom_event_list.clear();
  global_beacon.network_request_event_list.clear();
  global_beacon.error_event_list.clear();

  return APPD_IOT_SUCCESS;
}