pcap

Documentation

Index

• Constants
• Variables
• type Consumer
• type Device
• type Recorder
  • func NewRecorder() Recorder
• type RecordingOptions
• type StartRecordingResult
• type Subscription

Constants

const (
	DefaultReadTimeout = 30 * time.Second
)

Variables

var (
	ErrConsumerAlreadyRegistered    = errors.New("consumer with the given name is already registered")
	ErrNoMatchingConsumerRegistered = errors.New("no consumer with given key is registered")
	DefaultRecordingOptions         = RecordingOptions{
		ReadTimeout: DefaultReadTimeout,
		Promiscuous: false,
	}
)

var ErrTransportStillRunning = errors.New("transport to consumers did not stop in time")

Types

type Consumer

type Consumer interface {
	Name() string
	Observe(pkg gopacket.Packet)
	Init() error
}

type Device

type Device struct {
	Name        string
	IPAddresses []net.IP
}

type Recorder

type Recorder interface {
	io.Closer
	AvailableDevices() (devices []Device, err error)
	Subscriptions() (subscriptions []Subscription)
	StartRecording(ctx context.Context, device string, consumer Consumer) (result *StartRecordingResult, err error)
	StartRecordingWithOptions(
		ctx context.Context,
		device string,
		consumer Consumer,
		opts RecordingOptions,
	) (result *StartRecordingResult, err error)
	StopRecording(consumerKey string) (err error)
}

func NewRecorder

func NewRecorder() Recorder

type RecordingOptions

type RecordingOptions struct {
	Promiscuous bool
	ReadTimeout time.Duration
}

type StartRecordingResult

type StartRecordingResult struct {
	ConsumerKey string
}

type Subscription

type Subscription struct {
	ConsumerKey  string
	ConsumerName string
}