adapters

Documentation

Index

• Constants
• type DeviceAdapter
  • func NewDevice(dev string, isTest bool) (*DeviceAdapter, error)
  • func (a *DeviceAdapter) Close() (err error)
  • func (a *DeviceAdapter) Read(ctrl chan goul.Item, message goul.Message) (out chan goul.Item, err error)
  • func (a *DeviceAdapter) SetFilter(filter string) error
  • func (a *DeviceAdapter) SetOptions(promisc bool, snaplength int, timeout time.Duration) (err error)
  • func (a *DeviceAdapter) Write(in chan goul.Item, message goul.Message) (done chan goul.Item, err error)
• type DummyAdapter
  • func (a *DummyAdapter) Read(in chan goul.Item, message goul.Message) (chan goul.Item, error)
  • func (a *DummyAdapter) Write(in chan goul.Item, message goul.Message) (chan goul.Item, error)
• type NetworkAdapter
  • func NewNetwork(addr string, port int) (*NetworkAdapter, error)
  • func (a *NetworkAdapter) Close() error
  • func (a *NetworkAdapter) Read(ctrl chan goul.Item, message goul.Message) (chan goul.Item, error)
  • func (a *NetworkAdapter) Write(in chan goul.Item, message goul.Message) (chan goul.Item, error)

Constants

const (
	ErrDeviceAdapterNotInitialized = "device adapter not initialized"
	ErrCouldNotActivate            = "could not activate capture interface"
)

constants...

const (
	ErrNetworkWriterNotSupported = "writer not supported for server"
	ErrNetworkReaderNotSupported = "reader not supported for client"
	ErrNetworkReadHeader         = "could not read header from network"
	ErrNetworkReadChunk          = "could not read chunk from network"
)

constants...

Types

type DeviceAdapter

type DeviceAdapter struct {
	goul.Adapter
	ID string
	// contains filtered or unexported fields
}

DeviceAdapter is an adapter for the network device interfacing. This is the most important adapter of Goul. It is used as a reader adapter for the sender and a writer adapter for the receiver.

Please note that the adapter MUST be initialized with NewDevice() function so that it can be initialized with initialization of device and automatically inherit the BaseAdapter that implements underlying CommonMixin. Otherwise, it does not work properly.

func NewDevice

func NewDevice(dev string, isTest bool) (*DeviceAdapter, error)

NewDevice returns new device adapter.

func (*DeviceAdapter) Close

func (a *DeviceAdapter) Close() (err error)

Close clean up resources on device adapter.

func (*DeviceAdapter) Read

func (a *DeviceAdapter) Read(ctrl chan goul.Item, message goul.Message) (out chan goul.Item, err error)

Read implements interface Adapter

func (*DeviceAdapter) SetFilter

func (a *DeviceAdapter) SetFilter(filter string) error

SetFilter sets filter string which is applied while capturing.

func (*DeviceAdapter) SetOptions

func (a *DeviceAdapter) SetOptions(promisc bool, snaplength int, timeout time.Duration) (err error)

SetOptions sets capture options to inactive handler.

func (*DeviceAdapter) Write

func (a *DeviceAdapter) Write(in chan goul.Item, message goul.Message) (done chan goul.Item, err error)

Write implements interface Adapter

type DummyAdapter

type DummyAdapter struct {
	goul.Adapter
	ID string
}

DummyAdapter ...

func (*DummyAdapter) Read

func (a *DummyAdapter) Read(in chan goul.Item, message goul.Message) (chan goul.Item, error)

Read implements interface Adapter

func (*DummyAdapter) Write

func (a *DummyAdapter) Write(in chan goul.Item, message goul.Message) (chan goul.Item, error)

Write implements interface Adapter

type NetworkAdapter

type NetworkAdapter struct {
	goul.Adapter
	ID string
	// contains filtered or unexported fields
}

NetworkAdapter is normal mode networking adapter.

func NewNetwork

func NewNetwork(addr string, port int) (*NetworkAdapter, error)

NewNetwork ...

func (*NetworkAdapter) Close

func (a *NetworkAdapter) Close() error

Close implements Adapter:

func (*NetworkAdapter) Read

func (a *NetworkAdapter) Read(ctrl chan goul.Item, message goul.Message) (chan goul.Item, error)

Read implements interface Adapter

func (*NetworkAdapter) Write

func (a *NetworkAdapter) Write(in chan goul.Item, message goul.Message) (chan goul.Item, error)

Write implements interface Adapter