include/trp_peer.h

   1 /*
   2  * Copyright (c) 2016-2018, 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 TRUST_ROUTER_TRP_PEER_H
  36 #define TRUST_ROUTER_TRP_PEER_H
  37
  38 #include <tr_gss_names.h>
  39 #include <tr_filter.h>
  40
  41 typedef enum trp_peer_conn_status {
  42   PEER_DISCONNECTED=0,
  43   PEER_CONNECTED
  44 } TRP_PEER_CONN_STATUS;
  45
  46 typedef struct trp_peer TRP_PEER;
  47 struct trp_peer {
  48   TRP_PEER *next; /* for making a linked list */
  49   TR_NAME *label; /* often null, set on first call to trp_peer_get_label or dup_label */
  50   char *server;
  51   TR_GSS_NAMES *gss_names;
  52   TR_NAME *servicename;
  53   unsigned int port;
  54   unsigned int linkcost;
  55   struct timespec last_conn_attempt;
  56   TRP_PEER_CONN_STATUS outgoing_status;
  57   TRP_PEER_CONN_STATUS incoming_status;
  58   void (*conn_status_cb)(TRP_PEER *, void *); /* callback for connected status change */
  59   void *conn_status_cookie;
  60   TR_FILTER_SET *filters;
  61 };
  62
  63
  64 TRP_PEER *trp_peer_new(TALLOC_CTX *memctx);
  65 void trp_peer_free(TRP_PEER *peer);
  66 TRP_PEER *trp_peer_tail(TRP_PEER *peer);
  67 TR_NAME *trp_peer_get_label(TRP_PEER *peer);
  68 TR_NAME *trp_peer_dup_label(TRP_PEER *peer);
  69 char *trp_peer_get_server(TRP_PEER *peer);
  70 void trp_peer_set_server(TRP_PEER *peer, const char *server);
  71 void trp_peer_add_gss_name(TRP_PEER *peer, TR_NAME *gssname);
  72 void trp_peer_set_gss_names(TRP_PEER *peer, TR_GSS_NAMES *gss_names);
  73 TR_GSS_NAMES *trp_peer_get_gss_names(TRP_PEER *peer);
  74 TR_NAME *trp_peer_get_servicename(TRP_PEER *peer);
  75 TR_NAME *trp_peer_dup_servicename(TRP_PEER *peer);
  76 unsigned int trp_peer_get_port(TRP_PEER *peer);
  77 void trp_peer_set_port(TRP_PEER *peer, unsigned int port);
  78 unsigned int trp_peer_get_linkcost(TRP_PEER *peer);
  79 struct timespec *trp_peer_get_last_conn_attempt(TRP_PEER *peer);
  80 void trp_peer_set_last_conn_attempt(TRP_PEER *peer, struct timespec *time);
  81 TRP_PEER_CONN_STATUS trp_peer_get_outgoing_status(TRP_PEER *peer);
  82 void trp_peer_set_outgoing_status(TRP_PEER *peer, TRP_PEER_CONN_STATUS status);
  83 TRP_PEER_CONN_STATUS trp_peer_get_incoming_status(TRP_PEER *peer);
  84 void trp_peer_set_incoming_status(TRP_PEER *peer, TRP_PEER_CONN_STATUS status);
  85 int trp_peer_is_connected(TRP_PEER *peer);
  86 void trp_peer_set_linkcost(TRP_PEER *peer, unsigned int linkcost);
  87 void trp_peer_set_conn_status_cb(TRP_PEER *peer, void (*cb)(TRP_PEER *, void *), void *cookie);
  88 void trp_peer_set_filters(TRP_PEER *peer, TR_FILTER_SET *filts);
  89 TR_FILTER *trp_peer_get_filter(TRP_PEER *peer, TR_FILTER_TYPE ftype);
  90
  91 /* trp_peer_encoders.c */
  92 char *trp_peer_to_str(TALLOC_CTX *memctx, TRP_PEER *peer, const char *sep);
  93
  94 #endif //TRUST_ROUTER_TRP_PEER_H