From 90ab0d38e552019cef26170e44618224a3f3c9ff Mon Sep 17 00:00:00 2001 From: Samuel Mannehed Date: Thu, 12 Oct 2017 15:01:38 +0200 Subject: [PATCH] Add note clarifying the disconnected state Makes it clear that the RFB module can not transition away from the disconnected state. --- docs/API.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 3a1e1772..013dd540 100644 --- a/docs/API.md +++ b/docs/API.md @@ -226,7 +226,9 @@ __RFB onUpdateState callback details__ The RFB module has an 'onUpdateState' callback that is invoked after the noVNC connection state changes. Here is a list of the states that -are reported. +are reported. Note that the RFB module can not transition from the +disconnected state in any way, a new instance of the object has to be +created for new connections. | connection state | description | ---------------- | ------------