ovsdb/jsonrpc-server.h

   1 /* Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
   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 struct simap;
  24
  25 struct ovsdb_jsonrpc_server *ovsdb_jsonrpc_server_create(struct ovsdb *);
  26 void ovsdb_jsonrpc_server_destroy(struct ovsdb_jsonrpc_server *);
  27
  28 /* Options for a remote. */
  29 struct ovsdb_jsonrpc_options {
  30     int max_backoff;            /* Maximum reconnection backoff, in msec. */
  31     int probe_interval;         /* Max idle time before probing, in msec. */
  32     int dscp;                   /* Dscp value for manager connections */
  33 };
  34 struct ovsdb_jsonrpc_options *
  35 ovsdb_jsonrpc_default_options(const char *target);
  36
  37 void ovsdb_jsonrpc_server_set_remotes(struct ovsdb_jsonrpc_server *,
  38                                       const struct shash *);
  39
  40 /* Status of a single remote connection. */
  41 struct ovsdb_jsonrpc_remote_status {
  42     const char *state;
  43     int last_error;
  44     unsigned int sec_since_connect;
  45     unsigned int sec_since_disconnect;
  46     bool is_connected;
  47     char *locks_held;
  48     char *locks_waiting;
  49     char *locks_lost;
  50     int n_connections;
  51 };
  52 bool ovsdb_jsonrpc_server_get_remote_status(
  53     const struct ovsdb_jsonrpc_server *, const char *target,
  54     struct ovsdb_jsonrpc_remote_status *);
  55 void ovsdb_jsonrpc_server_free_remote_status(
  56     struct ovsdb_jsonrpc_remote_status *);
  57
  58 void ovsdb_jsonrpc_server_reconnect(struct ovsdb_jsonrpc_server *);
  59
  60 void ovsdb_jsonrpc_server_run(struct ovsdb_jsonrpc_server *);
  61 void ovsdb_jsonrpc_server_wait(struct ovsdb_jsonrpc_server *);
  62
  63 void ovsdb_jsonrpc_server_get_memory_usage(const struct ovsdb_jsonrpc_server *,
  64                                            struct simap *usage);
  65
  66 #endif /* ovsdb/jsonrpc-server.h */