heartbeat 0.0.1

A high-performance heartbeat client.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

# heartbeat.rs

## Overview

A high-performance heartbeat client to check pulse of TCP servers. It utilizes TCP's [connection handshake] mechanism without even sending a client payload so it doesn't flood a network with client payloads.

[connection handshake]: https://http://en.wikipedia.org/wiki/Transmission_Control_Protocol#Connection_establishment

##Example:

```rust
extern crate heartbeat;

use std::net::SocketAddr;
use heartbeat::PulseResult;

// a handler to handle the result of a heartbeat pulse
fn do_nothing(res: PulseResult) {
  match res {
      Ok(addr) => println!("found pulse for {:?}", addr),
      Err(addr) => println!("no pulse for {:?}", addr)
  }
}

fn main() {
  let servers: Vec<SocketAddr> = ...;
  let freq_ms: u32 = 5 * 1000;
  let client = heartbeat::load(servers, do_nothing, freq_ms).unwrap();
  client.start();
}
```

It is designed to be simple and efficient to embed into your own application.

## Configuration

The TCP servers that you wish to check pulses of are added by specifying them in a TOML configuration file like this:

```toml
# Heartbeat.toml
[configuration]
servers = ["127.0.0.1:8080", "127.0.0.1:6767"]
frequency = 5000
```