2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
23 #include "openvswitch/types.h"
25 /* A wrapper around vconn that provides queuing and optionally reliability.
27 * An rconn maintains a message transmission queue of bounded length specified
28 * by the caller. The rconn does not guarantee reliable delivery of
29 * queued messages: all queued messages are dropped when reconnection becomes
32 * An rconn optionally provides reliable communication, in this sense: the
33 * rconn will re-connect, with exponential backoff, when the underlying vconn
38 struct rconn_packet_counter
;
40 struct rconn
*rconn_create(int inactivity_probe_interval
,
41 int max_backoff
, uint8_t dscp
,
42 uint32_t allowed_versions
);
43 void rconn_set_dscp(struct rconn
*rc
, uint8_t dscp
);
44 uint32_t rconn_get_allowed_versions(const struct rconn
*);
45 uint8_t rconn_get_dscp(const struct rconn
*rc
);
46 void rconn_set_max_backoff(struct rconn
*, int max_backoff
);
47 int rconn_get_max_backoff(const struct rconn
*);
48 void rconn_set_probe_interval(struct rconn
*, int inactivity_probe_interval
);
49 int rconn_get_probe_interval(const struct rconn
*);
51 void rconn_connect(struct rconn
*, const char *target
, const char *name
);
52 void rconn_connect_unreliably(struct rconn
*,
53 struct vconn
*, const char *name
);
54 void rconn_reconnect(struct rconn
*);
55 void rconn_disconnect(struct rconn
*);
56 void rconn_destroy(struct rconn
*);
58 void rconn_run(struct rconn
*);
59 void rconn_run_wait(struct rconn
*);
60 struct ofpbuf
*rconn_recv(struct rconn
*);
61 void rconn_recv_wait(struct rconn
*);
62 int rconn_send(struct rconn
*, struct ofpbuf
*, struct rconn_packet_counter
*);
63 int rconn_send_with_limit(struct rconn
*, struct ofpbuf
*,
64 struct rconn_packet_counter
*, int queue_limit
);
65 unsigned int rconn_packets_sent(const struct rconn
*);
66 unsigned int rconn_packets_received(const struct rconn
*);
68 void rconn_add_monitor(struct rconn
*, struct vconn
*);
70 const char *rconn_get_name(const struct rconn
*);
71 void rconn_set_name(struct rconn
*, const char *new_name
);
72 const char *rconn_get_target(const struct rconn
*);
74 bool rconn_is_alive(const struct rconn
*);
75 bool rconn_is_connected(const struct rconn
*);
76 bool rconn_is_admitted(const struct rconn
*);
77 int rconn_failure_duration(const struct rconn
*);
79 ovs_be32
rconn_get_remote_ip(const struct rconn
*);
80 ovs_be16
rconn_get_remote_port(const struct rconn
*);
81 ovs_be32
rconn_get_local_ip(const struct rconn
*);
82 ovs_be16
rconn_get_local_port(const struct rconn
*);
83 int rconn_get_version(const struct rconn
*);
85 const char *rconn_get_state(const struct rconn
*);
86 time_t rconn_get_last_connection(const struct rconn
*);
87 time_t rconn_get_last_disconnect(const struct rconn
*);
88 unsigned int rconn_get_connection_seqno(const struct rconn
*);
89 int rconn_get_last_error(const struct rconn
*);
90 unsigned int rconn_count_txqlen(const struct rconn
*);
92 /* Counts packets and bytes queued into an rconn by a given source. */
93 struct rconn_packet_counter
{
94 unsigned int n_packets
; /* Number of packets queued. */
95 unsigned int n_bytes
; /* Number of bytes queued. */
96 int ref_cnt
; /* Number of owners. */
99 struct rconn_packet_counter
*rconn_packet_counter_create(void);
100 void rconn_packet_counter_destroy(struct rconn_packet_counter
*);
101 void rconn_packet_counter_inc(struct rconn_packet_counter
*, unsigned n_bytes
);
102 void rconn_packet_counter_dec(struct rconn_packet_counter
*, unsigned n_bytes
);