]>
git.proxmox.com Git - mirror_ovs.git/blob - lib/jsonrpc.c
2 * Copyright (c) 2009, 2010, 2011, 2012 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.
24 #include "dynamic-string.h"
25 #include "fatal-signal.h"
29 #include "poll-loop.h"
30 #include "reconnect.h"
35 VLOG_DEFINE_THIS_MODULE(jsonrpc
);
38 struct stream
*stream
;
44 struct json_parser
*parser
;
45 struct jsonrpc_msg
*received
;
48 struct list output
; /* Contains "struct ofpbuf"s. */
52 /* Rate limit for error messages. */
53 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(5, 5);
55 static void jsonrpc_received(struct jsonrpc
*);
56 static void jsonrpc_cleanup(struct jsonrpc
*);
57 static void jsonrpc_error(struct jsonrpc
*, int error
);
59 /* This is just the same as stream_open() except that it uses the default
60 * JSONRPC ports if none is specified. */
62 jsonrpc_stream_open(const char *name
, struct stream
**streamp
, uint8_t dscp
)
64 return stream_open_with_default_ports(name
, JSONRPC_TCP_PORT
,
65 JSONRPC_SSL_PORT
, streamp
,
69 /* This is just the same as pstream_open() except that it uses the default
70 * JSONRPC ports if none is specified. */
72 jsonrpc_pstream_open(const char *name
, struct pstream
**pstreamp
, uint8_t dscp
)
74 return pstream_open_with_default_ports(name
, JSONRPC_TCP_PORT
,
75 JSONRPC_SSL_PORT
, pstreamp
, dscp
);
78 /* Returns a new JSON-RPC stream that uses 'stream' for input and output. The
79 * new jsonrpc object takes ownership of 'stream'. */
81 jsonrpc_open(struct stream
*stream
)
85 ovs_assert(stream
!= NULL
);
87 rpc
= xzalloc(sizeof *rpc
);
88 rpc
->name
= xstrdup(stream_get_name(stream
));
90 byteq_init(&rpc
->input
);
91 list_init(&rpc
->output
);
96 /* Destroys 'rpc', closing the stream on which it is based, and frees its
99 jsonrpc_close(struct jsonrpc
*rpc
)
102 jsonrpc_cleanup(rpc
);
108 /* Performs periodic maintenance on 'rpc', such as flushing output buffers. */
110 jsonrpc_run(struct jsonrpc
*rpc
)
116 stream_run(rpc
->stream
);
117 while (!list_is_empty(&rpc
->output
)) {
118 struct ofpbuf
*buf
= ofpbuf_from_list(rpc
->output
.next
);
121 retval
= stream_send(rpc
->stream
, buf
->data
, buf
->size
);
123 rpc
->backlog
-= retval
;
124 ofpbuf_pull(buf
, retval
);
126 list_remove(&buf
->list_node
);
130 if (retval
!= -EAGAIN
) {
131 VLOG_WARN_RL(&rl
, "%s: send error: %s",
132 rpc
->name
, strerror(-retval
));
133 jsonrpc_error(rpc
, -retval
);
140 /* Arranges for the poll loop to wake up when 'rpc' needs to perform
141 * maintenance activities. */
143 jsonrpc_wait(struct jsonrpc
*rpc
)
146 stream_run_wait(rpc
->stream
);
147 if (!list_is_empty(&rpc
->output
)) {
148 stream_send_wait(rpc
->stream
);
154 * Returns the current status of 'rpc'. The possible return values are:
157 * - EOF: end of file (remote end closed connection; not necessarily an error).
159 * When this functions nonzero, 'rpc' is effectively out of commission. 'rpc'
160 * will not receive any more messages and any further messages that one
161 * attempts to send with 'rpc' will be discarded. The caller can keep 'rpc'
162 * around as long as it wants, but it's not going to provide any more useful
166 jsonrpc_get_status(const struct jsonrpc
*rpc
)
171 /* Returns the number of bytes buffered by 'rpc' to be written to the
172 * underlying stream. Always returns 0 if 'rpc' has encountered an error or if
173 * the remote end closed the connection. */
175 jsonrpc_get_backlog(const struct jsonrpc
*rpc
)
177 return rpc
->status
? 0 : rpc
->backlog
;
180 /* Returns the number of bytes that have been received on 'rpc''s underlying
181 * stream. (The value wraps around if it exceeds UINT_MAX.) */
183 jsonrpc_get_received_bytes(const struct jsonrpc
*rpc
)
185 return rpc
->input
.head
;
188 /* Returns 'rpc''s name, that is, the name returned by stream_get_name() for
189 * the stream underlying 'rpc' when 'rpc' was created. */
191 jsonrpc_get_name(const struct jsonrpc
*rpc
)
197 jsonrpc_log_msg(const struct jsonrpc
*rpc
, const char *title
,
198 const struct jsonrpc_msg
*msg
)
200 if (VLOG_IS_DBG_ENABLED()) {
201 struct ds s
= DS_EMPTY_INITIALIZER
;
203 ds_put_format(&s
, ", method=\"%s\"", msg
->method
);
206 ds_put_cstr(&s
, ", params=");
207 json_to_ds(msg
->params
, 0, &s
);
210 ds_put_cstr(&s
, ", result=");
211 json_to_ds(msg
->result
, 0, &s
);
214 ds_put_cstr(&s
, ", error=");
215 json_to_ds(msg
->error
, 0, &s
);
218 ds_put_cstr(&s
, ", id=");
219 json_to_ds(msg
->id
, 0, &s
);
221 VLOG_DBG("%s: %s %s%s", rpc
->name
, title
,
222 jsonrpc_msg_type_to_string(msg
->type
), ds_cstr(&s
));
227 /* Schedules 'msg' to be sent on 'rpc' and returns 'rpc''s status (as with
228 * jsonrpc_get_status()).
230 * If 'msg' cannot be sent immediately, it is appended to a buffer. The caller
231 * is responsible for ensuring that the amount of buffered data is somehow
232 * limited. (jsonrpc_get_backlog() returns the amount of data currently
233 * buffered in 'rpc'.)
235 * Always takes ownership of 'msg', regardless of success. */
237 jsonrpc_send(struct jsonrpc
*rpc
, struct jsonrpc_msg
*msg
)
245 jsonrpc_msg_destroy(msg
);
249 jsonrpc_log_msg(rpc
, "send", msg
);
251 json
= jsonrpc_msg_to_json(msg
);
252 s
= json_to_string(json
, 0);
256 buf
= xmalloc(sizeof *buf
);
257 ofpbuf_use(buf
, s
, length
);
259 list_push_back(&rpc
->output
, &buf
->list_node
);
260 rpc
->backlog
+= length
;
262 if (rpc
->backlog
== length
) {
268 /* Attempts to receive a message from 'rpc'.
270 * If successful, stores the received message in '*msgp' and returns 0. The
271 * caller takes ownership of '*msgp' and must eventually destroy it with
272 * jsonrpc_msg_destroy().
274 * Otherwise, stores NULL in '*msgp' and returns one of the following:
276 * - EAGAIN: No message has been received.
278 * - EOF: The remote end closed the connection gracefully.
280 * - Otherwise an errno value that represents a JSON-RPC protocol violation
281 * or another error fatal to the connection. 'rpc' will not send or
282 * receive any more messages.
285 jsonrpc_recv(struct jsonrpc
*rpc
, struct jsonrpc_msg
**msgp
)
294 for (i
= 0; i
< 50; i
++) {
296 *msgp
= rpc
->received
;
297 rpc
->received
= NULL
;
299 } else if (byteq_is_empty(&rpc
->input
)) {
303 chunk
= byteq_headroom(&rpc
->input
);
304 retval
= stream_recv(rpc
->stream
, byteq_head(&rpc
->input
), chunk
);
306 if (retval
== -EAGAIN
) {
309 VLOG_WARN_RL(&rl
, "%s: receive error: %s",
310 rpc
->name
, strerror(-retval
));
311 jsonrpc_error(rpc
, -retval
);
314 } else if (retval
== 0) {
315 jsonrpc_error(rpc
, EOF
);
318 byteq_advance_head(&rpc
->input
, retval
);
323 rpc
->parser
= json_parser_create(0);
325 n
= byteq_tailroom(&rpc
->input
);
326 used
= json_parser_feed(rpc
->parser
,
327 (char *) byteq_tail(&rpc
->input
), n
);
328 byteq_advance_tail(&rpc
->input
, used
);
329 if (json_parser_is_done(rpc
->parser
)) {
330 jsonrpc_received(rpc
);
332 const struct byteq
*q
= &rpc
->input
;
333 if (q
->head
<= BYTEQ_SIZE
) {
334 stream_report_content(q
->buffer
, q
->head
,
336 THIS_MODULE
, rpc
->name
);
347 /* Causes the poll loop to wake up when jsonrpc_recv() may return a value other
350 jsonrpc_recv_wait(struct jsonrpc
*rpc
)
352 if (rpc
->status
|| rpc
->received
|| !byteq_is_empty(&rpc
->input
)) {
353 (poll_immediate_wake
)(rpc
->name
);
355 stream_recv_wait(rpc
->stream
);
359 /* Sends 'msg' on 'rpc' and waits for it to be successfully queued to the
360 * underlying stream. Returns 0 if 'msg' was sent successfully, otherwise a
361 * status value (see jsonrpc_get_status()).
363 * Always takes ownership of 'msg', regardless of success. */
365 jsonrpc_send_block(struct jsonrpc
*rpc
, struct jsonrpc_msg
*msg
)
371 error
= jsonrpc_send(rpc
, msg
);
378 if (list_is_empty(&rpc
->output
) || rpc
->status
) {
386 /* Waits for a message to be received on 'rpc'. Same semantics as
387 * jsonrpc_recv() except that EAGAIN will never be returned. */
389 jsonrpc_recv_block(struct jsonrpc
*rpc
, struct jsonrpc_msg
**msgp
)
392 int error
= jsonrpc_recv(rpc
, msgp
);
393 if (error
!= EAGAIN
) {
400 jsonrpc_recv_wait(rpc
);
405 /* Sends 'request' to 'rpc' then waits for a reply. The return value is 0 if
406 * successful, in which case '*replyp' is set to the reply, which the caller
407 * must eventually free with jsonrpc_msg_destroy(). Otherwise returns a status
408 * value (see jsonrpc_get_status()).
410 * Discards any message received on 'rpc' that is not a reply to 'request'
411 * (based on message id).
413 * Always takes ownership of 'request', regardless of success. */
415 jsonrpc_transact_block(struct jsonrpc
*rpc
, struct jsonrpc_msg
*request
,
416 struct jsonrpc_msg
**replyp
)
418 struct jsonrpc_msg
*reply
= NULL
;
422 id
= json_clone(request
->id
);
423 error
= jsonrpc_send_block(rpc
, request
);
426 error
= jsonrpc_recv_block(rpc
, &reply
);
430 if ((reply
->type
== JSONRPC_REPLY
|| reply
->type
== JSONRPC_ERROR
)
431 && json_equal(id
, reply
->id
)) {
434 jsonrpc_msg_destroy(reply
);
437 *replyp
= error
? NULL
: reply
;
443 jsonrpc_received(struct jsonrpc
*rpc
)
445 struct jsonrpc_msg
*msg
;
449 json
= json_parser_finish(rpc
->parser
);
451 if (json
->type
== JSON_STRING
) {
452 VLOG_WARN_RL(&rl
, "%s: error parsing stream: %s",
453 rpc
->name
, json_string(json
));
454 jsonrpc_error(rpc
, EPROTO
);
459 error
= jsonrpc_msg_from_json(json
, &msg
);
461 VLOG_WARN_RL(&rl
, "%s: received bad JSON-RPC message: %s",
464 jsonrpc_error(rpc
, EPROTO
);
468 jsonrpc_log_msg(rpc
, "received", msg
);
473 jsonrpc_error(struct jsonrpc
*rpc
, int error
)
478 jsonrpc_cleanup(rpc
);
483 jsonrpc_cleanup(struct jsonrpc
*rpc
)
485 stream_close(rpc
->stream
);
488 json_parser_abort(rpc
->parser
);
491 jsonrpc_msg_destroy(rpc
->received
);
492 rpc
->received
= NULL
;
494 ofpbuf_list_delete(&rpc
->output
);
498 static struct jsonrpc_msg
*
499 jsonrpc_create(enum jsonrpc_msg_type type
, const char *method
,
500 struct json
*params
, struct json
*result
, struct json
*error
,
503 struct jsonrpc_msg
*msg
= xmalloc(sizeof *msg
);
505 msg
->method
= method
? xstrdup(method
) : NULL
;
506 msg
->params
= params
;
507 msg
->result
= result
;
514 jsonrpc_create_id(void)
516 static unsigned int id
;
517 return json_integer_create(id
++);
521 jsonrpc_create_request(const char *method
, struct json
*params
,
524 struct json
*id
= jsonrpc_create_id();
526 *idp
= json_clone(id
);
528 return jsonrpc_create(JSONRPC_REQUEST
, method
, params
, NULL
, NULL
, id
);
532 jsonrpc_create_notify(const char *method
, struct json
*params
)
534 return jsonrpc_create(JSONRPC_NOTIFY
, method
, params
, NULL
, NULL
, NULL
);
538 jsonrpc_create_reply(struct json
*result
, const struct json
*id
)
540 return jsonrpc_create(JSONRPC_REPLY
, NULL
, NULL
, result
, NULL
,
545 jsonrpc_create_error(struct json
*error
, const struct json
*id
)
547 return jsonrpc_create(JSONRPC_REPLY
, NULL
, NULL
, NULL
, error
,
552 jsonrpc_msg_type_to_string(enum jsonrpc_msg_type type
)
555 case JSONRPC_REQUEST
:
559 return "notification";
571 jsonrpc_msg_is_valid(const struct jsonrpc_msg
*m
)
573 const char *type_name
;
574 unsigned int pattern
;
576 if (m
->params
&& m
->params
->type
!= JSON_ARRAY
) {
577 return xstrdup("\"params\" must be JSON array");
581 case JSONRPC_REQUEST
:
598 return xasprintf("invalid JSON-RPC message type %d", m
->type
);
601 type_name
= jsonrpc_msg_type_to_string(m
->type
);
602 if ((m
->method
!= NULL
) != ((pattern
& 0x10000) != 0)) {
603 return xasprintf("%s must%s have \"method\"",
604 type_name
, (pattern
& 0x10000) ? "" : " not");
607 if ((m
->params
!= NULL
) != ((pattern
& 0x1000) != 0)) {
608 return xasprintf("%s must%s have \"params\"",
609 type_name
, (pattern
& 0x1000) ? "" : " not");
612 if ((m
->result
!= NULL
) != ((pattern
& 0x100) != 0)) {
613 return xasprintf("%s must%s have \"result\"",
614 type_name
, (pattern
& 0x100) ? "" : " not");
617 if ((m
->error
!= NULL
) != ((pattern
& 0x10) != 0)) {
618 return xasprintf("%s must%s have \"error\"",
619 type_name
, (pattern
& 0x10) ? "" : " not");
622 if ((m
->id
!= NULL
) != ((pattern
& 0x1) != 0)) {
623 return xasprintf("%s must%s have \"id\"",
624 type_name
, (pattern
& 0x1) ? "" : " not");
631 jsonrpc_msg_destroy(struct jsonrpc_msg
*m
)
635 json_destroy(m
->params
);
636 json_destroy(m
->result
);
637 json_destroy(m
->error
);
644 null_from_json_null(struct json
*json
)
646 if (json
&& json
->type
== JSON_NULL
) {
654 jsonrpc_msg_from_json(struct json
*json
, struct jsonrpc_msg
**msgp
)
656 struct json
*method
= NULL
;
657 struct jsonrpc_msg
*msg
= NULL
;
658 struct shash
*object
;
661 if (json
->type
!= JSON_OBJECT
) {
662 error
= xstrdup("message is not a JSON object");
665 object
= json_object(json
);
667 method
= shash_find_and_delete(object
, "method");
668 if (method
&& method
->type
!= JSON_STRING
) {
669 error
= xstrdup("method is not a JSON string");
673 msg
= xzalloc(sizeof *msg
);
674 msg
->method
= method
? xstrdup(method
->u
.string
) : NULL
;
675 msg
->params
= null_from_json_null(shash_find_and_delete(object
, "params"));
676 msg
->result
= null_from_json_null(shash_find_and_delete(object
, "result"));
677 msg
->error
= null_from_json_null(shash_find_and_delete(object
, "error"));
678 msg
->id
= null_from_json_null(shash_find_and_delete(object
, "id"));
679 msg
->type
= (msg
->result
? JSONRPC_REPLY
680 : msg
->error
? JSONRPC_ERROR
681 : msg
->id
? JSONRPC_REQUEST
683 if (!shash_is_empty(object
)) {
684 error
= xasprintf("message has unexpected member \"%s\"",
685 shash_first(object
)->name
);
688 error
= jsonrpc_msg_is_valid(msg
);
694 json_destroy(method
);
697 jsonrpc_msg_destroy(msg
);
705 jsonrpc_msg_to_json(struct jsonrpc_msg
*m
)
707 struct json
*json
= json_object_create();
710 json_object_put(json
, "method", json_string_create_nocopy(m
->method
));
714 json_object_put(json
, "params", m
->params
);
718 json_object_put(json
, "result", m
->result
);
719 } else if (m
->type
== JSONRPC_ERROR
) {
720 json_object_put(json
, "result", json_null_create());
724 json_object_put(json
, "error", m
->error
);
725 } else if (m
->type
== JSONRPC_REPLY
) {
726 json_object_put(json
, "error", json_null_create());
730 json_object_put(json
, "id", m
->id
);
731 } else if (m
->type
== JSONRPC_NOTIFY
) {
732 json_object_put(json
, "id", json_null_create());
740 /* A JSON-RPC session with reconnection. */
742 struct jsonrpc_session
{
743 struct reconnect
*reconnect
;
745 struct stream
*stream
;
746 struct pstream
*pstream
;
751 /* Creates and returns a jsonrpc_session to 'name', which should be a string
752 * acceptable to stream_open() or pstream_open().
754 * If 'name' is an active connection method, e.g. "tcp:127.1.2.3", the new
755 * jsonrpc_session connects and reconnects, with back-off, to 'name'.
757 * If 'name' is a passive connection method, e.g. "ptcp:", the new
758 * jsonrpc_session listens for connections to 'name'. It maintains at most one
759 * connection at any given time. Any new connection causes the previous one
760 * (if any) to be dropped. */
761 struct jsonrpc_session
*
762 jsonrpc_session_open(const char *name
)
764 struct jsonrpc_session
*s
;
766 s
= xmalloc(sizeof *s
);
767 s
->reconnect
= reconnect_create(time_msec());
768 reconnect_set_name(s
->reconnect
, name
);
769 reconnect_enable(s
->reconnect
, time_msec());
776 if (!pstream_verify_name(name
)) {
777 reconnect_set_passive(s
->reconnect
, true, time_msec());
780 if (!stream_or_pstream_needs_probes(name
)) {
781 reconnect_set_probe_interval(s
->reconnect
, 0);
787 /* Creates and returns a jsonrpc_session that is initially connected to
788 * 'jsonrpc'. If the connection is dropped, it will not be reconnected.
790 * On the assumption that such connections are likely to be short-lived
791 * (e.g. from ovs-vsctl), informational logging for them is suppressed. */
792 struct jsonrpc_session
*
793 jsonrpc_session_open_unreliably(struct jsonrpc
*jsonrpc
, uint8_t dscp
)
795 struct jsonrpc_session
*s
;
797 s
= xmalloc(sizeof *s
);
798 s
->reconnect
= reconnect_create(time_msec());
799 reconnect_set_quiet(s
->reconnect
, true);
800 reconnect_set_name(s
->reconnect
, jsonrpc_get_name(jsonrpc
));
801 reconnect_set_max_tries(s
->reconnect
, 0);
802 reconnect_connected(s
->reconnect
, time_msec());
813 jsonrpc_session_close(struct jsonrpc_session
*s
)
816 jsonrpc_close(s
->rpc
);
817 reconnect_destroy(s
->reconnect
);
818 stream_close(s
->stream
);
819 pstream_close(s
->pstream
);
825 jsonrpc_session_disconnect(struct jsonrpc_session
*s
)
828 jsonrpc_error(s
->rpc
, EOF
);
829 jsonrpc_close(s
->rpc
);
832 } else if (s
->stream
) {
833 stream_close(s
->stream
);
840 jsonrpc_session_connect(struct jsonrpc_session
*s
)
842 const char *name
= reconnect_get_name(s
->reconnect
);
845 jsonrpc_session_disconnect(s
);
846 if (!reconnect_is_passive(s
->reconnect
)) {
847 error
= jsonrpc_stream_open(name
, &s
->stream
, s
->dscp
);
849 reconnect_connecting(s
->reconnect
, time_msec());
852 error
= s
->pstream
? 0 : jsonrpc_pstream_open(name
, &s
->pstream
,
855 reconnect_listening(s
->reconnect
, time_msec());
860 reconnect_connect_failed(s
->reconnect
, time_msec(), error
);
866 jsonrpc_session_run(struct jsonrpc_session
*s
)
869 struct stream
*stream
;
872 error
= pstream_accept(s
->pstream
, &stream
);
874 if (s
->rpc
|| s
->stream
) {
876 "%s: new connection replacing active connection",
877 reconnect_get_name(s
->reconnect
));
878 jsonrpc_session_disconnect(s
);
880 reconnect_connected(s
->reconnect
, time_msec());
881 s
->rpc
= jsonrpc_open(stream
);
882 } else if (error
!= EAGAIN
) {
883 reconnect_listen_error(s
->reconnect
, time_msec(), error
);
884 pstream_close(s
->pstream
);
893 backlog
= jsonrpc_get_backlog(s
->rpc
);
895 if (jsonrpc_get_backlog(s
->rpc
) < backlog
) {
896 /* Data previously caught in a queue was successfully sent (or
897 * there's an error, which we'll catch below.)
899 * We don't count data that is successfully sent immediately as
900 * activity, because there's a lot of queuing downstream from us,
901 * which means that we can push a lot of data into a connection
902 * that has stalled and won't ever recover.
904 reconnect_activity(s
->reconnect
, time_msec());
907 error
= jsonrpc_get_status(s
->rpc
);
909 reconnect_disconnected(s
->reconnect
, time_msec(), error
);
910 jsonrpc_session_disconnect(s
);
912 } else if (s
->stream
) {
915 stream_run(s
->stream
);
916 error
= stream_connect(s
->stream
);
918 reconnect_connected(s
->reconnect
, time_msec());
919 s
->rpc
= jsonrpc_open(s
->stream
);
921 } else if (error
!= EAGAIN
) {
922 reconnect_connect_failed(s
->reconnect
, time_msec(), error
);
923 stream_close(s
->stream
);
928 switch (reconnect_run(s
->reconnect
, time_msec())) {
929 case RECONNECT_CONNECT
:
930 jsonrpc_session_connect(s
);
933 case RECONNECT_DISCONNECT
:
934 reconnect_disconnected(s
->reconnect
, time_msec(), 0);
935 jsonrpc_session_disconnect(s
);
938 case RECONNECT_PROBE
:
941 struct jsonrpc_msg
*request
;
943 params
= json_array_create_empty();
944 request
= jsonrpc_create_request("echo", params
, NULL
);
945 json_destroy(request
->id
);
946 request
->id
= json_string_create("echo");
947 jsonrpc_send(s
->rpc
, request
);
954 jsonrpc_session_wait(struct jsonrpc_session
*s
)
957 jsonrpc_wait(s
->rpc
);
958 } else if (s
->stream
) {
959 stream_run_wait(s
->stream
);
960 stream_connect_wait(s
->stream
);
963 pstream_wait(s
->pstream
);
965 reconnect_wait(s
->reconnect
, time_msec());
969 jsonrpc_session_get_backlog(const struct jsonrpc_session
*s
)
971 return s
->rpc
? jsonrpc_get_backlog(s
->rpc
) : 0;
974 /* Always returns a pointer to a valid C string, assuming 's' was initialized
977 jsonrpc_session_get_name(const struct jsonrpc_session
*s
)
979 return reconnect_get_name(s
->reconnect
);
982 /* Always takes ownership of 'msg', regardless of success. */
984 jsonrpc_session_send(struct jsonrpc_session
*s
, struct jsonrpc_msg
*msg
)
987 return jsonrpc_send(s
->rpc
, msg
);
989 jsonrpc_msg_destroy(msg
);
995 jsonrpc_session_recv(struct jsonrpc_session
*s
)
998 unsigned int received_bytes
;
999 struct jsonrpc_msg
*msg
;
1001 received_bytes
= jsonrpc_get_received_bytes(s
->rpc
);
1002 jsonrpc_recv(s
->rpc
, &msg
);
1003 if (received_bytes
!= jsonrpc_get_received_bytes(s
->rpc
)) {
1004 /* Data was successfully received.
1006 * Previously we only counted receiving a full message as activity,
1007 * but with large messages or a slow connection that policy could
1008 * time out the session mid-message. */
1009 reconnect_activity(s
->reconnect
, time_msec());
1013 if (msg
->type
== JSONRPC_REQUEST
&& !strcmp(msg
->method
, "echo")) {
1014 /* Echo request. Send reply. */
1015 struct jsonrpc_msg
*reply
;
1017 reply
= jsonrpc_create_reply(json_clone(msg
->params
), msg
->id
);
1018 jsonrpc_session_send(s
, reply
);
1019 } else if (msg
->type
== JSONRPC_REPLY
1020 && msg
->id
&& msg
->id
->type
== JSON_STRING
1021 && !strcmp(msg
->id
->u
.string
, "echo")) {
1022 /* It's a reply to our echo request. Suppress it. */
1026 jsonrpc_msg_destroy(msg
);
1033 jsonrpc_session_recv_wait(struct jsonrpc_session
*s
)
1036 jsonrpc_recv_wait(s
->rpc
);
1041 jsonrpc_session_is_alive(const struct jsonrpc_session
*s
)
1043 return s
->rpc
|| s
->stream
|| reconnect_get_max_tries(s
->reconnect
);
1047 jsonrpc_session_is_connected(const struct jsonrpc_session
*s
)
1049 return s
->rpc
!= NULL
;
1053 jsonrpc_session_get_seqno(const struct jsonrpc_session
*s
)
1059 jsonrpc_session_get_status(const struct jsonrpc_session
*s
)
1061 return s
&& s
->rpc
? jsonrpc_get_status(s
->rpc
) : 0;
1065 jsonrpc_session_get_reconnect_stats(const struct jsonrpc_session
*s
,
1066 struct reconnect_stats
*stats
)
1068 reconnect_get_stats(s
->reconnect
, time_msec(), stats
);
1072 jsonrpc_session_force_reconnect(struct jsonrpc_session
*s
)
1074 reconnect_force_reconnect(s
->reconnect
, time_msec());
1078 jsonrpc_session_set_max_backoff(struct jsonrpc_session
*s
, int max_backoff
)
1080 reconnect_set_backoff(s
->reconnect
, 0, max_backoff
);
1084 jsonrpc_session_set_probe_interval(struct jsonrpc_session
*s
,
1087 reconnect_set_probe_interval(s
->reconnect
, probe_interval
);
1091 jsonrpc_session_set_dscp(struct jsonrpc_session
*s
,
1094 if (s
->dscp
!= dscp
) {
1098 error
= pstream_set_dscp(s
->pstream
, dscp
);
1100 VLOG_ERR("%s: failed set_dscp %s",
1101 reconnect_get_name(s
->reconnect
), strerror(error
));
1104 * XXX race window between setting dscp to listening socket
1105 * and accepting socket. accepted socket may have old dscp value.
1106 * Ignore this race window for now.
1110 jsonrpc_session_force_reconnect(s
);