gnmi

Documentation

Index

• func WithClient(client *client) func(conn *conn)
• func WithClientConn(clientConn *grpc.ClientConn) func(conn *conn)
• func WithTargetID(targetID topoapi.ID) func(conn *conn)
• type Client
• type Conn
• type ConnEvent
• type ConnEventType
  • func (e ConnEventType) String() string
• type ConnID
• type ConnManager
  • func NewConnManager() ConnManager
• type Subscription
  • func (s *Subscription) Build() (*gnmipb.SubscribeRequest, error)

Functions

func WithClient

func WithClient(client *client) func(conn *conn)

WithClient sets the gnmi client for a new connection

func WithClientConn

func WithClientConn(clientConn *grpc.ClientConn) func(conn *conn)

WithClientConn sets client connection for a new connection

func WithTargetID

func WithTargetID(targetID topoapi.ID) func(conn *conn)

WithTargetID sets target ID for a new connection

Types

type Client

type Client interface {
	io.Closer
	Capabilities(ctx context.Context, r *gpb.CapabilityRequest) (*gpb.CapabilityResponse, error)
	CapabilitiesWithString(ctx context.Context, request string) (*gpb.CapabilityResponse, error)
	Get(ctx context.Context, r *gpb.GetRequest) (*gpb.GetResponse, error)
	GetWithString(ctx context.Context, request string) (*gpb.GetResponse, error)
	Set(ctx context.Context, r *gpb.SetRequest) (*gpb.SetResponse, error)
	SetWithString(ctx context.Context, request string) (*gpb.SetResponse, error)
	Subscribe(ctx context.Context, q baseClient.Query) error
}

Client gNMI client interface

type Conn

type Conn interface {
	Client
	ID() ConnID
	TargetID() topoapi.ID
	State() connectivity.State
	Connect()
	WatchState(ctx context.Context, ch chan<- connectivity.State) error
}

Conn gNMI connection interface

type ConnEvent

type ConnEvent struct {
	Conn      Conn
	EventType ConnEventType
}

ConnEvent connection event

type ConnEventType

type ConnEventType int

ConnEventType a connection event type

const (
	// None none connection event
	None ConnEventType = iota

	// Connected connected connection event
	Connected

	// Disconnected disconnected connection event
	Disconnected
)

func (ConnEventType) String

func (e ConnEventType) String() string

type ConnID

type ConnID string

ConnID connection ID

type ConnManager

type ConnManager interface {
	Get(ctx context.Context, targetID topoapi.ID) (Conn, error)
	List(ctx context.Context) ([]Conn, error)
	Watch(ctx context.Context, ch chan<- ConnEvent) error
	Connect(ctx context.Context, target *topoapi.Object) (Conn, error)
	Close(ctx context.Context, targetID topoapi.ID) error
}

ConnManager gNMI connection manager

func NewConnManager

func NewConnManager() ConnManager

NewConnManager creates a new gNMI connection manager

type Subscription

type Subscription struct {
	UpdatesOnly       bool
	Prefix            string
	Mode              string
	StreamMode        string
	SampleInterval    uint64
	HeartbeatInterval uint64
	Paths             [][]string
	Origin            string
}

Subscription subscription request information

func (*Subscription) Build

func (s *Subscription) Build() (*gnmipb.SubscribeRequest, error)

Build builds a gNMI subscription request