From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:41845) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Zmk98-0003x2-KK for qemu-devel@nongnu.org; Thu, 15 Oct 2015 11:08:47 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Zmk94-0002Hs-5q for qemu-devel@nongnu.org; Thu, 15 Oct 2015 11:08:46 -0400 Received: from mx1.redhat.com ([209.132.183.28]:40039) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Zmk93-0002HZ-TN for qemu-devel@nongnu.org; Thu, 15 Oct 2015 11:08:42 -0400 Received: from int-mx10.intmail.prod.int.phx2.redhat.com (int-mx10.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by mx1.redhat.com (Postfix) with ESMTPS id 820A8C0BFD3E for ; Thu, 15 Oct 2015 15:08:41 +0000 (UTC) From: Markus Armbruster Date: Thu, 15 Oct 2015 17:08:36 +0200 Message-Id: <1444921716-9511-8-git-send-email-armbru@redhat.com> In-Reply-To: <1444921716-9511-1-git-send-email-armbru@redhat.com> References: <1444921716-9511-1-git-send-email-armbru@redhat.com> Subject: [Qemu-devel] [PATCH 7/7] docs: Document QMP event rate limiting List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: amit.shah@redhat.com, marcandre.lureau@redhat.com Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ++++++++++++ docs/qmp-spec.txt | 5 +++++ 2 files changed, 17 insertions(+) diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index d92cc48..d2f1ce4 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -28,6 +28,8 @@ Example: "data": { "actual": 944766976 }, "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } +Note: this event is rate-limited. + BLOCK_IMAGE_CORRUPTED --------------------- @@ -296,6 +298,8 @@ Example: "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 }, "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } +Note: this event is rate-limited. + QUORUM_REPORT_BAD ----------------- @@ -318,6 +322,8 @@ Example: "data": { "node-name": "1.raw", "sector-num": 345435, "sectors-count": 5 }, "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } +Note: this event is rate-limited. + RESET ----- @@ -358,6 +364,8 @@ Example: "data": { "offset": 78 }, "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } +Note: this event is rate-limited. + SHUTDOWN -------- @@ -632,6 +640,8 @@ Example: "data": { "id": "channel0", "open": true }, "timestamp": { "seconds": 1401385907, "microseconds": 422329 } } +Note: this event is rate-limited separately for each "id". + WAKEUP ------ @@ -662,3 +672,5 @@ Example: Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is followed respectively by the RESET, SHUTDOWN, or STOP events. + +Note: this event is rate-limited. diff --git a/docs/qmp-spec.txt b/docs/qmp-spec.txt index 4c28cd9..4fb10a5 100644 --- a/docs/qmp-spec.txt +++ b/docs/qmp-spec.txt @@ -175,6 +175,11 @@ The format of asynchronous events is: For a listing of supported asynchronous events, please, refer to the qmp-events.txt file. +Some events are rate-limited to at most one per second. If additional +"similar" events arrive within one second, all but the last one are +dropped, and the last one is delayed. "Similar" normally means same +event type. See qmp-events.txt for details. + 2.5 QGA Synchronization ----------------------- -- 2.4.3