golioth_client.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Golioth, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>  // size_t
#include "golioth_status.h"
#include "golioth_sys.h"
 
 
typedef void* golioth_client_t;
 
typedef enum {
    GOLIOTH_CLIENT_EVENT_CONNECTED,
    GOLIOTH_CLIENT_EVENT_DISCONNECTED,
} golioth_client_event_t;
 
typedef struct {
    golioth_status_t status;
    uint8_t status_class;
    uint8_t status_code;
} golioth_response_t;
 
typedef enum {
    GOLIOTH_TLS_AUTH_TYPE_PSK,
    GOLIOTH_TLS_AUTH_TYPE_PKI,
} golioth_tls_auth_type_t;
 
typedef struct {
    const char* psk_id;
    size_t psk_id_len;
 
    const char* psk;
    size_t psk_len;
} golioth_psk_credentials_t;
 
typedef struct {
    // PEM 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;
} golioth_pki_credentials_t;
 
typedef struct {
    golioth_tls_auth_type_t auth_type;
    union {
        golioth_psk_credentials_t psk;
        golioth_pki_credentials_t pki;
    };
} golioth_tls_credentials_t;
 
typedef struct {
    golioth_tls_credentials_t credentials;
} golioth_client_config_t;
 
typedef void (*golioth_client_event_cb_fn)(
        golioth_client_t client,
        golioth_client_event_t event,
        void* arg);
 
typedef void (*golioth_get_cb_fn)(
        golioth_client_t client,
        const golioth_response_t* response,
        const char* path,
        const uint8_t* payload,
        size_t payload_size,
        void* arg);
typedef void (*golioth_get_block_cb_fn)(
        golioth_client_t client,
        const golioth_response_t* response,
        const char* path,
        const uint8_t* payload,
        size_t payload_size,
        bool is_last,
        void* arg);
 
typedef void (*golioth_set_cb_fn)(
        golioth_client_t client,
        const golioth_response_t* response,
        const char* path,
        void* arg);
 
golioth_client_t golioth_client_create(const golioth_client_config_t* config);
 
bool golioth_client_wait_for_connect(golioth_client_t client, int timeout_ms);
 
golioth_status_t golioth_client_start(golioth_client_t client);
 
golioth_status_t golioth_client_stop(golioth_client_t client);
 
void golioth_client_destroy(golioth_client_t client);
 
bool golioth_client_is_running(golioth_client_t client);
 
bool golioth_client_is_connected(golioth_client_t client);
 
void golioth_client_register_event_callback(
        golioth_client_t client,
        golioth_client_event_cb_fn callback,
        void* arg);
 
uint32_t golioth_client_num_items_in_request_queue(golioth_client_t client);
 
void golioth_client_set_packet_loss_percent(uint8_t percent);
 
bool golioth_client_has_allocation_leaks(void);
 
golioth_sys_thread_t golioth_client_get_thread(golioth_client_t client);