chore: update doc

nrkno · Nov 12, 2024 · 4e9f719 · 4e9f719
1 parent 68fe627
commit 4e9f719
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/packages/connector/src/api.ts b/packages/connector/src/api.ts
@@ -666,7 +666,9 @@ export interface IMOSDeviceConnectionOptions {
 
 		/** (Optional) Treat the secondary server as a "hot standby".
 		 * A "hot standby" is a server that is powered down / in standby while the primary server is up.
-		 * Set this to true to defer checking the connection status to the secondary server while the primary is up.
+		 * When a server is a hot standby it is expected to be disconnected and hence we will not send
+		 * heartbeat messages. The connection status will still be reported as disconnected however as we
+		 * do not pretend to be connected to something that is powered down.
 		 *
 		 * (This was added to support the hot standby feature of OpenMedia NRCS.)
 		 */