greengrasssdk.h

Go to the documentation of this file.

#ifndef _GREENGRASS_SDK_H_
#define _GREENGRASS_SDK_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdlib.h>
#include <stdint.h>
#include <sys/types.h>

/***************************************
**          Greengrass Types          **
***************************************/

typedef enum gg_error {
    GGE_SUCCESS = 0,
    GGE_OUT_OF_MEMORY,
    GGE_INVALID_PARAMETER,
    GGE_INVALID_STATE,
    GGE_INTERNAL_FAILURE,
    GGE_TERMINATE,

    GGE_RESERVED_MAX,
    GGE_RESERVED_PAD = 0x7FFFFFFF
} gg_error;

typedef struct _gg_request *gg_request;

typedef enum gg_request_status {
    GG_REQUEST_SUCCESS = 0,
    GG_REQUEST_HANDLED,
    GG_REQUEST_UNHANDLED,
    GG_REQUEST_UNKNOWN,
    GG_REQUEST_AGAIN,

    GG_REQUEST_RESERVED_MAX,
    GG_REQUEST_RESERVED_PAD = 0x7FFFFFFF
} gg_request_status;

typedef struct gg_request_result {
    gg_request_status request_status;
} gg_request_result;

typedef struct gg_lambda_context {
    const char *function_arn;
    const char *client_context;
} gg_lambda_context;

typedef enum gg_invoke_type {
    GG_INVOKE_EVENT,
    GG_INVOKE_REQUEST_RESPONSE,

    GG_INVOKE_RESERVED_MAX,
    GG_INVOKE_RESERVED_PAD = 0x7FFFFFFF
} gg_invoke_type;

typedef enum gg_runtime_opt {
    GG_RT_OPT_ASYNC = 0x1,
    GG_RT_OPT_RESERVED_PAD = 0x7FFFFFFF
} gg_runtime_opt;

typedef struct gg_invoke_options {
    const char *function_arn;
    const char *customer_context;
    const char *qualifier;
    gg_invoke_type type;
    const void *payload;
    size_t payload_size;
} gg_invoke_options;

typedef enum gg_queue_full_policy_options {
    GG_QUEUE_FULL_POLICY_BEST_EFFORT,
    GG_QUEUE_FULL_POLICY_ALL_OR_ERROR,

    GG_QUEUE_FULL_POLICY_RESERVED_MAX,
    GG_QUEUE_FULL_POLICY_RESERVED_PAD = 0x7FFFFFFF
} gg_queue_full_policy_options;

typedef struct _gg_publish_options *gg_publish_options;

typedef enum gg_log_level {
    GG_LOG_RESERVED_NOTSET,

    GG_LOG_DEBUG,
    GG_LOG_INFO,
    GG_LOG_WARN,
    GG_LOG_ERROR,
    GG_LOG_FATAL,

    GG_LOG_RESERVED_MAX,
    GG_LOG_RESERVED_PAD = 0x7FFFFFFF
} gg_log_level;

/***************************************
**            Global Methods          **
***************************************/


gg_error gg_global_init(uint32_t opt);

/***************************************
**           Logging Methods          **
***************************************/

gg_error gg_log(gg_log_level level, const char *format, ...);

/***************************************
**         gg_request Methods         **
***************************************/

gg_error gg_request_init(gg_request *ggreq);

gg_error gg_request_close(gg_request ggreq);

gg_error gg_request_read(gg_request ggreq, void *buffer, size_t buffer_size,
                         size_t *amount_read);

/***************************************
**           Runtime Methods          **
***************************************/

typedef void (*gg_lambda_handler)(const gg_lambda_context *cxt);

gg_error gg_runtime_start(gg_lambda_handler handler, uint32_t opt);

gg_error gg_lambda_handler_read(void *buffer, size_t buffer_size,
                                size_t *amount_read);

gg_error gg_lambda_handler_write_response(const void *response,
                                          size_t response_size);

gg_error gg_lambda_handler_write_error(const char *error_message);

/***************************************
**     AWS Secrets Manager Methods    **
***************************************/

gg_error gg_get_secret_value(gg_request ggreq, const char *secret_id,
        const char *version_id, const char *version_stage,
        gg_request_result *result);

/***************************************
**           Lambda Methods           **
***************************************/

gg_error gg_invoke(gg_request ggreq, const gg_invoke_options *opts,
                   gg_request_result *result);

/***************************************
**           AWS IoT Methods          **
***************************************/

gg_error gg_publish_options_init(gg_publish_options *opts);

gg_error gg_publish_options_free(gg_publish_options opts);

gg_error gg_publish_options_set_queue_full_policy(gg_publish_options opts,
        gg_queue_full_policy_options policy);

gg_error gg_publish_with_options(gg_request ggreq, const char *topic,
        const void *payload, size_t payload_size, const gg_publish_options opts,
        gg_request_result *result);

gg_error gg_publish(gg_request ggreq, const char *topic, const void *payload,
                    size_t payload_size, gg_request_result *result);

gg_error gg_get_thing_shadow(gg_request ggreq, const char *thing_name,
                             gg_request_result *result);

gg_error gg_update_thing_shadow(gg_request ggreq, const char *thing_name,
                                const char *update_payload,
                                gg_request_result *result);

gg_error gg_delete_thing_shadow(gg_request ggreq, const char *thing_name,
                                gg_request_result *result);

#ifdef __cplusplus
}
#endif

#endif /* #ifndef _GREENGRASS_SDK_H_ */