DTNMA Reference Tools v2.1.0 - 13.gc5c0bac
Delay-Tolerant Networking Management Architecture (DTNMA) Tool Suite
Loading...
Searching...
No Matches
msg_if.h File Reference
#include "cace/ari.h"
#include "cace/util/daemon_run.h"
+ Include dependency graph for msg_if.h:
+ This graph shows which files directly or indirectly include this file:

Data Structures

struct  cace_amm_msg_if_metadata_t
 
struct  cace_amm_msg_if_t
 This message interface structure captures state necessary to use an ARI transport. More...
 

Macros

#define CACE_AMM_MSG_IF_RECV_END   2
 Status to indicate end-of-input.
 

Typedefs

typedef int(* cace_amm_msg_if_send_f) (const cace_ari_list_t data, const cace_amm_msg_if_metadata_t *meta, void *ctx)
 Message sending function.
 
typedef int(* cace_amm_msg_if_recv_f) (cace_ari_list_t data, cace_amm_msg_if_metadata_t *meta, cace_daemon_run_t *running, void *ctx)
 Message receiving function.
 

Functions

void cace_amm_msg_if_metadata_init (cace_amm_msg_if_metadata_t *meta)
 
void cace_amm_msg_if_metadata_deinit (cace_amm_msg_if_metadata_t *meta)
 

Macro Definition Documentation

◆ CACE_AMM_MSG_IF_RECV_END

#define CACE_AMM_MSG_IF_RECV_END   2

Status to indicate end-of-input.

Typedef Documentation

◆ cace_amm_msg_if_recv_f

typedef int(* cace_amm_msg_if_recv_f) (cace_ari_list_t data, cace_amm_msg_if_metadata_t *meta, cace_daemon_run_t *running, void *ctx)

Message receiving function.

Parameters
[out]dataAn empty list of ARIs to receive into.
[out]metaPointer to reception metadata, which is never NULL.
[in]runningPointer to the daemon run state, which can be checked to know when to shut down the reading thread.
[in]ctxThe user context, which may be NULL.
Returns
Zero if successful, CACE_AMM_MSG_IF_RECV_END if the input has closed (but there still may be items in data).

◆ cace_amm_msg_if_send_f

typedef int(* cace_amm_msg_if_send_f) (const cace_ari_list_t data, const cace_amm_msg_if_metadata_t *meta, void *ctx)

Message sending function.

Parameters
[in]dataThe list of ARIs to send.
[in]metaThe destination endpoint.
[in]ctxThe user context, which may be NULL.
Returns
Zero if successful, 2 if the output has closed.

Function Documentation

◆ cace_amm_msg_if_metadata_deinit()

◆ cace_amm_msg_if_metadata_init()