fixed some style issues, added tooling for docs
This commit is contained in:
35
docs/network/packet.md
Normal file
35
docs/network/packet.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# network/packet.h
|
||||
|
||||
## class Packet — public interface
|
||||
|
||||
### `NodeId src_node() const noexcept;`
|
||||
### `PortId src_port() const noexcept;`
|
||||
### `NodeId dst_node() const noexcept;`
|
||||
### `PortId dst_port() const noexcept;`
|
||||
### `PacketProtocol protocol() const noexcept;`
|
||||
### `PacketSeq seq() const noexcept;`
|
||||
### `FlowId flow_id() const noexcept;`
|
||||
### `uint32_t entropy() const noexcept;`
|
||||
### `void set_src_node(NodeId n) noexcept;`
|
||||
### `void set_src_port(PortId p) noexcept;`
|
||||
### `void set_dst_node(NodeId n) noexcept;`
|
||||
### `void set_dst_port(PortId p) noexcept;`
|
||||
### `void set_seq(PacketSeq s) noexcept;`
|
||||
### `void set_flow_id(FlowId f) noexcept;`
|
||||
### `void set_entropy(uint32_t e) noexcept;`
|
||||
### `void set_protocol(PacketProtocol p) noexcept;`
|
||||
### `void set_payload_size(Bytes size) noexcept;`
|
||||
### `void set_ecn_enabled(bool v) noexcept;`
|
||||
### `void set_ecn_marked(bool v) noexcept;`
|
||||
### `void set_eof(bool v) noexcept;`
|
||||
### `bool is_ecn_enabled() const noexcept;`
|
||||
### `bool is_ecn() const noexcept;`
|
||||
### `bool is_eof() const noexcept;`
|
||||
### `FlowPriority priority() const noexcept;`
|
||||
### `uint8_t priority_raw() const noexcept;`
|
||||
### `Bytes header_size() const noexcept;`
|
||||
### `Bytes payload_size() const noexcept;`
|
||||
### `Bytes total_size() const noexcept;`
|
||||
### `PacketGroups groups() const noexcept;`
|
||||
### `void set_groups(PacketGroups g) noexcept;`
|
||||
### `void add_groups(PacketGroups gmask) noexcept;`
|
||||
Reference in New Issue
Block a user