[mirror_ovs.git] / lib / jsonrpc.h

/*
 * Copyright (c) 2009, 2010, 2012, 2013, 2017 Nicira, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef JSONRPC_H
#define JSONRPC_H 1

/* This is an implementation of the JSON-RPC 1.0 specification defined at
 * http://json-rpc.org/wiki/specification. */

#include <stdbool.h>
#include <stddef.h>
#include "openvswitch/types.h"

struct json;
struct jsonrpc_msg;
struct pstream;
struct reconnect_stats;
struct stream;
struct svec;
\f
/* API for a JSON-RPC stream. */

/* Default port numbers.
 *
 * OVSDB_OLD_PORT defines the original port number used by OVS.
 * OVSDB_PORT defines the official port number assigned by IANA. */
#define OVSDB_OLD_PORT 6632
#define OVSDB_PORT 6640

int jsonrpc_stream_open(const char *name, struct stream **, uint8_t dscp);
int jsonrpc_pstream_open(const char *name, struct pstream **, uint8_t dscp);

struct jsonrpc *jsonrpc_open(struct stream *);
void jsonrpc_close(struct jsonrpc *);

void jsonrpc_run(struct jsonrpc *);
void jsonrpc_wait(struct jsonrpc *);

int jsonrpc_get_status(const struct jsonrpc *);
size_t jsonrpc_get_backlog(const struct jsonrpc *);
void jsonrpc_set_backlog_threshold(struct jsonrpc *, size_t max_n_msgs,
                                                     size_t max_backlog_bytes);

unsigned int jsonrpc_get_received_bytes(const struct jsonrpc *);
const char *jsonrpc_get_name(const struct jsonrpc *);

int jsonrpc_send(struct jsonrpc *, struct jsonrpc_msg *);
int jsonrpc_recv(struct jsonrpc *, struct jsonrpc_msg **);
void jsonrpc_recv_wait(struct jsonrpc *);

int jsonrpc_send_block(struct jsonrpc *, struct jsonrpc_msg *);
int jsonrpc_recv_block(struct jsonrpc *, struct jsonrpc_msg **);
int jsonrpc_transact_block(struct jsonrpc *, struct jsonrpc_msg *,
                           struct jsonrpc_msg **);

/* Messages. */
enum jsonrpc_msg_type {
    JSONRPC_REQUEST,           /* Request. */
    JSONRPC_NOTIFY,            /* Notification. */
    JSONRPC_REPLY,             /* Successful reply. */
    JSONRPC_ERROR              /* Error reply. */
};

struct jsonrpc_msg {
    enum jsonrpc_msg_type type;
    char *method;               /* Request or notification only. */
    struct json *params;        /* Request or notification only. */
    struct json *result;        /* Successful reply only. */
    struct json *error;         /* Error reply only. */
    struct json *id;            /* Request or reply only. */
};

struct jsonrpc_msg *jsonrpc_create_request(const char *method,
                                           struct json *params,
                                           struct json **idp);
struct jsonrpc_msg *jsonrpc_create_notify(const char *method,
                                          struct json *params);
struct jsonrpc_msg *jsonrpc_create_reply(struct json *result,
                                         const struct json *id);
struct jsonrpc_msg *jsonrpc_create_error(struct json *error,
                                         const struct json *id);

struct jsonrpc_msg *jsonrpc_msg_clone(const struct jsonrpc_msg *);

const char *jsonrpc_msg_type_to_string(enum jsonrpc_msg_type);
char *jsonrpc_msg_is_valid(const struct jsonrpc_msg *);
void jsonrpc_msg_destroy(struct jsonrpc_msg *);

char *jsonrpc_msg_from_json(struct json *, struct jsonrpc_msg **);
struct json *jsonrpc_msg_to_json(struct jsonrpc_msg *);

char *jsonrpc_msg_to_string(const struct jsonrpc_msg *);
\f
/* A JSON-RPC session with reconnection. */

struct jsonrpc_session *jsonrpc_session_open(const char *name, bool retry);
struct jsonrpc_session *jsonrpc_session_open_multiple(const struct svec *,
                                                      bool retry);
struct jsonrpc_session *jsonrpc_session_open_unreliably(struct jsonrpc *,
                                                        uint8_t);
void jsonrpc_session_close(struct jsonrpc_session *);

struct jsonrpc *jsonrpc_session_steal(struct jsonrpc_session *);

void jsonrpc_session_run(struct jsonrpc_session *);
void jsonrpc_session_wait(struct jsonrpc_session *);

size_t jsonrpc_session_get_backlog(const struct jsonrpc_session *);
const char *jsonrpc_session_get_name(const struct jsonrpc_session *);
size_t jsonrpc_session_get_n_remotes(const struct jsonrpc_session *);

