net/golioth.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Golioth, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef GOLIOTH_INCLUDE_NET_GOLIOTH_H_
#define GOLIOTH_INCLUDE_NET_GOLIOTH_H_
 
#include <net/golioth/lightdb.h>
#include <net/golioth/rpc.h>
#include <net/golioth/settings.h>
#include <net/golioth/stream.h>
#include <stdint.h>
#include <zephyr/kernel.h>
#include <zephyr/net/coap.h>
#include <zephyr/net/tls_credentials.h>
 
#define GOLIOTH_COAP_MAX_NON_PAYLOAD_LEN    128
 
#define GOLIOTH_MAX_IDENTITY_LEN    32
#define GOLIOTH_EMPTY_PACKET_LEN    (16 + GOLIOTH_MAX_IDENTITY_LEN)
 
enum golioth_content_format {
    GOLIOTH_CONTENT_FORMAT_APP_OCTET_STREAM = COAP_CONTENT_FORMAT_APP_OCTET_STREAM,
    GOLIOTH_CONTENT_FORMAT_APP_JSON = COAP_CONTENT_FORMAT_APP_JSON,
    GOLIOTH_CONTENT_FORMAT_APP_CBOR = COAP_CONTENT_FORMAT_APP_CBOR,
};
 
struct golioth_tls {
    sec_tag_t *sec_tag_list;
    size_t sec_tag_count;
};
 
struct golioth_client {
    int proto;
 
    struct golioth_tls tls;
 
    uint8_t *rx_buffer;
    size_t rx_buffer_len;
    size_t rx_received;
 
    struct coap_packet rx_packet;
 
    struct k_mutex lock;
    int sock;
 
    sys_dlist_t coap_reqs;
    bool coap_reqs_connected;
    struct k_mutex coap_reqs_lock;
 
    void (*on_connect)(struct golioth_client *client);
 
    void (*wakeup)(struct golioth_client *client);
 
    struct golioth_rpc rpc;
    struct golioth_settings settings;
};
 
static inline void golioth_lock(struct golioth_client *client)
{
    k_mutex_lock(&client->lock, K_FOREVER);
}
 
static inline void golioth_unlock(struct golioth_client *client)
{
    k_mutex_unlock(&client->lock);
}
 
void golioth_init(struct golioth_client *client);
 
bool golioth_is_connected(struct golioth_client *client);
 
int golioth_connect(struct golioth_client *client, const char *host,
            uint16_t port);
 
int golioth_disconnect(struct golioth_client *client);
 
int golioth_set_proto_coap_dtls(struct golioth_client *client,
                sec_tag_t *sec_tag_list,
                size_t sec_tag_count);
 
int golioth_send_coap(struct golioth_client *client,
              struct coap_packet *packet);
 
int golioth_send_coap_payload(struct golioth_client *client,
                  struct coap_packet *packet,
                  uint8_t *data, uint16_t data_len);
 
int golioth_ping(struct golioth_client *client);
 
int golioth_send_hello(struct golioth_client *client);
 
int golioth_process_rx(struct golioth_client *client);
 
void golioth_poll_prepare(struct golioth_client *client, int64_t now,
              int *fd, int64_t *timeout);
 
#endif /* GOLIOTH_INCLUDE_NET_GOLIOTH_H_ */