Open Lighting Architecture: ola::network::HealthCheckedConnection Class Reference

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
ola::network::HealthCheckedConnection Class Referenceabstract

## Detailed Description

An class that provides health checking for a connection. The subclasses implement the SendHeartbeat and HeartbeatTimeout methods.

## Public Member Functions
| HealthCheckedConnection (ola::thread::SchedulerInterface *scheduler, const ola::TimeInterval timeout_interval)
bool | Setup ()
virtual void | SendHeartbeat ()=0
void | HeartbeatSent ()
void | HeartbeatReceived ()
void | PauseTimer ()
void | ResumeTimer ()

## Protected Member Functions
virtual void | HeartbeatTimeout ()=0

## Member Function Documentation

## ◆ HeartbeatReceived()

void ola::network::HealthCheckedConnection::HeartbeatReceived | ( |  | ) |

Reset the RX timer

## ◆ HeartbeatSent()

void ola::network::HealthCheckedConnection::HeartbeatSent | ( |  | ) |

Call this when a heartbeat is piggybacked on another message. This prevents sending heatbeats unless necessary.

Reset the send timer

## ◆ HeartbeatTimeout()

virtual void ola::network::HealthCheckedConnection::HeartbeatTimeout | ( |  | ) |
| protectedpure virtual

This is called when we don't receive a health check within the interval.

## ◆ PauseTimer()

void ola::network::HealthCheckedConnection::PauseTimer | ( |  | ) |

Pause the receive timer

## ◆ ResumeTimer()

void ola::network::HealthCheckedConnection::ResumeTimer | ( |  | ) |

Resume the health check timer. Call this when reading is resumed.

Resume the receive timer

## ◆ Setup()

bool ola::network::HealthCheckedConnection::Setup | ( |  | ) |

Setup the health checked channel

The documentation for this class was generated from the following files:

- include/ola/network/HealthCheckedConnection.h
- common/network/HealthCheckedConnection.cpp