int jsonrpc_session_send(struct jsonrpc_session *, struct jsonrpc_msg *);
struct jsonrpc_msg *jsonrpc_session_recv(struct jsonrpc_session *);
void jsonrpc_session_recv_wait(struct jsonrpc_session *);

bool jsonrpc_session_is_alive(const struct jsonrpc_session *);
bool jsonrpc_session_is_connected(const struct jsonrpc_session *);
unsigned int jsonrpc_session_get_seqno(const struct jsonrpc_session *);
int jsonrpc_session_get_status(const struct jsonrpc_session *);
int jsonrpc_session_get_last_error(const struct jsonrpc_session *);
void jsonrpc_session_get_reconnect_stats(const struct jsonrpc_session *,
                                         struct reconnect_stats *);

void jsonrpc_session_enable_reconnect(struct jsonrpc_session *);
void jsonrpc_session_force_reconnect(struct jsonrpc_session *);

void jsonrpc_session_set_max_backoff(struct jsonrpc_session *,
                                     int max_backoff);
void jsonrpc_session_set_probe_interval(struct jsonrpc_session *,
                                        int probe_interval);
void jsonrpc_session_set_dscp(struct jsonrpc_session *,
                              uint8_t dscp);
void jsonrpc_session_set_backlog_threshold(struct jsonrpc_session *,
                                           size_t max_n_msgs,
                                           size_t max_backlog_bytes);
const char *jsonrpc_session_get_id(const struct jsonrpc_session *);

#endif /* jsonrpc.h */
Commit	Line	Data
f2129093	1	/*
8cf6bbb1	2	* Copyright (c) 2009, 2010, 2012, 2013, 2017 Nicira, Inc.
f2129093 BP	3	*
	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:
	7	*
	8	* http://www.apache.org/licenses/LICENSE-2.0
	9	*
	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.
	15	*/
	16
	17	#ifndef JSONRPC_H
	18	#define JSONRPC_H 1
	19
	20	/* This is an implementation of the JSON-RPC 1.0 specification defined at
	21	* http://json-rpc.org/wiki/specification. */
	22
	23	#include <stdbool.h>
	24	#include <stddef.h>
f125905c	25	#include "openvswitch/types.h"
f2129093 BP	26
	27	struct json;
	28	struct jsonrpc_msg;
0d11f523	29	struct pstream;
0b3e7a8b	30	struct reconnect_stats;
f2129093	31	struct stream;
8cf6bbb1	32	struct svec;
f2129093 BP	33	\f
	34	/* API for a JSON-RPC stream. */
	35
efc295d2	36	/* Default port numbers.
0d11f523	37	*
efc295d2	38	* OVSDB_OLD_PORT defines the original port number used by OVS.
d4763d1d	39	* OVSDB_PORT defines the official port number assigned by IANA. */
efc295d2 JP	40	#define OVSDB_OLD_PORT 6632
efc295d2 JP	41	#define OVSDB_PORT 6640
0d11f523	42
f125905c MM	43	int jsonrpc_stream_open(const char name, struct stream *, uint8_t dscp);
f125905c MM	44	int jsonrpc_pstream_open(const char name, struct pstream *, uint8_t dscp);
0d11f523	45
f2129093 BP	46	struct jsonrpc jsonrpc_open(struct stream );
	47	void jsonrpc_close(struct jsonrpc *);
	48
	49	void jsonrpc_run(struct jsonrpc *);
	50	void jsonrpc_wait(struct jsonrpc *);
	51
f2129093 BP	52	int jsonrpc_get_status(const struct jsonrpc *);
f2129093 BP	53	size_t jsonrpc_get_backlog(const struct jsonrpc *);
eca34ebd IM	54	void jsonrpc_set_backlog_threshold(struct jsonrpc *, size_t max_n_msgs,
	55	size_t max_backlog_bytes);
	56
3a8d38c8	57	unsigned int jsonrpc_get_received_bytes(const struct jsonrpc *);
f2129093 BP	58	const char jsonrpc_get_name(const struct jsonrpc );
	59
	60	int jsonrpc_send(struct jsonrpc , struct jsonrpc_msg );
	61	int jsonrpc_recv(struct jsonrpc , struct jsonrpc_msg *);
	62	void jsonrpc_recv_wait(struct jsonrpc *);
	63
	64	int jsonrpc_send_block(struct jsonrpc , struct jsonrpc_msg );
	65	int jsonrpc_recv_block(struct jsonrpc , struct jsonrpc_msg *);
