fwdcontext

type CPUPortSink ¶ added in v0.4.0

type CPUPortSink func(*pktiopb.PacketOut) error

type Context ¶

type Context struct {
	sync.RWMutex                  // Synchronization between provisioning and forwarding
	Objects      *fwdobject.Table // Set of all visible forwarding objects
	ID           string           // ID of the context
	Instance     string           // Name of the forwarding engine instance
	Attributes   fwdattribute.Set

	// FakePortManager is the implementation of the port creator for the Fake port type.
	FakePortManager FakePortManager
	// contains filtered or unexported fields
}

A Context encapsulates the state of an instance of the forwarding engine.

A context is the domain for synchronization. There are two users of context; provisioning and packet processing. Provisioning takes a rw lock on the context, and modifies objects within the context. Packet processing takes a read-lock on the context to process packets. Since provisioning and packet processing directly manipulate objects within the context, they must explicitly take the appropriate lock.

The context provides mechanisms to send notifications (notify) and packets (punt). Notify is non-blocking and sends notifications via an unbounded queue. Punt is a blocking call, and the caller is responsible for ordering and blocking guarantees.

func New(id, instance string) *Context

func (ctx *Context) CPUPortSink() CPUPortSink

func (ctx *Context) Cleanup(ch chan bool, isPort func(*fwdpb.ObjectId) bool)

func (ctx *Context) GetNotificationQueue() *queue.Queue

func (ctx *Context) Notify(event *fwdpb.EventDesc) error

func (ctx *Context) SetCPUPortSink(fn CPUPortSink, doneFn func()) error

func (ctx *Context) SetNotification(call NotificationCallback) error

func (ctx *Context) SetNotificationQueue(val *queue.Queue)

func (ctx *Context) String() string

type FakePortManager ¶ added in v0.4.0

type FakePortManager interface {
	CreatePort(string) (Port, error)
}

FakePortManager is an interface for creating custom ports for fwdpb FakePort.

type NotificationCallback ¶

type NotificationCallback func(*fwdpb.EventDesc)

An NotificationCallback generates events to a notification service.

type Port ¶ added in v0.4.0

type Port interface {
	gopacket.PacketDataSource
	WritePacketData(data []byte) error
}

Port is an interface for reading and writing to a port.