conn

Documentation

Overview

Package conn provides connectivity and communication with the Seesaw Engine, either over IPC or RPC.

Index

• func RegisterEngineConn(connType string, connFunc func(ctx *ipc.Context) EngineConn)
• type EngineConn
• type Seesaw
  • func NewSeesawIPC(ctx *ipc.Context) (*Seesaw, error)
  • func NewSeesawRPC(ctx *ipc.Context) (*Seesaw, error)

Functions

func RegisterEngineConn

func RegisterEngineConn(connType string, connFunc func(ctx *ipc.Context) EngineConn)

RegisterEngineConn registers the given connection type.

Types

type EngineConn

type EngineConn interface {
	Close() error
	Dial(addr string) error

	ClusterStatus() (*seesaw.ClusterStatus, error)
	ConfigStatus() (*seesaw.ConfigStatus, error)
	HAStatus() (*seesaw.HAStatus, error)

	ConfigSource(source string) (string, error)
	ConfigReload() error

	BGPNeighbors() ([]*quagga.Neighbor, error)

	VLANs() (*seesaw.VLANs, error)

	Vservers() (map[string]*seesaw.Vserver, error)
	Backends() (map[string]*seesaw.Backend, error)

	OverrideBackend(override *seesaw.BackendOverride) error
	OverrideDestination(override *seesaw.DestinationOverride) error
	OverrideVserver(override *seesaw.VserverOverride) error

	Failover() error
}

EngineConn defines an interface that implements communication with the Seesaw Engine, either over IPC or RPC.

type Seesaw

type Seesaw struct {
	EngineConn
}

Seesaw represents a connection to a Seesaw Engine.

func NewSeesawIPC

func NewSeesawIPC(ctx *ipc.Context) (*Seesaw, error)

NewSeesawIPC returns a new Seesaw IPC connection.

func NewSeesawRPC

func NewSeesawRPC(ctx *ipc.Context) (*Seesaw, error)

NewSeesawRPC returns a new Seesaw RPC connection.