stream: By default disable probing on unix sockets.
[openvswitch] / ovsdb / jsonrpc-server.h
1 /* Copyright (c) 2009, 2010, 2011 Nicira Networks
2  *
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #ifndef OVSDB_JSONRPC_SERVER_H
17 #define OVSDB_JSONRPC_SERVER_H 1
18
19 #include <stdbool.h>
20
21 struct ovsdb;
22 struct shash;
23
24 struct ovsdb_jsonrpc_server *ovsdb_jsonrpc_server_create(struct ovsdb *);
25 void ovsdb_jsonrpc_server_destroy(struct ovsdb_jsonrpc_server *);
26
27 /* Options for a remote. */
28 struct ovsdb_jsonrpc_options {
29     int max_backoff;            /* Maximum reconnection backoff, in msec. */
30     int probe_interval;         /* Max idle time before probing, in msec. */
31     int dscp;                   /* Dscp value for manager connections */
32 };
33 struct ovsdb_jsonrpc_options *
34 ovsdb_jsonrpc_default_options(const char *target);
35
36 void ovsdb_jsonrpc_server_set_remotes(struct ovsdb_jsonrpc_server *,
37                                       const struct shash *);
38
39 /* Status of a single remote connection. */
40 struct ovsdb_jsonrpc_remote_status {
41     const char *state;
42     int last_error;
43     unsigned int sec_since_connect;
44     unsigned int sec_since_disconnect;
45     bool is_connected;
46     char *locks_held;
47     char *locks_waiting;
48     char *locks_lost;
49     int n_connections;
50 };
51 bool ovsdb_jsonrpc_server_get_remote_status(
52     const struct ovsdb_jsonrpc_server *, const char *target,
53     struct ovsdb_jsonrpc_remote_status *);
54 void ovsdb_jsonrpc_server_free_remote_status(
55     struct ovsdb_jsonrpc_remote_status *);
56
57 void ovsdb_jsonrpc_server_reconnect(struct ovsdb_jsonrpc_server *);
58
59 void ovsdb_jsonrpc_server_run(struct ovsdb_jsonrpc_server *);
60 void ovsdb_jsonrpc_server_wait(struct ovsdb_jsonrpc_server *);
61
62 #endif /* ovsdb/jsonrpc-server.h */