# Functions
ConsumeRule constructs a new Consume rule.
ForwardRule constructs a new Forward rule.
IntermediaryForwardRule constructs a new IntermediaryForward rule.
MakeClosePacket constructs a new ClosePacket.
MakeDataPacket constructs a new DataPacket.
MakeErrorPacket constructs a new ErrorPacket.
MakeHandshakePacket constructs a new HandshakePacket.
MakeKeepAlivePacket constructs a new KeepAlivePacket.
MakePingPacket constructs a new MakePingPacket.
MakePongPacket constructs a new PongPacket.
NewRouteDescriptor returns a new RouteDescriptor.
NewTable returns an in-memory routing table implementation with a specified configuration.
# Constants
Possible PacketType values: - DataPacket - Payload is just the underlying data.
CloseRequested is used when a closing is requested by visor.
Possible PacketType values: - DataPacket - Payload is just the underlying data.
Possible PacketType values: - DataPacket - Payload is just the underlying data.
Failure codes.
Failure codes.
Failure codes.
Failure codes.
Failure codes.
Possible PacketType values: - DataPacket - Payload is just the underlying data.
Possible PacketType values: - DataPacket - Payload is just the underlying data.
PacketHeaderSize represents the base size of a packet.
Packet sizes and offsets.
Packet sizes and offsets.
Packet sizes and offsets.
Packet sizes and offsets.
Possible PacketType values: - DataPacket - Payload is just the underlying data.
Possible PacketType values: - DataPacket - Payload is just the underlying data.
RuleForward represents a hop from the route's source visor.
RuleHeaderSize represents the base size of a rule.
RuleIntermediary represents a hop which is not from the route's source, nor to the route's destination.
RuleReverse represents a hop to the route's destination visor.
# Variables
Errors associated with BidirectionalRoute.
Errors associated with BidirectionalRoute.
Errors associated with BidirectionalRoute.
ErrNoAvailableRoutes is returned when there're no more available routeIDs.
ErrPayloadTooBig is returned when passed payload is too big (more than math.MaxUint16).
ErrRuleNotFound is returned while trying to access non-existing rule.
ErrRuleTimedOut is being returned while trying to access the rule which timed out.
# Structs
Addr represents a network address combining public key and port.
BidirectionalRoute is a Route with both forward and reverse Paths.
EdgeRules represents edge forward and reverse rules.
Failure describes a routing failure.
Hop defines a route hop between 2 nodes.
Route is a succession of transport entries that denotes a path from source visor to destination visor.
RouteDescriptorFields summarizes route descriptor fields of a RoutingRule.
RuleConsumeFields summarizes consume fields of a RoutingRule.
RuleForwardFields summarizes Forward fields of a RoutingRule.
RuleIntermediaryForwardFields summarizes IntermediaryForward fields of a RoutingRule.
RuleSummary provides a summary of a RoutingRule.
# Interfaces
Table represents a routing table implementation.
# Type aliases
CloseCode represents close code for ClosePacket.
FailureCode is a code that indicates a reason why a failure happened.
Packet defines generic packet recognized by all skywire visors.
PacketType represents packet purpose.
PathEdges are the edge nodes of a path.
Port is a network port number.
RouteDescriptor describes a route (from the perspective of the source and destination edges).
RouteID represents ID of a Route in a Packet.
Rule represents a routing rule.
RuleType defines type of a routing rule.