2 * Copyright (c) 2009, 2010, 2012, 2013 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.
20 /* This is an implementation of the JSON-RPC 1.0 specification defined at
21 * http://json-rpc.org/wiki/specification. */
25 #include "openvswitch/types.h"
30 struct reconnect_stats;
33 /* API for a JSON-RPC stream. */
35 /* Default port numbers.
37 * OVSDB_OLD_PORT defines the original port number used by OVS.
38 * OVSDB_PORT defines the official port number assigned by IANA. By
39 * default, we still uses OVSDB_OLD_PORT, but we present a warning that
40 * that will change. */
41 #define OVSDB_OLD_PORT 6632
42 #define OVSDB_PORT 6640
44 int jsonrpc_stream_open(const char *name, struct stream **, uint8_t dscp);
45 int jsonrpc_pstream_open(const char *name, struct pstream **, uint8_t dscp);
47 struct jsonrpc *jsonrpc_open(struct stream *);
48 void jsonrpc_close(struct jsonrpc *);
50 void jsonrpc_run(struct jsonrpc *);
51 void jsonrpc_wait(struct jsonrpc *);
53 int jsonrpc_get_status(const struct jsonrpc *);
54 size_t jsonrpc_get_backlog(const struct jsonrpc *);
55 unsigned int jsonrpc_get_received_bytes(const struct jsonrpc *);
56 const char *jsonrpc_get_name(const struct jsonrpc *);
58 int jsonrpc_send(struct jsonrpc *, struct jsonrpc_msg *);
59 int jsonrpc_recv(struct jsonrpc *, struct jsonrpc_msg **);
60 void jsonrpc_recv_wait(struct jsonrpc *);
62 int jsonrpc_send_block(struct jsonrpc *, struct jsonrpc_msg *);
63 int jsonrpc_recv_block(struct jsonrpc *, struct jsonrpc_msg **);
64 int jsonrpc_transact_block(struct jsonrpc *, struct jsonrpc_msg *,
65 struct jsonrpc_msg **);
68 enum jsonrpc_msg_type {
69 JSONRPC_REQUEST, /* Request. */
70 JSONRPC_NOTIFY, /* Notification. */
71 JSONRPC_REPLY, /* Successful reply. */
72 JSONRPC_ERROR /* Error reply. */
76 enum jsonrpc_msg_type type;
77 char *method; /* Request or notification only. */
78 struct json *params; /* Request or notification only. */
79 struct json *result; /* Successful reply only. */
80 struct json *error; /* Error reply only. */
81 struct json *id; /* Request or reply only. */
84 struct jsonrpc_msg *jsonrpc_create_request(const char *method,
87 struct jsonrpc_msg *jsonrpc_create_notify(const char *method,
89 struct jsonrpc_msg *jsonrpc_create_reply(struct json *result,
90 const struct json *id);
91 struct jsonrpc_msg *jsonrpc_create_error(struct json *error,
92 const struct json *id);
94 const char *jsonrpc_msg_type_to_string(enum jsonrpc_msg_type);
95 char *jsonrpc_msg_is_valid(const struct jsonrpc_msg *);
96 void jsonrpc_msg_destroy(struct jsonrpc_msg *);
98 char *jsonrpc_msg_from_json(struct json *, struct jsonrpc_msg **);
99 struct json *jsonrpc_msg_to_json(struct jsonrpc_msg *);
101 /* A JSON-RPC session with reconnection. */
103 struct jsonrpc_session *jsonrpc_session_open(const char *name, bool retry);
104 struct jsonrpc_session *jsonrpc_session_open_unreliably(struct jsonrpc *,
106 void jsonrpc_session_close(struct jsonrpc_session *);
108 void jsonrpc_session_run(struct jsonrpc_session *);
109 void jsonrpc_session_wait(struct jsonrpc_session *);
111 size_t jsonrpc_session_get_backlog(const struct jsonrpc_session *);
112 const char *jsonrpc_session_get_name(const struct jsonrpc_session *);
114 int jsonrpc_session_send(struct jsonrpc_session *, struct jsonrpc_msg *);
115 struct jsonrpc_msg *jsonrpc_session_recv(struct jsonrpc_session *);
116 void jsonrpc_session_recv_wait(struct jsonrpc_session *);
118 bool jsonrpc_session_is_alive(const struct jsonrpc_session *);
119 bool jsonrpc_session_is_connected(const struct jsonrpc_session *);
120 unsigned int jsonrpc_session_get_seqno(const struct jsonrpc_session *);
121 int jsonrpc_session_get_status(const struct jsonrpc_session *);
122 int jsonrpc_session_get_last_error(const struct jsonrpc_session *);
123 void jsonrpc_session_get_reconnect_stats(const struct jsonrpc_session *,
124 struct reconnect_stats *);
126 void jsonrpc_session_force_reconnect(struct jsonrpc_session *);
128 void jsonrpc_session_set_max_backoff(struct jsonrpc_session *,
130 void jsonrpc_session_set_probe_interval(struct jsonrpc_session *,
132 void jsonrpc_session_set_dscp(struct jsonrpc_session *,
135 #endif /* jsonrpc.h */