include/trust_router/trp.h

   1 #ifndef TRP_H
   2 #define TRP_H
   3
   4 #include <talloc.h>
   5
   6 #include <trust_router/tr_name.h>
   7 #include <trust_router/tr_versioning.h>
   8
   9 #define TRP_PORT 12308
  10 #define TRP_METRIC_INFINITY 0xFFFF
  11 #define TRP_METRIC_INVALID 0xFFFFFFFF
  12 #define trp_metric_is_finite(x) (((x)<TRP_METRIC_INFINITY) && ((x)!=TRP_METRIC_INVALID))
  13 #define trp_metric_is_infinite(x) ((x)==TRP_METRIC_INFINITY)
  14 #define trp_metric_is_valid(x) (((x)<=TRP_METRIC_INFINITY) && ((x)!=TRP_METRIC_INVALID))
  15 #define trp_metric_is_invalid(x) (((x)>TRP_METRIC_INFINITY) || ((x)==TRP_METRIC_INVALID))
  16 #define TRP_INTERVAL_INVALID 0
  17
  18 #define TRP_LINKCOST_DEFAULT 1
  19
  20 typedef enum trp_rc {
  21   TRP_SUCCESS=0,
  22   TRP_ERROR, /* generic error */
  23   TRP_NOPARSE, /* parse error */
  24   TRP_NOMEM, /* allocation error */
  25   TRP_BADTYPE, /* typing error */
  26   TRP_UNSUPPORTED, /* unsupported feature */
  27   TRP_BADARG, /* bad argument */
  28   TRP_CLOCKERR, /* error reading time */
  29 } TRP_RC;
  30
  31 typedef enum trp_inforec_type {
  32   TRP_INFOREC_TYPE_UNKNOWN=0, /* conveniently, JSON parser returns 0 if a non-integer number is specified */
  33   TRP_INFOREC_TYPE_ROUTE,
  34   TRP_INFOREC_TYPE_COMMUNITY, /* not yet implemented (2016-06-14) */
  35 } TRP_INFOREC_TYPE;
  36
  37 typedef struct trp_inforec TRP_INFOREC;
  38
  39 typedef struct trp_update TRP_UPD;
  40 typedef struct trp_req TRP_REQ;
  41
  42 /* Functions for TRP_UPD structures */
  43 TR_EXPORT TRP_UPD *trp_upd_new(TALLOC_CTX *mem_ctx);
  44 void trp_upd_free(TRP_UPD *update);
  45 TR_EXPORT TRP_INFOREC *trp_upd_get_inforec(TRP_UPD *upd);
  46 void trp_upd_set_inforec(TRP_UPD *upd, TRP_INFOREC *rec);
  47 void trp_upd_add_inforec(TRP_UPD *upd, TRP_INFOREC *rec);
  48 TR_EXPORT TR_NAME *trp_upd_get_peer(TRP_UPD *upd);
  49 TR_NAME *trp_upd_dup_peer(TRP_UPD *upd);
  50 void trp_upd_set_peer(TRP_UPD *upd, TR_NAME *peer);
  51 void trp_upd_set_next_hop(TRP_UPD *upd, const char *hostname, unsigned int port);
  52 TR_EXPORT TRP_INFOREC *trp_inforec_new(TALLOC_CTX *mem_ctx, TRP_INFOREC_TYPE type);
  53 void trp_inforec_free(TRP_INFOREC *rec);
  54 TR_EXPORT TRP_INFOREC *trp_inforec_get_next(TRP_INFOREC *rec);
  55 void trp_inforec_set_next(TRP_INFOREC *rec, TRP_INFOREC *next_rec);
  56 TR_EXPORT TRP_INFOREC_TYPE trp_inforec_get_type(TRP_INFOREC *rec);
  57 void trp_inforec_set_type(TRP_INFOREC *rec, TRP_INFOREC_TYPE type);
  58 TR_EXPORT TR_NAME *trp_inforec_get_comm(TRP_INFOREC *rec);
  59 TR_EXPORT TR_NAME *trp_inforec_dup_comm(TRP_INFOREC *rec);
  60 TRP_RC trp_inforec_set_comm(TRP_INFOREC *rec, TR_NAME *comm);
  61 TR_EXPORT TR_NAME *trp_inforec_get_realm(TRP_INFOREC *rec);
  62 TR_EXPORT TR_NAME *trp_inforec_dup_realm(TRP_INFOREC *rec);
  63 TRP_RC trp_inforec_set_realm(TRP_INFOREC *rec, TR_NAME *realm);
  64 TR_EXPORT TR_NAME *trp_inforec_get_trust_router(TRP_INFOREC *rec);
  65 TR_EXPORT TR_NAME *trp_inforec_dup_trust_router(TRP_INFOREC *rec);
  66 TRP_RC trp_inforec_set_trust_router(TRP_INFOREC *rec, TR_NAME *trust_router);
  67 TR_EXPORT TR_NAME *trp_inforec_get_next_hop(TRP_INFOREC *rec);
  68 TR_EXPORT TR_NAME *trp_inforec_dup_next_hop(TRP_INFOREC *rec);
  69 TRP_RC trp_inforec_set_next_hop(TRP_INFOREC *rec, TR_NAME *next_hop);
  70 TR_EXPORT unsigned int trp_inforec_get_metric(TRP_INFOREC *rec);
  71 TRP_RC trp_inforec_set_metric(TRP_INFOREC *rec, unsigned int metric);
  72 TR_EXPORT unsigned int trp_inforec_get_interval(TRP_INFOREC *rec);
  73 TRP_RC trp_inforec_set_interval(TRP_INFOREC *rec, unsigned int interval);
  74 TR_EXPORT TRP_INFOREC_TYPE trp_inforec_type_from_string(const char *s);
  75 TR_EXPORT const char *trp_inforec_type_to_string(TRP_INFOREC_TYPE msgtype);
  76
  77 /* Functions for TRP_REQ structures */
  78 TR_EXPORT TRP_REQ *trp_req_new(TALLOC_CTX *mem_ctx);
  79 TR_EXPORT void trp_req_free(TRP_REQ *req);
  80 TR_EXPORT TR_NAME *trp_req_get_comm(TRP_REQ *req);
  81 void trp_req_set_comm(TRP_REQ *req, TR_NAME *comm);
  82 TR_EXPORT TR_NAME *trp_req_get_realm(TRP_REQ *req);
  83 void trp_req_set_realm(TRP_REQ *req, TR_NAME *realm);
  84 TR_EXPORT TR_NAME *trp_req_get_peer(TRP_REQ *req);
  85 void trp_req_set_peer(TRP_REQ *req, TR_NAME *peer);
  86 int trp_req_is_wildcard(TRP_REQ *req);
  87 TRP_RC trp_req_make_wildcard(TRP_REQ *req);
  88
  89 #endif /* TRP_H */