Documentation
¶
Overview ¶
package mux implements a protocol muxer.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( ProtocolID_Routing = pb.ProtocolID_Routing ProtocolID_Exchange = pb.ProtocolID_Exchange ProtocolID_Diagnostic = pb.ProtocolID_Diagnostic )
ProtocolIDs used to identify each protocol. These should probably be defined elsewhere.
Functions ¶
This section is empty.
Types ¶
type Muxer ¶
type Muxer struct {
// Protocols are the multiplexed services.
Protocols ProtocolMap
*msg.Pipe
ctxc.ContextCloser
// contains filtered or unexported fields
}
Muxer is a simple multiplexor that reads + writes to Incoming and Outgoing channels. It multiplexes various protocols, wrapping and unwrapping data with a ProtocolID.
func NewMuxer ¶
func NewMuxer(ctx context.Context, mp ProtocolMap) *Muxer
NewMuxer constructs a muxer given a protocol map.
func (*Muxer) AddProtocol ¶
func (m *Muxer) AddProtocol(p Protocol, pid pb.ProtocolID) error
AddProtocol adds a Protocol with given ProtocolID to the Muxer.
func (*Muxer) GetBandwidthTotals ¶
GetBandwidthTotals return the in/out bandwidth measured over this muxer.
type Protocol ¶
Protocol objects produce + consume raw data. They are added to the Muxer with a ProtocolID, which is added to outgoing payloads. Muxer properly encapsulates and decapsulates when interfacing with its Protocols. The Protocols do not encounter their ProtocolID.
type ProtocolMap ¶
type ProtocolMap map[pb.ProtocolID]Protocol
ProtocolMap maps ProtocolIDs to Protocols.
Source Files
Directories