fixed some style issues, added tooling for docs
This commit is contained in:
19
docs/hosts/mgmt_msg.md
Normal file
19
docs/hosts/mgmt_msg.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# hosts/mgmt_msg.h
|
||||
|
||||
## class MgmtMsg — public interface
|
||||
|
||||
### `virtual ~MgmtMsg() = default;`
|
||||
|
||||
## class HeartbeatMsg — public interface
|
||||
|
||||
### `: subscriber_id(sid), status(st), generated_at(t) { ... }`
|
||||
### `MgmtKind kind() const noexcept override { ... }`
|
||||
|
||||
## class JobFinishedMsg — public interface
|
||||
|
||||
### `: flow_id(fid), finished_at(t) { ... }`
|
||||
### `MgmtKind kind() const noexcept override { ... }`
|
||||
|
||||
## class EndSimulationMsg — public interface
|
||||
|
||||
### `MgmtKind kind() const noexcept override { ... }`
|
||||
20
docs/hosts/policies.md
Normal file
20
docs/hosts/policies.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# hosts/policies.h
|
||||
|
||||
## class PubBasePolicy — public interface
|
||||
|
||||
### `virtual ~PubBasePolicy() = default;`
|
||||
|
||||
## class PubRRPolicy — public interface
|
||||
|
||||
### `: _ranges(std::move(ranges)) { ... }`
|
||||
### `validate_and_build();`
|
||||
### `PacketGroups select_multicast_groups(PacketGroups update_groups_mask) override { ... }`
|
||||
### `for (auto const& r : _ranges) { ... }`
|
||||
|
||||
## class SubBasePolicy — public interface
|
||||
|
||||
### `virtual ~SubBasePolicy() = default;`
|
||||
|
||||
## class SubDummyPolicy — public interface
|
||||
|
||||
### `~SubDummyPolicy() override = default;`
|
||||
10
docs/hosts/publisher.md
Normal file
10
docs/hosts/publisher.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# hosts/publisher.h
|
||||
|
||||
## class Publisher — public interface
|
||||
|
||||
### `void recv_update(Bytes size, PacketGroups update_groups_mask) noexcept;`
|
||||
### `void set_status(NodeStatus s, Time new_latency = Time{}) noexcept;`
|
||||
### `virtual void recv_mgmt_msg(MgmtMsgPtr msg) noexcept override;`
|
||||
### `virtual void recv_frame(const Packet& frame) override;`
|
||||
### `uint64_t updates_in() const noexcept { ... }`
|
||||
### `uint64_t bytes_out() const noexcept { ... }`
|
||||
8
docs/hosts/subscriber.md
Normal file
8
docs/hosts/subscriber.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# hosts/subscriber.h
|
||||
|
||||
## class Publisher — public interface
|
||||
|
||||
### `virtual void recv_mgmt_msg(MgmtMsgPtr msg) noexcept override;`
|
||||
### `void recv_frame(const Packet& frame) override;`
|
||||
### `void set_status(NodeStatus s) noexcept;`
|
||||
### `void set_publisher(Publisher* p) noexcept { ... }`
|
||||
Reference in New Issue
Block a user