include/trp_ptable.h

   1 /*
   2  * Copyright (c) 2016, JANET(UK)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. Neither the name of JANET(UK) nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  29  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  31  * OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #ifndef _TRP_PTABLE_H_
  36 #define _TRP_PTABLE_H_
  37
  38 #include <time.h>
  39 #include <talloc.h>
  40
  41 #include <trust_router/tr_name.h>
  42 #include <tr_gss.h>
  43 #include <trust_router/trp.h>
  44
  45 typedef enum trp_peer_conn_status {
  46   PEER_DISCONNECTED=0,
  47   PEER_CONNECTED
  48 } TRP_PEER_CONN_STATUS;
  49
  50 typedef struct trp_peer TRP_PEER;
  51 struct trp_peer {
  52   TRP_PEER *next; /* for making a linked list */
  53   TR_NAME *label; /* often null, set on first call to trp_peer_get_label or dup_label */
  54   char *server;
  55   TR_GSS_NAMES *gss_names;
  56   TR_NAME *servicename;
  57   unsigned int port;
  58   unsigned int linkcost;
  59   struct timespec last_conn_attempt;
  60   TRP_PEER_CONN_STATUS outgoing_status;
  61   TRP_PEER_CONN_STATUS incoming_status;
  62   void (*conn_status_cb)(TRP_PEER *, void *); /* callback for connected status change */
  63   void *conn_status_cookie;
  64 };
  65
  66 typedef struct trp_ptable {
  67   TRP_PEER *head; /* head of a peer table list */
  68 } TRP_PTABLE;
  69
  70 /* iterator for the peer table */
  71 typedef TRP_PEER *TRP_PTABLE_ITER;
  72
  73 TRP_PTABLE *trp_ptable_new(TALLOC_CTX *memctx);
  74 void trp_ptable_free(TRP_PTABLE *ptbl);
  75 TRP_RC trp_ptable_add(TRP_PTABLE *ptbl, TRP_PEER *newpeer);
  76 TRP_RC trp_ptable_remove(TRP_PTABLE *ptbl, TRP_PEER *peer);
  77 TRP_PEER *trp_ptable_find_gss_name(TRP_PTABLE *ptbl, TR_NAME *gssname);
  78 TRP_PEER *trp_ptable_find_servicename(TRP_PTABLE *ptbl, TR_NAME *servicename);
  79 char *trp_ptable_to_str(TALLOC_CTX *memctx, TRP_PTABLE *ptbl, const char *sep, const char *lineterm);
  80
  81 TRP_PTABLE_ITER *trp_ptable_iter_new(TALLOC_CTX *mem_ctx);
  82 TRP_PEER *trp_ptable_iter_first(TRP_PTABLE_ITER *iter, TRP_PTABLE *ptbl);
  83 TRP_PEER *trp_ptable_iter_next(TRP_PTABLE_ITER *iter);
  84 void trp_ptable_iter_free(TRP_PTABLE_ITER *iter);
  85
  86 TRP_PEER *trp_peer_new(TALLOC_CTX *memctx);
  87 void trp_peer_free(TRP_PEER *peer);
  88 TR_NAME *trp_peer_get_label(TRP_PEER *peer);
  89 TR_NAME *trp_peer_dup_label(TRP_PEER *peer);
  90 char *trp_peer_get_server(TRP_PEER *peer);
  91 void trp_peer_set_server(TRP_PEER *peer, const char *server);
  92 void trp_peer_add_gss_name(TRP_PEER *peer, TR_NAME *gssname);
  93 void trp_peer_set_gss_names(TRP_PEER *peer, TR_GSS_NAMES *gss_names);
  94 TR_GSS_NAMES *trp_peer_get_gss_names(TRP_PEER *peer);
  95 TR_NAME *trp_peer_get_servicename(TRP_PEER *peer);
  96 TR_NAME *trp_peer_dup_servicename(TRP_PEER *peer);
  97 unsigned int trp_peer_get_port(TRP_PEER *peer);
  98 void trp_peer_set_port(TRP_PEER *peer, unsigned int port);
  99 unsigned int trp_peer_get_linkcost(TRP_PEER *peer);
 100 struct timespec *trp_peer_get_last_conn_attempt(TRP_PEER *peer);
 101 void trp_peer_set_last_conn_attempt(TRP_PEER *peer, struct timespec *time);
 102 TRP_PEER_CONN_STATUS trp_peer_get_outgoing_status(TRP_PEER *peer);
 103 void trp_peer_set_outgoing_status(TRP_PEER *peer, TRP_PEER_CONN_STATUS status);
 104 TRP_PEER_CONN_STATUS trp_peer_get_incoming_status(TRP_PEER *peer);
 105 void trp_peer_set_incoming_status(TRP_PEER *peer, TRP_PEER_CONN_STATUS status);
 106 int trp_peer_is_connected(TRP_PEER *peer);
 107 void trp_peer_set_linkcost(TRP_PEER *peer, unsigned int linkcost);
 108 void trp_peer_set_conn_status_cb(TRP_PEER *peer, void (*cb)(TRP_PEER *, void *), void *cookie);
 109 char *trp_peer_to_str(TALLOC_CTX *memctx, TRP_PEER *peer, const char *sep);
 110
 111 #endif /* _TRP_PTABLE_H_ */