vxcap

Documentation

Index

• Constants
• type PacketProcessor
  • func NewPacketProcessor(metloAPI *metloapi.Metlo) (*PacketProcessor, error)
  • func (x *PacketProcessor) Put(pkt *packetData) error
  • func (x *PacketProcessor) Setup() error
  • func (x *PacketProcessor) Shutdown() error
  • func (x *PacketProcessor) Tick(now time.Time) error
• type Processor
• type VXCap
  • func New() *VXCap
  • func (x *VXCap) Start(proc Processor) error

Constants

const (
	// DefaultReceiverQueueSize is default queue size of channel from UDP server to packet processor.
	DefaultReceiverQueueSize = 1024
	// DefaultVxlanPort is port number of UDP server to receive VXLAN datagram.
	DefaultVxlanPort = 4789
)

Types

type PacketProcessor

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

func NewPacketProcessor

func NewPacketProcessor(metloAPI *metloapi.Metlo) (*PacketProcessor, error)

func (*PacketProcessor) Put

func (x *PacketProcessor) Put(pkt *packetData) error

func (*PacketProcessor) Setup

func (x *PacketProcessor) Setup() error

func (*PacketProcessor) Shutdown

func (x *PacketProcessor) Shutdown() error

func (*PacketProcessor) Tick

func (x *PacketProcessor) Tick(now time.Time) error

type Processor

type Processor interface {
	Setup() error
	Put(pkt *packetData) error
	Tick(now time.Time) error
	Shutdown() error
}

type VXCap

type VXCap struct {
	RecvPort  int
	QueueSize int
}

VXCap is one of main components of the package

func New

func New() *VXCap

New is constructor of VXCap

func (*VXCap) Start

func (x *VXCap) Start(proc Processor) error

Start invokes UDP listener for VXLAN and forward captured packets to processor.