1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*
* Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2015 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef RCONN_H
#define RCONN_H 1
#include <stdbool.h>
#include <stdint.h>
#include <time.h>
#include "openvswitch/types.h"
#include "ovs-thread.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.
*
*
* Thread-safety
* =============
*
* Fully thread-safe.
*/
struct vconn;
struct rconn_packet_counter;
struct rconn *rconn_create(int inactivity_probe_interval,
int max_backoff, uint8_t dscp,
uint32_t allowed_versions);
void rconn_set_dscp(struct rconn *rc, uint8_t dscp);
uint32_t rconn_get_allowed_versions(const struct rconn *);
uint8_t rconn_get_dscp(const struct rconn *rc);
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 *);
void rconn_connect(struct rconn *, const char *target, const char *name);
void rconn_connect_unreliably(struct rconn *,
struct vconn *, const char *name);
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);
void rconn_add_monitor(struct rconn *, struct vconn *);
const char *rconn_get_name(const struct rconn *);
void rconn_set_name(struct rconn *, const char *new_name);
const char *rconn_get_target(const struct rconn *);
bool rconn_is_alive(const struct rconn *);
bool rconn_is_connected(const struct rconn *);
bool rconn_is_admitted(const struct rconn *);
int rconn_failure_duration(const struct rconn *);
int rconn_get_version(const struct rconn *);
const char *rconn_get_state(const struct rconn *);
time_t rconn_get_last_connection(const struct rconn *);
time_t rconn_get_last_disconnect(const struct rconn *);
unsigned int rconn_get_connection_seqno(const struct rconn *);
int rconn_get_last_error(const struct rconn *);
unsigned int rconn_count_txqlen(const struct rconn *);
/* Counts packets and bytes queued into an rconn by a given source. */
struct rconn_packet_counter {
struct ovs_mutex mutex;
unsigned int n_packets OVS_GUARDED; /* Number of packets queued. */
unsigned int n_bytes OVS_GUARDED; /* Number of bytes queued. */
int ref_cnt OVS_GUARDED; /* 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 *, unsigned n_bytes);
void rconn_packet_counter_dec(struct rconn_packet_counter *, unsigned n_bytes);
unsigned int rconn_packet_counter_n_packets(
const struct rconn_packet_counter *);
unsigned int rconn_packet_counter_n_bytes(const struct rconn_packet_counter *);
#endif /* rconn.h */
|
