ovsdb/jsonrpc-server.h

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