vni

Documentation

Overview

Package vni provides networkservice.NetworkService{Client,Server} chain elements for setting SrcIP/DstIP/VNI for the vxlan mechanism

Code generated by "-output vni_map.gen.go -type Map<vniKey,*vniKey> -output vni_map.gen.go -type Map<vniKey,*vniKey>"; DO NOT EDIT.

Index

• func NewClient(tunnelIP net.IP, options ...Option) networkservice.NetworkServiceClient
• func NewServer(tunnelIP net.IP, options ...Option) networkservice.NetworkServiceServer
• type Map
  • func (m *Map) Delete(key vniKey)
  • func (m *Map) Load(key vniKey) (*vniKey, bool)
  • func (m *Map) LoadAndDelete(key vniKey) (value *vniKey, loaded bool)
  • func (m *Map) LoadOrStore(key vniKey, value *vniKey) (*vniKey, bool)
  • func (m *Map) Range(f func(key vniKey, value *vniKey) bool)
  • func (m *Map) Store(key vniKey, value *vniKey)
• type Option
  • func WithTunnelPort(tunnelPort uint16) Option

Functions

func NewClient

func NewClient(tunnelIP net.IP, options ...Option) networkservice.NetworkServiceClient

NewClient - set the SrcIP for the vxlan mechanism

func NewServer

func NewServer(tunnelIP net.IP, options ...Option) networkservice.NetworkServiceServer

NewServer - set the DstIP *and* VNI for the vxlan mechanism

Types

type Map

type Map sync.Map

Map - sync.Map with key == vniKey and value == struct{}

func (*Map) Delete

func (m *Map) Delete(key vniKey)

Delete deletes the value for a key.

func (*Map) Load

func (m *Map) Load(key vniKey) (*vniKey, bool)

Load returns the value stored in the map for a key, or nil if no value is present. The ok result indicates whether value was found in the map.

func (*Map) LoadAndDelete

func (m *Map) LoadAndDelete(key vniKey) (value *vniKey, loaded bool)

LoadAndDelete deletes the value for a key, returning the previous value if any. The loaded result reports whether the key was present.

func (*Map) LoadOrStore

func (m *Map) LoadOrStore(key vniKey, value *vniKey) (*vniKey, bool)

LoadOrStore returns the existing value for the key if present. Otherwise, it stores and returns the given value. The loaded result is true if the value was loaded, false if stored.

func (*Map) Range

func (m *Map) Range(f func(key vniKey, value *vniKey) bool)

Range calls f sequentially for each key and value present in the map. If f returns false, range stops the iteration.

Range does not necessarily correspond to any consistent snapshot of the Map's contents: no key will be visited more than once, but if the value for any key is stored or deleted concurrently, Range may reflect any mapping for that key from any point during the Range call.

Range may be O(N) with the number of elements in the map even if f returns false after a constant number of calls.

func (*Map) Store

func (m *Map) Store(key vniKey, value *vniKey)

Store sets the value for a key.

type Option

type Option func(o *vniOpions)

Option is an option pattern for vni server/client

func WithTunnelPort

func WithTunnelPort(tunnelPort uint16) Option

WithTunnelPort sets VxLAN port