d0632593 BP	66	int jsonrpc_transact_block(struct jsonrpc , struct jsonrpc_msg ,
d0632593 BP	67	struct jsonrpc_msg **);
f2129093 BP	68
	69	/* Messages. */
	70	enum jsonrpc_msg_type {
	71	JSONRPC_REQUEST, /* Request. */
	72	JSONRPC_NOTIFY, /* Notification. */
	73	JSONRPC_REPLY, /* Successful reply. */
	74	JSONRPC_ERROR /* Error reply. */
	75	};
	76
	77	struct jsonrpc_msg {
	78	enum jsonrpc_msg_type type;
	79	char method; / Request or notification only. */
	80	struct json params; / Request or notification only. */
	81	struct json result; / Successful reply only. */
	82	struct json error; / Error reply only. */
	83	struct json id; / Request or reply only. */
	84	};
	85
	86	struct jsonrpc_msg jsonrpc_create_request(const char method,
20bed8be BP	87	struct json *params,
20bed8be BP	88	struct json **idp);
f2129093 BP	89	struct jsonrpc_msg jsonrpc_create_notify(const char method,
	90	struct json *params);
	91	struct jsonrpc_msg jsonrpc_create_reply(struct json result,
	92	const struct json *id);
	93	struct jsonrpc_msg jsonrpc_create_error(struct json error,
	94	const struct json *id);
	95
1b1d2e6d BP	96	struct jsonrpc_msg jsonrpc_msg_clone(const struct jsonrpc_msg );
1b1d2e6d BP	97
f2129093 BP	98	const char *jsonrpc_msg_type_to_string(enum jsonrpc_msg_type);
	99	char jsonrpc_msg_is_valid(const struct jsonrpc_msg );
	100	void jsonrpc_msg_destroy(struct jsonrpc_msg *);
	101
	102	char jsonrpc_msg_from_json(struct json , struct jsonrpc_msg **);
	103	struct json jsonrpc_msg_to_json(struct jsonrpc_msg );
1b1d2e6d BP	104
1b1d2e6d BP	105	char jsonrpc_msg_to_string(const struct jsonrpc_msg );
dcbb691b BP	106	\f
	107	/* A JSON-RPC session with reconnection. */
	108
fba6bd1d	109	struct jsonrpc_session jsonrpc_session_open(const char name, bool retry);
8cf6bbb1 BP	110	struct jsonrpc_session jsonrpc_session_open_multiple(const struct svec ,
8cf6bbb1 BP	111	bool retry);
e879d33e MM	112	struct jsonrpc_session jsonrpc_session_open_unreliably(struct jsonrpc ,
e879d33e MM	113	uint8_t);
dcbb691b BP	114	void jsonrpc_session_close(struct jsonrpc_session *);
dcbb691b BP	115
1b1d2e6d BP	116	struct jsonrpc jsonrpc_session_steal(struct jsonrpc_session );
1b1d2e6d BP	117
dcbb691b BP	118	void jsonrpc_session_run(struct jsonrpc_session *);
	119	void jsonrpc_session_wait(struct jsonrpc_session *);
	120
	121	size_t jsonrpc_session_get_backlog(const struct jsonrpc_session *);
	122	const char jsonrpc_session_get_name(const struct jsonrpc_session );
8cf6bbb1	123	size_t jsonrpc_session_get_n_remotes(const struct jsonrpc_session *);
dcbb691b BP	124
	125	int jsonrpc_session_send(struct jsonrpc_session , struct jsonrpc_msg );
	126	struct jsonrpc_msg jsonrpc_session_recv(struct jsonrpc_session );
	127	void jsonrpc_session_recv_wait(struct jsonrpc_session *);
	128
4931f33a	129	bool jsonrpc_session_is_alive(const struct jsonrpc_session *);
dcbb691b BP	130	bool jsonrpc_session_is_connected(const struct jsonrpc_session *);
dcbb691b BP	131	unsigned int jsonrpc_session_get_seqno(const struct jsonrpc_session *);
0b3e7a8b	132	int jsonrpc_session_get_status(const struct jsonrpc_session *);
fba6bd1d	133	int jsonrpc_session_get_last_error(const struct jsonrpc_session *);
0b3e7a8b AE	134	void jsonrpc_session_get_reconnect_stats(const struct jsonrpc_session *,
	135	struct reconnect_stats *);
	136
705d7a39	137	void jsonrpc_session_enable_reconnect(struct jsonrpc_session *);
dcbb691b	138	void jsonrpc_session_force_reconnect(struct jsonrpc_session *);
f2129093	139
94db5407	140	void jsonrpc_session_set_max_backoff(struct jsonrpc_session *,
b5f0fe21	141	int max_backoff);
94db5407 BP	142	void jsonrpc_session_set_probe_interval(struct jsonrpc_session *,
94db5407 BP	143	int probe_interval);
f125905c MM	144	void jsonrpc_session_set_dscp(struct jsonrpc_session *,
f125905c MM	145	uint8_t dscp);
eca34ebd IM	146	void jsonrpc_session_set_backlog_threshold(struct jsonrpc_session *,
	147	size_t max_n_msgs,
	148	size_t max_backlog_bytes);
d6db7b3c	149	const char jsonrpc_session_get_id(const struct jsonrpc_session );
94db5407	150
f2129093	151	#endif /* jsonrpc.h */