client.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Golioth, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#pragma once
 
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <golioth/golioth_status.h>
#include "golioth_sys.h"
 
 
struct golioth_client;
 
enum golioth_client_event
{
    GOLIOTH_CLIENT_EVENT_CONNECTED,
    GOLIOTH_CLIENT_EVENT_DISCONNECTED,
};
 
enum golioth_content_type
{
    GOLIOTH_CONTENT_TYPE_JSON,
    GOLIOTH_CONTENT_TYPE_CBOR,
    GOLIOTH_CONTENT_TYPE_OCTET_STREAM,
};
 
struct golioth_coap_rsp_code
{
    uint8_t code_class;
    uint8_t code_detail;
};
 
enum golioth_auth_type
{
    GOLIOTH_TLS_AUTH_TYPE_PSK,
    GOLIOTH_TLS_AUTH_TYPE_PKI,
    GOLIOTH_TLS_AUTH_TYPE_TAG,
};
 
struct golioth_psk_credential
{
    const char *psk_id;
    size_t psk_id_len;
 
    const char *psk;
    size_t psk_len;
};
 
struct golioth_pki_credential
{
    // DER Common CA cert
    const uint8_t *ca_cert;
    size_t ca_cert_len;
 
    const uint8_t *public_cert;
    size_t public_cert_len;
 
    const uint8_t *private_key;
    size_t private_key_len;
 
    const uint8_t *secondary_ca_cert;
    size_t secondary_ca_cert_len;
};
 
struct golioth_credential
{
    enum golioth_auth_type auth_type;
    union
    {
        struct golioth_psk_credential psk;
        struct golioth_pki_credential pki;
        int tag;
    };
};
 
struct golioth_client_config
{
    struct golioth_credential credentials;
};
 
typedef void (*golioth_client_event_cb_fn)(struct golioth_client *client,
                                           enum golioth_client_event event,
                                           void *arg);
 
typedef void (*golioth_get_cb_fn)(struct golioth_client *client,
                                  enum golioth_status status,
                                  const struct golioth_coap_rsp_code *coap_rsp_code,
                                  const char *path,
                                  const uint8_t *payload,
                                  size_t payload_size,
                                  void *arg);
 
typedef void (*golioth_set_block_cb_fn)(struct golioth_client *client,
                                        enum golioth_status status,
                                        const struct golioth_coap_rsp_code *coap_rsp_code,
                                        const char *path,
                                        size_t block_size,
                                        void *arg);
 
typedef void (*golioth_get_block_cb_fn)(struct golioth_client *client,
                                        enum golioth_status status,
                                        const struct golioth_coap_rsp_code *coap_rsp_code,
                                        const char *path,
                                        const uint8_t *payload,
                                        size_t payload_size,
                                        bool is_last,
                                        void *arg);
 
typedef void (*golioth_set_cb_fn)(struct golioth_client *client,
                                  enum golioth_status status,
                                  const struct golioth_coap_rsp_code *coap_rsp_code,
                                  const char *path,
                                  void *arg);
 
typedef void (*golioth_post_cb_fn)(struct golioth_client *client,
                                   enum golioth_status status,
                                   const struct golioth_coap_rsp_code *coap_rsp_code,
                                   const char *path,
                                   const uint8_t *payload,
                                   size_t payload_size,
                                   void *arg);
 
struct golioth_client *golioth_client_create(const struct golioth_client_config *config);
 
bool golioth_client_wait_for_connect(struct golioth_client *client, int timeout_ms);
 
enum golioth_status golioth_client_start(struct golioth_client *client);
 
enum golioth_status golioth_client_stop(struct golioth_client *client);
 
void golioth_client_destroy(struct golioth_client *client);
 
bool golioth_client_is_running(struct golioth_client *client);
 
bool golioth_client_is_connected(struct golioth_client *client);
 
void golioth_client_register_event_callback(struct golioth_client *client,
                                            golioth_client_event_cb_fn callback,
                                            void *arg);
 
uint32_t golioth_client_num_items_in_request_queue(struct golioth_client *client);
 
void golioth_client_set_packet_loss_percent(uint8_t percent);
 
golioth_sys_thread_t golioth_client_get_thread(struct golioth_client *client);
 
 
#ifdef __cplusplus
}
#endif