GetKeepAliveSettings¶
-
virtual SKeepAliveSettings ITopController::GetKeepAliveSettings(EEndpoint endpoint) = 0¶
Gets the keep-alive settings for the specified endpoint of the connection to the controller.
- Parameters
endpoint – Endpoint of the connection for which to get the keep-alive settings.
- Returns
SKeepAliveSettings – Keep-alive settings for the specified endpoint.
- Throws
CInvalidArgumentException– Invalid endpoint specified, i.e. EEndpoint::Both.CInvalidArgumentException– Unknown endpoint specified.CUnsupportedException– Keep-alive settings are not configurable for sub-controllers.CUnsupportedException– One or more of the keep-alive settings are not configurable for the specified endpoint.CCommunicationErrorException– Protocol error.CConnectionLostException– Connection to controller lost.CRebootedException– Controller has been rebooted since this object reference was retrieved, invalidating this reference.CIncompatibleException– Incompatible firmware version loaded.CObjectDestroyedException– Object is destroyed.