mirror of
https://github.com/openvswitch/ovs
synced 2025-10-25 15:07:05 +00:00
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
This commit is contained in:
104
lib/rconn.h
Normal file
104
lib/rconn.h
Normal file
@@ -0,0 +1,104 @@
|
||||
/*
|
||||
* Copyright (c) 2008, 2009 Nicira Networks.
|
||||
*
|
||||
* Permission to use, copy, modify, and/or distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef RCONN_H
|
||||
#define RCONN_H 1
|
||||
|
||||
#include "queue.h"
|
||||
#include <stdbool.h>
|
||||
#include <stdint.h>
|
||||
#include <time.h>
|
||||
|
||||
/* A wrapper around vconn that provides queuing and optionally reliability.
|
||||
*
|
||||
* An rconn maintains a message transmission queue of bounded length specified
|
||||
* by the caller. The rconn does not guarantee reliable delivery of
|
||||
* queued messages: all queued messages are dropped when reconnection becomes
|
||||
* necessary.
|
||||
*
|
||||
* An rconn optionally provides reliable communication, in this sense: the
|
||||
* rconn will re-connect, with exponential backoff, when the underlying vconn
|
||||
* disconnects.
|
||||
*/
|
||||
|
||||
struct vconn;
|
||||
struct rconn_packet_counter;
|
||||
|
||||
struct rconn *rconn_new(const char *name,
|
||||
int inactivity_probe_interval, int max_backoff);
|
||||
struct rconn *rconn_new_from_vconn(const char *name, struct vconn *);
|
||||
struct rconn *rconn_create(int inactivity_probe_interval, int max_backoff);
|
||||
|
||||
void rconn_set_max_backoff(struct rconn *, int max_backoff);
|
||||
int rconn_get_max_backoff(const struct rconn *);
|
||||
void rconn_set_probe_interval(struct rconn *, int inactivity_probe_interval);
|
||||
int rconn_get_probe_interval(const struct rconn *);
|
||||
|
||||
int rconn_connect(struct rconn *, const char *name);
|
||||
void rconn_connect_unreliably(struct rconn *,
|
||||
const char *name, struct vconn *vconn);
|
||||
void rconn_reconnect(struct rconn *);
|
||||
void rconn_disconnect(struct rconn *);
|
||||
void rconn_destroy(struct rconn *);
|
||||
|
||||
void rconn_run(struct rconn *);
|
||||
void rconn_run_wait(struct rconn *);
|
||||
struct ofpbuf *rconn_recv(struct rconn *);
|
||||
void rconn_recv_wait(struct rconn *);
|
||||
int rconn_send(struct rconn *, struct ofpbuf *, struct rconn_packet_counter *);
|
||||
int rconn_send_with_limit(struct rconn *, struct ofpbuf *,
|
||||
struct rconn_packet_counter *, int queue_limit);
|
||||
unsigned int rconn_packets_sent(const struct rconn *);
|
||||
unsigned int rconn_packets_received(const struct rconn *);
|
||||
|
||||
void rconn_add_monitor(struct rconn *, struct vconn *);
|
||||
|
||||
const char *rconn_get_name(const struct rconn *);
|
||||
bool rconn_is_alive(const struct rconn *);
|
||||
bool rconn_is_connected(const struct rconn *);
|
||||
int rconn_failure_duration(const struct rconn *);
|
||||
bool rconn_is_connectivity_questionable(struct rconn *);
|
||||
|
||||
uint32_t rconn_get_ip(const struct rconn *);
|
||||
|
||||
const char *rconn_get_state(const struct rconn *);
|
||||
unsigned int rconn_get_attempted_connections(const struct rconn *);
|
||||
unsigned int rconn_get_successful_connections(const struct rconn *);
|
||||
time_t rconn_get_last_connection(const struct rconn *);
|
||||
time_t rconn_get_creation_time(const struct rconn *);
|
||||
unsigned long int rconn_get_total_time_connected(const struct rconn *);
|
||||
int rconn_get_backoff(const struct rconn *);
|
||||
unsigned int rconn_get_state_elapsed(const struct rconn *);
|
||||
unsigned int rconn_get_connection_seqno(const struct rconn *);
|
||||
|
||||
/* Counts the number of packets queued into an rconn by a given source. */
|
||||
struct rconn_packet_counter {
|
||||
int n; /* Number of packets queued. */
|
||||
int ref_cnt; /* Number of owners. */
|
||||
};
|
||||
|
||||
struct rconn_packet_counter *rconn_packet_counter_create(void);
|
||||
void rconn_packet_counter_destroy(struct rconn_packet_counter *);
|
||||
void rconn_packet_counter_inc(struct rconn_packet_counter *);
|
||||
void rconn_packet_counter_dec(struct rconn_packet_counter *);
|
||||
|
||||
static inline int
|
||||
rconn_packet_counter_read(const struct rconn_packet_counter *counter)
|
||||
{
|
||||
return counter->n;
|
||||
}
|
||||
|
||||
#endif /* rconn.h */
|
||||
Reference in New Issue
Block a user