utils

Documentation

Index

• type AutoFlowPipe
  • func NewFlowPipe(cfg *PipeConfig) *AutoFlowPipe
  • func (p *AutoFlowPipe) Close()
  • func (p *AutoFlowPipe) DecodeFlow(msg interface{}) error
• type DecoderFunc
• type FlowPipe
• type Message
• type NetFlowPipe
  • func NewNetFlowPipe(cfg *PipeConfig) *NetFlowPipe
  • func (p *NetFlowPipe) Close()
  • func (p *NetFlowPipe) DecodeFlow(msg interface{}) error
• type PipeConfig
• type PipeMessageError
  • func (e *PipeMessageError) Error() string
  • func (e *PipeMessageError) Unwrap() error
• type ReceiverCallback
• type ReceiverError
  • func (e *ReceiverError) Error() string
  • func (e *ReceiverError) Unwrap() error
• type SFlowPipe
  • func NewSFlowPipe(cfg *PipeConfig) *SFlowPipe
  • func (p *SFlowPipe) Close()
  • func (p *SFlowPipe) DecodeFlow(msg interface{}) error
• type UDPReceiver
  • func NewUDPReceiver(cfg *UDPReceiverConfig) (*UDPReceiver, error)
  • func (r *UDPReceiver) Errors() <-chan error
  • func (r *UDPReceiver) Start(addr string, port int, decodeFunc DecoderFunc) error
  • func (r *UDPReceiver) Stop() error
• type UDPReceiverConfig

Types

type AutoFlowPipe

type AutoFlowPipe struct {
	*SFlowPipe
	*NetFlowPipe
}

func NewFlowPipe

func NewFlowPipe(cfg *PipeConfig) *AutoFlowPipe

func (*AutoFlowPipe) Close

func (p *AutoFlowPipe) Close()

func (*AutoFlowPipe) DecodeFlow

func (p *AutoFlowPipe) DecodeFlow(msg interface{}) error

type DecoderFunc

type DecoderFunc func(msg interface{}) error

Callback used to decode a UDP message

type FlowPipe

type FlowPipe interface {
	DecodeFlow(msg interface{}) error
	Close()
}

type Message

type Message struct {
	Src      netip.AddrPort
	Dst      netip.AddrPort
	Payload  []byte
	Received time.Time
}

type NetFlowPipe

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

func NewNetFlowPipe

func NewNetFlowPipe(cfg *PipeConfig) *NetFlowPipe

func (*NetFlowPipe) Close

func (p *NetFlowPipe) Close()

func (*NetFlowPipe) DecodeFlow

func (p *NetFlowPipe) DecodeFlow(msg interface{}) error

type PipeConfig

type PipeConfig struct {
	Format    format.FormatInterface
	Transport transport.TransportInterface
	Producer  producer.ProducerInterface

	NetFlowTemplater templates.TemplateSystemGenerator
}

type PipeMessageError

type PipeMessageError struct {
	Message *Message
	Err     error
}

func (*PipeMessageError) Error

func (e *PipeMessageError) Error() string

func (*PipeMessageError) Unwrap

func (e *PipeMessageError) Unwrap() error

type ReceiverCallback

type ReceiverCallback interface {
	Dropped(msg Message)
}

type ReceiverError

type ReceiverError struct {
	Err error
}

func (*ReceiverError) Error

func (e *ReceiverError) Error() string

func (*ReceiverError) Unwrap

func (e *ReceiverError) Unwrap() error

type SFlowPipe

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

func NewSFlowPipe

func NewSFlowPipe(cfg *PipeConfig) *SFlowPipe

func (*SFlowPipe) Close

func (p *SFlowPipe) Close()

func (*SFlowPipe) DecodeFlow

func (p *SFlowPipe) DecodeFlow(msg interface{}) error

type UDPReceiver

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

func NewUDPReceiver

func NewUDPReceiver(cfg *UDPReceiverConfig) (*UDPReceiver, error)

func (*UDPReceiver) Errors

func (r *UDPReceiver) Errors() <-chan error

func (*UDPReceiver) Start

func (r *UDPReceiver) Start(addr string, port int, decodeFunc DecoderFunc) error

Start UDP receivers and the processing routines

func (*UDPReceiver) Stop

func (r *UDPReceiver) Stop() error

Stops the routines

type UDPReceiverConfig

type UDPReceiverConfig struct {
	Workers   int
	Sockets   int
	Blocking  bool
	QueueSize int

	ReceiverCallback ReceiverCallback
}