lib/rconn.h

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #ifndef RCONN_H
  35 #define RCONN_H 1
  36
  37 #include "queue.h"
  38 #include <stdbool.h>
  39 #include <stdint.h>
  40 #include <time.h>
  41
  42 /* A wrapper around vconn that provides queuing and optionally reliability.
  43  *
  44  * An rconn maintains a message transmission queue of bounded length specified
  45  * by the caller.  The rconn does not guarantee reliable delivery of
  46  * queued messages: all queued messages are dropped when reconnection becomes
  47  * necessary.
  48  *
  49  * An rconn optionally provides reliable communication, in this sense: the
  50  * rconn will re-connect, with exponential backoff, when the underlying vconn
  51  * disconnects.
  52  */
  53
  54 struct vconn;
  55
  56 struct rconn *rconn_new(const char *name,
  57                         int inactivity_probe_interval, int max_backoff);
  58 struct rconn *rconn_new_from_vconn(const char *name, struct vconn *);
  59 struct rconn *rconn_create(int inactivity_probe_interval, int max_backoff);
  60 int rconn_connect(struct rconn *, const char *name);
  61 void rconn_connect_unreliably(struct rconn *,
  62                               const char *name, struct vconn *vconn);
  63 void rconn_disconnect(struct rconn *);
  64 void rconn_destroy(struct rconn *);
  65
  66 void rconn_run(struct rconn *);
  67 void rconn_run_wait(struct rconn *);
  68 struct ofpbuf *rconn_recv(struct rconn *);
  69 void rconn_recv_wait(struct rconn *);
  70 int rconn_send(struct rconn *, struct ofpbuf *, int *n_queued);
  71 int rconn_send_with_limit(struct rconn *, struct ofpbuf *,
  72                           int *n_queued, int queue_limit);
  73 unsigned int rconn_packets_sent(const struct rconn *);
  74 unsigned int rconn_packets_received(const struct rconn *);
  75
  76 void rconn_add_monitor(struct rconn *, struct vconn *);
  77
  78 const char *rconn_get_name(const struct rconn *);
  79 bool rconn_is_alive(const struct rconn *);
  80 bool rconn_is_connected(const struct rconn *);
  81 int rconn_failure_duration(const struct rconn *);
  82 bool rconn_is_connectivity_questionable(struct rconn *);
  83
  84 uint32_t rconn_get_ip(const struct rconn *);
  85
  86 const char *rconn_get_state(const struct rconn *);
  87 unsigned int rconn_get_attempted_connections(const struct rconn *);
  88 unsigned int rconn_get_successful_connections(const struct rconn *);
  89 time_t rconn_get_last_connection(const struct rconn *);
  90 time_t rconn_get_creation_time(const struct rconn *);
  91 unsigned long int rconn_get_total_time_connected(const struct rconn *);
  92 int rconn_get_backoff(const struct rconn *);
  93 unsigned int rconn_get_state_elapsed(const struct rconn *);
  94
  95 #endif /* rconn.h */