nm_rpc_interface.h

Go to the documentation of this file.

/*
 * NewMadeleine
 * Copyright (C) 2016-2023 (see AUTHORS file)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 */
 
#ifndef NM_RPC_INTERFACE_H
#define NM_RPC_INTERFACE_H
 
#include <nm_public.h>
#include <nm_sendrecv_interface.h>
#include <nm_session_interface.h>
 
typedef struct nm_rpc_service_s*nm_rpc_service_t;
 
typedef struct nm_rpc_req_s*nm_rpc_req_t;
 
typedef struct nm_rpc_token_s*nm_rpc_token_t;
 
typedef void (*nm_rpc_handler_t)(nm_rpc_token_t p_token);
 
typedef void (*nm_rpc_finalizer_t)(nm_rpc_token_t p_token);
 
typedef void (*nm_rpc_req_notifier_t)(nm_rpc_req_t p_req, void*ref);
 
/* ** service registration ********************************* */
 
nm_rpc_service_t nm_rpc_register(nm_session_t p_session, nm_tag_t tag, nm_tag_t tag_mask,
                                 nm_rpc_handler_t p_handler, nm_rpc_finalizer_t p_finalizer,
                                 void*ref);
 
void nm_rpc_unregister(nm_rpc_service_t p_service);
 
static inline void*nm_rpc_service_get_ref(nm_rpc_service_t p_service);
 
 
/* ** send requests **************************************** */
 
nm_rpc_req_t nm_rpc_req_init(nm_rpc_service_t p_service,  nm_gate_t p_gate, nm_tag_t tag);
 
static inline void nm_rpc_req_set_priority(nm_rpc_req_t p_req, nm_prio_t priority);
 
void nm_rpc_req_pack_header(nm_rpc_req_t p_rpc_req, const void*ptr, nm_len_t len);
 
void nm_rpc_req_pack_body(nm_rpc_req_t p_rpc_req, const void*ptr, nm_len_t len);
 
void nm_rpc_req_pack_body_data(nm_rpc_req_t p_rpc_req, const struct nm_data_s*p_data);
 
 
void nm_rpc_req_set_hlen(nm_rpc_req_t p_rpc_req, nm_len_t hlen);
 
void nm_rpc_req_isend(nm_rpc_req_t p_req);
 
static inline void nm_rpc_req_wait(nm_rpc_req_t p_req);
 
static inline void nm_rpc_req_wait_all(nm_rpc_req_t*p_reqs, int n);
 
void nm_rpc_req_set_notifier(nm_rpc_req_t p_req, nm_rpc_req_notifier_t p_notifier, void*ref);
 
nm_rpc_req_t nm_rpc_isend(nm_rpc_service_t p_service, nm_gate_t p_gate, nm_tag_t tag,
                          void*hptr, nm_len_t hlen, struct nm_data_s*p_body);
 
static inline void nm_rpc_send(nm_rpc_service_t p_service, nm_gate_t p_gate, nm_tag_t tag,
                               void*hptr, nm_len_t hlen, struct nm_data_s*p_body);
 
 
/* ** receive requests ************************************* */
 
static inline nm_gate_t nm_rpc_get_source(nm_rpc_token_t p_token);
 
static inline nm_tag_t nm_rpc_get_tag(nm_rpc_token_t p_token);
 
static inline nm_rpc_service_t nm_rpc_get_service(nm_rpc_token_t p_token);
 
static inline void nm_rpc_token_set_ref(nm_rpc_token_t p_token, void*ref);
 
static inline void*nm_rpc_token_get_ref(nm_rpc_token_t p_token);
 
static inline void nm_rpc_recv_header(nm_rpc_token_t p_token, void*hptr, nm_len_t hlen);
 
static inline void nm_rpc_recv_header_data(nm_rpc_token_t p_token, struct nm_data_s*p_header);
 
static inline void nm_rpc_irecv_body(nm_rpc_token_t p_token, void*ptr, nm_len_t len);
 
static inline void nm_rpc_irecv_body_data(nm_rpc_token_t p_token, struct nm_data_s*p_body);
 
static inline void nm_rpc_token_delay(struct nm_rpc_token_s*p_token);
 
void nm_rpc_token_complete(struct nm_rpc_token_s*p_token);
 
/* ********************************************************* */
 
#include <nm_rpc_private.h>
 
#endif /* NM_RPC_INTERFACE_H */