fixed some style issues, added tooling for docs
This commit is contained in:
5
docs/network/switch/dedicated_buffer.md
Normal file
5
docs/network/switch/dedicated_buffer.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# network/switch/dedicated_buffer.h
|
||||
|
||||
## class DedicatedBuffer — public interface
|
||||
|
||||
### `bool drain_one(PortId port) override;`
|
||||
5
docs/network/switch/ecn_dedicated_red.md
Normal file
5
docs/network/switch/ecn_dedicated_red.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# network/switch/ecn_dedicated_red.h
|
||||
|
||||
## class DedicatedREDEngine — public interface
|
||||
|
||||
### `_rng(rng) { ... }`
|
||||
5
docs/network/switch/ecn_engine.md
Normal file
5
docs/network/switch/ecn_engine.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# network/switch/ecn_engine.h
|
||||
|
||||
## class SwitchBuffer — public interface
|
||||
|
||||
### `virtual ~ECNEngine() = default;`
|
||||
5
docs/network/switch/ecn_shared_red.md
Normal file
5
docs/network/switch/ecn_shared_red.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# network/switch/ecn_shared_red.h
|
||||
|
||||
## class SharedREDEngine — public interface
|
||||
|
||||
### `_avg_port_bytes() { ... }`
|
||||
15
docs/network/switch/multicast_table.md
Normal file
15
docs/network/switch/multicast_table.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# network/switch/multicast_table.h
|
||||
|
||||
## class MulticastTable — public interface
|
||||
|
||||
### `MulticastTable();`
|
||||
### `bool add_tree(std::size_t group_id, uint16_t tree_id);`
|
||||
### `bool delete_tree(std::size_t group_id, uint16_t tree_id);`
|
||||
### `bool add_child_port(std::size_t group_id, uint16_t tree_id, PortId out_port);`
|
||||
### `bool delete_child_port(std::size_t group_id, uint16_t tree_id, PortId out_port);`
|
||||
### `bool set_parent(std::size_t group_id, uint16_t tree_id, PortId parent);`
|
||||
### `bool set_weight(std::size_t group_id, uint16_t tree_id, uint8_t w);`
|
||||
### `bool set_epoch(std::size_t group_id, uint16_t tree_id, uint8_t epoch);`
|
||||
### `const std::vector<McTree> *trees_of(std::size_t group_id) const;`
|
||||
### `std::size_t group_count() const noexcept;`
|
||||
### `std::vector<PortId> get_port_list(PacketGroups groups) const;`
|
||||
5
docs/network/switch/shared_buffer.md
Normal file
5
docs/network/switch/shared_buffer.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# network/switch/shared_buffer.h
|
||||
|
||||
## class SharedBuffer — public interface
|
||||
|
||||
### `virtual bool drain_one(PortId port) override;`
|
||||
19
docs/network/switch/switch_buffer.md
Normal file
19
docs/network/switch/switch_buffer.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# network/switch/switch_buffer.h
|
||||
|
||||
## class NetworkSwitch — public interface
|
||||
|
||||
### `virtual ~SwitchBuffer() = default;`
|
||||
### `Bytes buffer_size() const noexcept;`
|
||||
### `SwitchBufferType type() const noexcept;`
|
||||
### `uint16_t port_cnt() const noexcept;`
|
||||
### `Bytes port_buffered(PortId p) const noexcept;`
|
||||
### `const std::vector<Bytes> &ports_buffered() const noexcept;`
|
||||
### `uint8_t share_ctrl() const noexcept;`
|
||||
### `uint8_t share_mice() const noexcept;`
|
||||
### `uint8_t share_elephant() const noexcept;`
|
||||
### `void set_share_ctrl(uint8_t pct) noexcept;`
|
||||
### `void set_share_mice(uint8_t pct) noexcept;`
|
||||
### `void set_share_elephant(uint8_t pct) noexcept;`
|
||||
### `const Simulator *simulator() const noexcept;`
|
||||
### `const NetworkSwitch *owner() const noexcept;`
|
||||
### `void set_egress_links(const std::vector<Link*> &links);`
|
||||
8
docs/network/switch/unicast_table.md
Normal file
8
docs/network/switch/unicast_table.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# network/switch/unicast_table.h
|
||||
|
||||
## class UnicastTable — public interface
|
||||
|
||||
### `UnicastTable() = default;`
|
||||
### `std::vector<PortId> get_port_list(NodeId dst_node, PortId dst_port) const;`
|
||||
### `bool add_entry(NodeId dst_node, PortId dst_port, PortId out_port);`
|
||||
### `bool delete_entry(NodeId dst_node, PortId dst_port, PortId out_port);`
|
||||
Reference in New Issue
Block a user