subnet

Documentation

Index

• Variables
• func MakeSubnetKey(sn ip.IP4Net) string
• func ParseSubnetKey(s string) *ip.IP4Net
• func WatchLease(ctx context.Context, sm Manager, sn ip.IP4Net, receiver chan Event)
• func WatchLeases(ctx context.Context, sm Manager, ownLease *Lease, receiver chan []Event)
• type Config
  • func ParseConfig(s string) (*Config, error)
• type Event
• type EventType
  • func (et EventType) MarshalJSON() ([]byte, error)
  • func (et *EventType) UnmarshalJSON(data []byte) error
• type Lease
  • func (l *Lease) Key() string
• type LeaseAttrs
• type LeaseWatchResult
• type Manager
• type Reservation

Variables

var (
	ErrLeaseTaken  = errors.New("subnet: lease already taken")
	ErrNoMoreTries = errors.New("subnet: no more tries")
)

Functions

func MakeSubnetKey

func MakeSubnetKey(sn ip.IP4Net) string

func ParseSubnetKey

func ParseSubnetKey(s string) *ip.IP4Net

func WatchLease

func WatchLease(ctx context.Context, sm Manager, sn ip.IP4Net, receiver chan Event)

WatchLease performs a long term watch of the given network's subnet lease and communicates addition/deletion events on receiver channel. It takes care of handling "fall-behind" logic where the history window has advanced too far and it needs to diff the latest snapshot with its saved state and generate events

func WatchLeases

func WatchLeases(ctx context.Context, sm Manager, ownLease *Lease, receiver chan []Event)

WatchLeases performs a long term watch of the given network's subnet leases and communicates addition/deletion events on receiver channel. It takes care of handling "fall-behind" logic where the history window has advanced too far and it needs to diff the latest snapshot with its saved state and generate events

Types

type Config

type Config struct {
	Network     ip.IP4Net
	SubnetMin   ip.IP4
	SubnetMax   ip.IP4
	SubnetLen   uint
	BackendType string          `json:"-"`
	Backend     json.RawMessage `json:",omitempty"`
}

func ParseConfig

func ParseConfig(s string) (*Config, error)

type Event

type Event struct {
	Type  EventType `json:"type"`
	Lease Lease     `json:"lease,omitempty"`
}

type EventType

type EventType int

const (
	EventAdded EventType = iota
	EventRemoved
)

func (EventType) MarshalJSON

func (et EventType) MarshalJSON() ([]byte, error)

func (*EventType) UnmarshalJSON

func (et *EventType) UnmarshalJSON(data []byte) error

type Lease

type Lease struct {
	Subnet     ip.IP4Net
	Attrs      LeaseAttrs
	Expiration time.Time

	Asof uint64
}

func (*Lease) Key

func (l *Lease) Key() string

type LeaseAttrs

type LeaseAttrs struct {
	PublicIP    ip.IP4
	BackendType string          `json:",omitempty"`
	BackendData json.RawMessage `json:",omitempty"`
}

type LeaseWatchResult

type LeaseWatchResult struct {
	// Either Events or Snapshot will be set.  If Events is empty, it means
	// the cursor was out of range and Snapshot contains the current list
	// of items, even if empty.
	Events   []Event     `json:"events"`
	Snapshot []Lease     `json:"snapshot"`
	Cursor   interface{} `json:"cursor"`
}

type Manager

type Manager interface {
	GetNetworkConfig(ctx context.Context) (*Config, error)
	AcquireLease(ctx context.Context, attrs *LeaseAttrs) (*Lease, error)
	RenewLease(ctx context.Context, lease *Lease) error
	RevokeLease(ctx context.Context, sn ip.IP4Net) error
	WatchLease(ctx context.Context, sn ip.IP4Net, cursor interface{}) (LeaseWatchResult, error)
	WatchLeases(ctx context.Context, cursor interface{}) (LeaseWatchResult, error)

	AddReservation(ctx context.Context, r *Reservation) error
	RemoveReservation(ctx context.Context, subnet ip.IP4Net) error
	ListReservations(ctx context.Context) ([]Reservation, error)
}

type Reservation

type Reservation struct {
	Subnet   ip.IP4Net
	PublicIP ip.IP4
}