From ea656ecc39fa9222e77b10703450136baf53e788 Mon Sep 17 00:00:00 2001 From: Fionera Date: Sat, 28 Sep 2024 04:03:58 +0200 Subject: [PATCH] peers: add design --- peers/DESIGN.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 peers/DESIGN.md diff --git a/peers/DESIGN.md b/peers/DESIGN.md new file mode 100644 index 0000000..6c6d230 --- /dev/null +++ b/peers/DESIGN.md @@ -0,0 +1,12 @@ +# HAProxy Peers Design +## Connection +By default, the peers package only opens listeners and waits for HAProxy to connect to it. + +## Sticktables +A user can create a sticktable definition which can be used to send to a HAProxy peer. Additionally a user can use a +sent definition to send updates for that specific sticktable. For this, the table has to be registered in a table +registry to allow proper referencing. + +## Handler +A handler is the interface to implement when wanting to react to sticktable updates. A user created handler can implement +specific sub interfaces to also react to handshakes. \ No newline at end of file