From 4e9f71924f7d0e6cd011217fa7dc18efc1485e1e Mon Sep 17 00:00:00 2001 From: Mint de Wit Date: Tue, 12 Nov 2024 10:54:32 +0100 Subject: [PATCH] chore: update doc --- packages/connector/src/api.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/connector/src/api.ts b/packages/connector/src/api.ts index d1602fa8..167ba8ef 100644 --- 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.) */