traffic

package

v0.1.0 Latest Latest Go to latest Published: Apr 10, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/dedis/dela

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func GenerateEventGraphviz(out io.Writer, traffics ...*Traffic)
func GenerateItemsGraphviz(out io.Writer, withSend, withRcv bool, traffics ...*Traffic)
func SaveEvents(path string) error
func SaveItems(path string, withSend, withRcv bool) error
type Event
type Traffic
- func NewTraffic(src mino.Address, out io.Writer) *Traffic
type Watcher
- func (w *Watcher) WatchIns(ctx context.Context) <-chan Event
- func (w *Watcher) WatchOuts(ctx context.Context) <-chan Event

Constants ¶

View Source

const EnvVariable = "MINO_TRAFFIC"

EnvVariable is the name of the environment variable to enable the traffic.

Variables ¶

View Source

var (

	// LogItems allows one to granularly say when items should be logged or not.
	// This is useful for example in an integration test where a specific part
	// raises a problem but the full graph would be too noisy. For that, one
	// can set LogItems = false and change it to true when needed.
	LogItems = true
	// LogEvent works the same as LogItems but for events. Note that in both
	// cases the varenv should be set.
	LogEvent = true
)

View Source

var GlobalWatcher = Watcher{
	// contains filtered or unexported fields
}

GlobalWatcher can be used to watch for sent and received messages.

Functions ¶

func GenerateEventGraphviz ¶

func GenerateEventGraphviz(out io.Writer, traffics ...*Traffic)

GenerateEventGraphviz creates a graphviz representation of the events

func GenerateItemsGraphviz ¶

func GenerateItemsGraphviz(out io.Writer, withSend, withRcv bool, traffics ...*Traffic)

GenerateItemsGraphviz creates a graphviz representation of the items. One can generate a graphical representation with `dot -Tpdf graph.dot -o graph.pdf`

func SaveEvents ¶

func SaveEvents(path string) error

SaveEvents saves all the events as a graph

func SaveItems ¶

func SaveItems(path string, withSend, withRcv bool) error

SaveItems saves all the items as a graph

Types ¶

type Event ¶

type Event struct {
	Address mino.Address
	Pkt     router.Packet
}

Event defines the elements of a receive or sent event

type Traffic ¶

type Traffic struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Traffic is used to keep track of packets Traffic in a server

func NewTraffic ¶

func NewTraffic(src mino.Address, out io.Writer) *Traffic

NewTraffic creates a new empty traffic recorder.

func (*Traffic) Display ¶

func (t *Traffic) Display(out io.Writer)

Display prints the current traffic to the writer.

func (*Traffic) LogRecv ¶

func (t *Traffic) LogRecv(ctx context.Context, gateway mino.Address, pkt router.Packet)

LogRecv records a packet received by the node. The sender is the gateway and the receiver the node.

func (*Traffic) LogRelay ¶

func (t *Traffic) LogRelay(to mino.Address)

LogRelay records a new relay.

func (*Traffic) LogRelayClosed ¶

func (t *Traffic) LogRelayClosed(to mino.Address)

LogRelayClosed records the end of a relay.

func (*Traffic) LogSend ¶

func (t *Traffic) LogSend(ctx context.Context, gateway mino.Address, pkt router.Packet)

LogSend records a packet sent by the node. It records the node address as the sender and the gateway as the receiver, while also recording the packet itself.

func (*Traffic) Save ¶

func (t *Traffic) Save(path string, withSend, withRcv bool) error

Save saves the items graph to the given address.

type Watcher ¶

type Watcher struct {
	// contains filtered or unexported fields
}

Watcher defines an element to watch for sent and received messages.

func (*Watcher) WatchIns ¶

func (w *Watcher) WatchIns(ctx context.Context) <-chan Event

WatchIns returns a channel populated with received messages.

func (*Watcher) WatchOuts ¶

func (w *Watcher) WatchOuts(ctx context.Context) <-chan Event

WatchOuts returns a channel populated with sent messages.

Source Files ¶

View all Source files

mod.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL