]>
git.proxmox.com Git - ovs.git/blob - lib/jsonrpc.h
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. */
39 #define OVSDB_OLD_PORT 6632
40 #define OVSDB_PORT 6640
42 int jsonrpc_stream_open(const char *name
, struct stream
**, uint8_t dscp
);
43 int jsonrpc_pstream_open(const char *name
, struct pstream
**, uint8_t dscp
);
45 struct jsonrpc
*jsonrpc_open(struct stream
*);
46 void jsonrpc_close(struct jsonrpc
*);
48 void jsonrpc_run(struct jsonrpc
*);
49 void jsonrpc_wait(struct jsonrpc
*);
51 int jsonrpc_get_status(const struct jsonrpc
*);
52 size_t jsonrpc_get_backlog(const struct jsonrpc
*);
53 unsigned int jsonrpc_get_received_bytes(const struct jsonrpc
*);
54 const char *jsonrpc_get_name(const struct jsonrpc
*);
56 int jsonrpc_send(struct jsonrpc
*, struct jsonrpc_msg
*);
57 int jsonrpc_recv(struct jsonrpc
*, struct jsonrpc_msg
**);
58 void jsonrpc_recv_wait(struct jsonrpc
*);
60 int jsonrpc_send_block(struct jsonrpc
*, struct jsonrpc_msg
*);
61 int jsonrpc_recv_block(struct jsonrpc
*, struct jsonrpc_msg
**);
62 int jsonrpc_transact_block(struct jsonrpc
*, struct jsonrpc_msg
*,
63 struct jsonrpc_msg
**);
66 enum jsonrpc_msg_type
{
67 JSONRPC_REQUEST
, /* Request. */
68 JSONRPC_NOTIFY
, /* Notification. */
69 JSONRPC_REPLY
, /* Successful reply. */
70 JSONRPC_ERROR
/* Error reply. */
74 enum jsonrpc_msg_type type
;
75 char *method
; /* Request or notification only. */
76 struct json
*params
; /* Request or notification only. */
77 struct json
*result
; /* Successful reply only. */
78 struct json
*error
; /* Error reply only. */
79 struct json
*id
; /* Request or reply only. */
82 struct jsonrpc_msg
*jsonrpc_create_request(const char *method
,
85 struct jsonrpc_msg
*jsonrpc_create_notify(const char *method
,
87 struct jsonrpc_msg
*jsonrpc_create_reply(struct json
*result
,
88 const struct json
*id
);
89 struct jsonrpc_msg
*jsonrpc_create_error(struct json
*error
,
90 const struct json
*id
);
92 const char *jsonrpc_msg_type_to_string(enum jsonrpc_msg_type
);
93 char *jsonrpc_msg_is_valid(const struct jsonrpc_msg
*);
94 void jsonrpc_msg_destroy(struct jsonrpc_msg
*);
96 char *jsonrpc_msg_from_json(struct json
*, struct jsonrpc_msg
**);
97 struct json
*jsonrpc_msg_to_json(struct jsonrpc_msg
*);
99 /* A JSON-RPC session with reconnection. */
101 struct jsonrpc_session
*jsonrpc_session_open(const char *name
, bool retry
);
102 struct jsonrpc_session
*jsonrpc_session_open_unreliably(struct jsonrpc
*,
104 void jsonrpc_session_close(struct jsonrpc_session
*);
106 void jsonrpc_session_run(struct jsonrpc_session
*);
107 void jsonrpc_session_wait(struct jsonrpc_session
*);
109 size_t jsonrpc_session_get_backlog(const struct jsonrpc_session
*);
110 const char *jsonrpc_session_get_name(const struct jsonrpc_session
*);
112 int jsonrpc_session_send(struct jsonrpc_session
*, struct jsonrpc_msg
*);
113 struct jsonrpc_msg
*jsonrpc_session_recv(struct jsonrpc_session
*);
114 void jsonrpc_session_recv_wait(struct jsonrpc_session
*);
116 bool jsonrpc_session_is_alive(const struct jsonrpc_session
*);
117 bool jsonrpc_session_is_connected(const struct jsonrpc_session
*);
118 unsigned int jsonrpc_session_get_seqno(const struct jsonrpc_session
*);
119 int jsonrpc_session_get_status(const struct jsonrpc_session
*);
120 int jsonrpc_session_get_last_error(const struct jsonrpc_session
*);
121 void jsonrpc_session_get_reconnect_stats(const struct jsonrpc_session
*,
122 struct reconnect_stats
*);
124 void jsonrpc_session_enable_reconnect(struct jsonrpc_session
*);
125 void jsonrpc_session_force_reconnect(struct jsonrpc_session
*);
127 void jsonrpc_session_set_max_backoff(struct jsonrpc_session
*,
129 void jsonrpc_session_set_probe_interval(struct jsonrpc_session
*,
131 void jsonrpc_session_set_dscp(struct jsonrpc_session
*,
133 const char *jsonrpc_session_get_id(const struct jsonrpc_session
*);
135 #endif /* jsonrpc.h */