topo

Documentation

Index

• Constants
• type Client
  • func NewClient(opts ...Option) (Client, error)
• type ListOption
  • func WithListFilters(filters *topoapi.Filters) ListOption
• type ListOptions
  • func (l ListOptions) GetFilters() *topoapi.Filters
• type Option
  • func WithOptions(opts Options) Option
  • func WithTopoAddress(host string, port int) Option
  • func WithTopoHost(host string) Option
  • func WithTopoPort(port int) Option
• type Options
• type ServiceOptions
  • func (o ServiceOptions) GetAddress() string
  • func (o ServiceOptions) GetHost() string
  • func (o ServiceOptions) GetPort() int
  • func (o ServiceOptions) IsInsecure() bool
• type WatchOption
  • func WithWatchFilters(filters *topoapi.Filters) WatchOption
• type WatchOptions
  • func (w WatchOptions) GetFilters() *topoapi.Filters

Constants

const (
	DefaultServicePort = 5150
	DefaultServiceHost = "onos-topo"
)

Types

type Client

type Client interface {
	// Create creates a topo object
	Create(ctx context.Context, object *topoapi.Object) error

	// Update updates a topo object
	Update(ctx context.Context, object *topoapi.Object) error

	// Get gets a topo object with a given ID
	Get(ctx context.Context, id topoapi.ID) (*topoapi.Object, error)

	// Watch provides a simple facility for the application to watch for changes in the topology
	Watch(ctx context.Context, ch chan<- topoapi.Event, opts ...WatchOption) error

	// List of topo objects
	List(ctx context.Context, opts ...ListOption) ([]topoapi.Object, error)
}

Client is a topo SDK client

func NewClient

func NewClient(opts ...Option) (Client, error)

NewClient creates a new topo client

type ListOption

type ListOption interface {
	// contains filtered or unexported methods
}

ListOption topo client list option

func WithListFilters

func WithListFilters(filters *topoapi.Filters) ListOption

WithListFilters sets filters for list method

type ListOptions

type ListOptions struct {
	// contains filtered or unexported fields
}

ListOptions topo client get method options

func (ListOptions) GetFilters

func (l ListOptions) GetFilters() *topoapi.Filters

GetFilters get filters

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option topo client

func WithOptions

func WithOptions(opts Options) Option

WithOptions sets the client options

func WithTopoAddress

func WithTopoAddress(host string, port int) Option

WithTopoAddress sets the address for the topo service

func WithTopoHost

func WithTopoHost(host string) Option

WithTopoHost sets the host for the topo service

func WithTopoPort

func WithTopoPort(port int) Option

WithTopoPort sets the port for the topo service

type Options

type Options struct {
	// Service service options
	Service ServiceOptions
}

Options topo SDK options

type ServiceOptions

type ServiceOptions struct {
	// Host is the service host
	Host string
	// Port is the service port
	Port int

	Insecure bool
}

ServiceOptions are the options for a service

func (ServiceOptions) GetAddress

func (o ServiceOptions) GetAddress() string

GetAddress gets the service address

func (ServiceOptions) GetHost

func (o ServiceOptions) GetHost() string

GetHost gets the service host

func (ServiceOptions) GetPort

func (o ServiceOptions) GetPort() int

GetPort gets the service port

func (ServiceOptions) IsInsecure

func (o ServiceOptions) IsInsecure() bool

IsInsecure is topo connection secure

type WatchOption

type WatchOption interface {
	// contains filtered or unexported methods
}

WatchOption topo client watch option

func WithWatchFilters

func WithWatchFilters(filters *topoapi.Filters) WatchOption

WithWatchFilters sets filters for watch method

type WatchOptions

type WatchOptions struct {
	// contains filtered or unexported fields
}

WatchOptions topo client watch method options

func (WatchOptions) GetFilters

func (w WatchOptions) GetFilters() *topoapi.Filters

GetFilters get filters