rpc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-2023 Golioth, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef GOLIOTH_INCLUDE_NET_GOLIOTH_RPC_H_
#define GOLIOTH_INCLUDE_NET_GOLIOTH_RPC_H_
 
#include <stdint.h>
#include <zephyr/net/coap.h>
#include <zephyr/kernel.h>
 
#ifdef CONFIG_ZCBOR
#include <zcbor_decode.h>
#include <zcbor_encode.h>
#else
typedef struct {} zcbor_state_t;
#endif
 
struct golioth_client;
 
enum golioth_rpc_status {
    GOLIOTH_RPC_OK = 0,
    GOLIOTH_RPC_CANCELED = 1,
    GOLIOTH_RPC_UNKNOWN = 2,
    GOLIOTH_RPC_INVALID_ARGUMENT = 3,
    GOLIOTH_RPC_DEADLINE_EXCEEDED = 4,
    GOLIOTH_RPC_NOT_FOUND = 5,
    GOLIOTH_RPC_ALREADYEXISTS = 6,
    GOLIOTH_RPC_PERMISSION_DENIED = 7,
    GOLIOTH_RPC_RESOURCE_EXHAUSTED = 8,
    GOLIOTH_RPC_FAILED_PRECONDITION = 9,
    GOLIOTH_RPC_ABORTED = 10,
    GOLIOTH_RPC_OUT_OF_RANGE = 11,
    GOLIOTH_RPC_UNIMPLEMENTED = 12,
    GOLIOTH_RPC_INTERNAL = 13,
    GOLIOTH_RPC_UNAVAILABLE = 14,
    GOLIOTH_RPC_DATA_LOSS = 15,
    GOLIOTH_RPC_UNAUTHENTICATED = 16,
};
 
typedef enum golioth_rpc_status (*golioth_rpc_cb_fn)(zcbor_state_t *request_params_array,
                             zcbor_state_t *response_detail_map,
                             void *callback_arg);
 
struct golioth_rpc_method {
    const char *name;
    golioth_rpc_cb_fn callback;
    void *callback_arg;
};
 
struct golioth_rpc {
#if defined(CONFIG_GOLIOTH_RPC)
    struct golioth_rpc_method methods[CONFIG_GOLIOTH_RPC_MAX_NUM_METHODS];
    int num_methods;
    struct k_mutex mutex;
#endif
};
 
int golioth_rpc_init(struct golioth_client *client);
 
int golioth_rpc_register(struct golioth_client *client,
             const char *method_name,
             golioth_rpc_cb_fn callback,
             void *callback_arg);
 
int golioth_rpc_observe(struct golioth_client *client);
 
#endif /* GOLIOTH_INCLUDE_NET_GOLIOTH_RPC_H_ */