IHealthManager Interface Reference
Health Manager interface for interacting with Deepsy health service More...
Inheritance diagram for IHealthManager:
Public Member Functions | |
| IEnumerable< IHealthStatus > | GetCurrentStatusList () |
| return a list with the last value of every of the status that have been reported to the Health Service More... | |
| IEnumerable< IHealthStatus > | GetPendingStatusList () |
| return a list with the pending status to be reported to the configured WS or endpoint More... | |
| void | ReportNewStatus (string key, string value, HealthStatusPriority.Priority priority) |
| Report a new status to the Health Service, which will be later reported to the configured WS More... | |
| IEnumerable< IDeviceInformation > | GetDeviceInfoList () |
| Return a list with the information of all the peripherals More... | |
Detailed Description
Member Function Documentation
| IEnumerable<IHealthStatus> GetCurrentStatusList | ( | ) |
- Returns
- Retrieve list of current status
- Exceptions
-
NotAvailableException (NOT_AVAILABLE) Thrown when service is not available NotAvailableException (DPY_TIMEOUT) Thrown when service don't respond in time HalException Thrown when service returns an error
Implemented in HealthManager.
| IEnumerable<IDeviceInformation> GetDeviceInfoList | ( | ) |
- Returns
- Retrieve a list with the information of all the peripherals
- Exceptions
-
NotAvailableException (NOT_AVAILABLE) Thrown when service is not available NotAvailableException (DPY_TIMEOUT) Thrown when service don't respond in time HalException Thrown when service returns an error
Implemented in HealthManager.
| IEnumerable<IHealthStatus> GetPendingStatusList | ( | ) |
- Returns
- Retrieve list of pending status to be reported to the configured WS or endpoint
- Exceptions
-
NotAvailableException (NOT_AVAILABLE) Thrown when service is not available NotAvailableException (DPY_TIMEOUT) Thrown when service don't respond in time HalException Thrown when service returns an error
Implemented in HealthManager.
| void ReportNewStatus | ( | string | key, |
| string | value, | ||
| HealthStatusPriority.Priority | priority | ||
| ) |
- Parameters
-
key Key value Value priority Priority
- Exceptions
-
NotAvailableException (NOT_AVAILABLE) Thrown when service is not available NotAvailableException (DPY_TIMEOUT) Thrown when service don't respond in time HalException Thrown when service returns an error
Implemented in HealthManager.
