ether

type Config ¶

type Config struct {
	Logger          logr.Logger
	Clock           clockwork.Clock
	PacketTransform PacketTransform
}

Config configures the behaviour of the Ether

type Ether ¶

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

Ether allows for modelling a radio transmission medium when using fake.Device to simulate radio devices

func New(cfg Config) *Ether

func (e *Ether) Close() error

func (e *Ether) RegisterDevice(device *fake.Device)

func (e *Ether) UnregisterDevice(device *fake.Device)

type PacketTransform ¶

type PacketTransform func(transmitter, receiver *fake.Device, packet []byte) TransformOutcome

A PacketTransform is both a predicate and map function for packets transmitted through the Ether: - If the resulting outcome has a nil packet then no packet will be delivered to the receiver - Otherwise the resulting packet will be scheduled to arrive after a specified delay

By providing custom PacketTransform functions, callers can add in logic to more accurately represent their transmission medium: adding in delays, corrupting the received packet, preventing receipt, etc.

func AddPacketDeliveryDelay(transform PacketTransform, delay time.Duration) PacketTransform

type TransformOutcome ¶

type TransformOutcome struct {
	ReceivedPacket []byte
	FlightTime     time.Duration
}

TransformOutcome describes a packet that will be delivered to a receiver, created by a PacketTransform

func PerfectPacketTransform(_, _ *fake.Device, packet []byte) TransformOutcome