rpc_server.h

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-3.0-or-later
// RPC library server-side definitions
 
#pragma once
 
#include "librpc/rpc.h"
 
#include <mos/types.h>
 
#define RPC_MAX_ARGS 16
 
typedef struct _rpc_server rpc_server_t;
typedef struct _rpc_context rpc_context_t;
 
typedef void (*rpc_server_on_connect_t)(rpc_context_t *context);     // called when a client connects
typedef void (*rpc_server_on_disconnect_t)(rpc_context_t *context);  // called when a client disconnects
typedef rpc_result_code_t (*rpc_function_t)(rpc_context_t *context); // called when a client calls a function
 
typedef struct rpc_function_info
{
    u32 function_id;
    rpc_function_t func;
    u32 args_count;
    rpc_argtype_t args_type[RPC_MAX_ARGS];
} rpc_function_info_t;
 
MOSAPI rpc_server_t *rpc_server_create(const char *server_name, void *data);
 
MOSAPI void rpc_server_set_on_connect(rpc_server_t *server, rpc_server_on_connect_t on_connect);
 
MOSAPI void rpc_server_set_on_disconnect(rpc_server_t *server, rpc_server_on_disconnect_t on_disconnect);
 
MOSAPI void rpc_server_set_data(rpc_server_t *server, void *data);
 
MOSAPI void *rpc_server_get_data(rpc_server_t *server);
 
MOSAPI void rpc_server_exec(rpc_server_t *server);
 
MOSAPI bool rpc_server_register_functions(rpc_server_t *server, const rpc_function_info_t *functions, size_t count);
 
MOSAPI void rpc_server_close(rpc_server_t *server);
 
MOSAPI void rpc_server_destroy(rpc_server_t *server);
 
MOSAPI void *rpc_context_get_data(const rpc_context_t *context);
 
MOSAPI void *rpc_context_set_data(rpc_context_t *context, void *data);
 
MOSAPI rpc_server_t *rpc_context_get_server(const rpc_context_t *context);
 
MOSAPI int rpc_context_get_function_id(const rpc_context_t *context);
 
MOSAPI const void *rpc_arg_next(rpc_context_t *args, size_t *size);
 
MOSAPI const void *rpc_arg_sized_next(rpc_context_t *context, size_t expected_size);
MOSAPI u8 rpc_arg_next_u8(rpc_context_t *args);
MOSAPI u16 rpc_arg_next_u16(rpc_context_t *args);
MOSAPI u32 rpc_arg_next_u32(rpc_context_t *args);
MOSAPI u64 rpc_arg_next_u64(rpc_context_t *args);
MOSAPI s8 rpc_arg_next_s8(rpc_context_t *args);
MOSAPI s16 rpc_arg_next_s16(rpc_context_t *args);
MOSAPI s32 rpc_arg_next_s32(rpc_context_t *args);
MOSAPI s64 rpc_arg_next_s64(rpc_context_t *args);
MOSAPI const char *rpc_arg_next_string(rpc_context_t *context);
 
MOSAPI const void *rpc_arg(const rpc_context_t *context, size_t iarg, rpc_argtype_t type, size_t *argsize);
MOSAPI u8 rpc_arg_u8(const rpc_context_t *context, size_t iarg);
MOSAPI u16 rpc_arg_u16(const rpc_context_t *context, size_t iarg);
MOSAPI u32 rpc_arg_u32(const rpc_context_t *context, size_t iarg);
MOSAPI u64 rpc_arg_u64(const rpc_context_t *context, size_t iarg);
MOSAPI s8 rpc_arg_s8(const rpc_context_t *context, size_t iarg);
MOSAPI s16 rpc_arg_s16(const rpc_context_t *context, size_t iarg);
MOSAPI s32 rpc_arg_s32(const rpc_context_t *context, size_t iarg);
MOSAPI s64 rpc_arg_s64(const rpc_context_t *context, size_t iarg);
MOSAPI const char *rpc_arg_string(const rpc_context_t *context, size_t iarg);
 
MOSAPI void rpc_write_result(rpc_context_t *context, const void *data, size_t size);
 
// so we can use protobuf (nanopb) with librpc
typedef struct pb_msgdesc_s pb_msgdesc_t;
 
MOSAPI bool rpc_arg_pb(rpc_context_t *context, const pb_msgdesc_t *type_fields, void *val, size_t argid);
 
MOSAPI void rpc_write_result_pb(rpc_context_t *context, const pb_msgdesc_t *type_fields, const void *val);