virtual

Documentation

Overview

Package virtual contains an implementation of an IPX network that forwards packets between nodes, similar to a network switch.

Index

• Variables
• type Network
  • func New() *Network
  • func (n *Network) NewNode() network.Node
  • func (n *Network) Tap() *Tap
• type Tap
  • func (t *Tap) Close() error
  • func (t *Tap) Read(data []byte) (int, error)
  • func (t *Tap) Write(packet []byte) (int, error)

Variables

var (

	// UnknownNodeError is returned by Network.Write() if the destination
	// MAC address is not associated with any known node.
	UnknownNodeError = errors.New("unknown destination address")
)

Types

type Network

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

func New

func New() *Network

New creates a new Network.

func (*Network) NewNode

func (n *Network) NewNode() network.Node

NewNode creates a new node on the network.

func (*Network) Tap

func (n *Network) Tap() *Tap

Tap creates a new network tap for listening to network traffic. The caller must call Read() on the tap regularly otherwise it may stall the operation of the network.

type Tap

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

func (*Tap) Close

func (t *Tap) Close() error

Close removes the tap from the network; no more packets will be delivered to it and all future calls to Read() will return EOF.

func (*Tap) Read

func (t *Tap) Read(data []byte) (int, error)

Read reads a packet from the network tap.

func (*Tap) Write

func (t *Tap) Write(packet []byte) (int, error)

Write writes a packet into the network.