target

package
v0.1.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 21, 2026 License: Apache-2.0 Imports: 22 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type SubscribeResponse 

type SubscribeResponse struct {
	SubscriptionName   string
	SubscriptionConfig *types.SubscriptionConfig
	Response           *gnmi.SubscribeResponse
}

SubscribeResponse //

type Target 

type Target struct {
	Config        *types.TargetConfig                  `json:"config,omitempty"`
	Subscriptions map[string]*types.SubscriptionConfig `json:"subscriptions,omitempty"`

	Client           gnmi.GNMIClient                      `json:"-"`
	SubscribeClients map[string]gnmi.GNMI_SubscribeClient `json:"-"` // subscription name to subscribeClient

	StopChan chan struct{}      `json:"-"`
	Cfn      context.CancelFunc `json:"-"`
	RootDesc desc.Descriptor    `json:"-"`
	// contains filtered or unexported fields
}

Target represents a gNMI enabled box

func NewTarget 

func NewTarget(c *types.TargetConfig) *Target

NewTarget //

func (*Target) Capabilities 

func (t *Target) Capabilities(ctx context.Context, ext ...*gnmi_ext.Extension) (*gnmi.CapabilityResponse, error)

Capabilities sends a gnmi.CapabilitiesRequest to the target *t and returns a gnmi.CapabilitiesResponse and an error

func (*Target) Close 

func (t *Target) Close() error

func (*Target) ConnState 

func (t *Target) ConnState() string

func (*Target) ConnectivityState added in v0.1.10 

func (t *Target) ConnectivityState() connectivity.State

ConnectivityState returns the current gRPC connectivity state. Returns connectivity.Shutdown if the connection is nil.

func (*Target) CreateGNMIClient 

func (t *Target) CreateGNMIClient(ctx context.Context, opts ...grpc.DialOption) error

CreateGNMIClient //

func (*Target) DecodeProtoBytes 

func (t *Target) DecodeProtoBytes(resp *gnmi.SubscribeResponse) error

func (*Target) DeleteSubscription 

func (t *Target) DeleteSubscription(name string)

func (*Target) Get 

func (t *Target) Get(ctx context.Context, req *gnmi.GetRequest) (*gnmi.GetResponse, error)

Get sends a gnmi.GetRequest to the target *t and returns a gnmi.GetResponse and an error

func (*Target) NumberOfOnceSubscriptions 

func (t *Target) NumberOfOnceSubscriptions() int

func (*Target) ReadSubscriptions 

func (t *Target) ReadSubscriptions() (chan *SubscribeResponse, chan *TargetError)

func (*Target) Set 

func (t *Target) Set(ctx context.Context, req *gnmi.SetRequest) (*gnmi.SetResponse, error)

Set sends a gnmi.SetRequest to the target *t and returns a gnmi.SetResponse and an error

func (*Target) StopSubscription 

func (t *Target) StopSubscription(name string)

func (*Target) StopSubscriptions 

func (t *Target) StopSubscriptions()

func (*Target) Subscribe 

func (t *Target) Subscribe(ctx context.Context, req *gnmi.SubscribeRequest, subscriptionName string)

Subscribe sends a gnmi.SubscribeRequest to the target *t, responses and error are sent to the target channels

func (*Target) SubscribeChan added in v0.1.10 

func (t *Target) SubscribeChan(ctx context.Context, req *gnmi.SubscribeRequest, subscriptionName string) (chan *SubscribeResponse, chan *TargetError)

func (*Target) SubscribeOnce 

func (t *Target) SubscribeOnce(ctx context.Context, req *gnmi.SubscribeRequest) ([]*gnmi.SubscribeResponse, error)

func (*Target) SubscribeOnceChan 

func (t *Target) SubscribeOnceChan(ctx context.Context, req *gnmi.SubscribeRequest) (chan *gnmi.SubscribeResponse, chan error)

func (*Target) SubscribePoll 

func (t *Target) SubscribePoll(ctx context.Context, subName string) error

func (*Target) SubscribeStreamChan added in v0.1.6 

func (t *Target) SubscribeStreamChan(ctx context.Context, req *gnmi.SubscribeRequest, subscriptionName string) (chan *gnmi.SubscribeResponse, chan error)

func (*Target) WaitForConnStateChange added in v0.1.10 

func (t *Target) WaitForConnStateChange(ctx context.Context, sourceState connectivity.State) bool

WaitForConnStateChange blocks until the gRPC connection state changes from sourceState or ctx is done. Returns true if the state changed, false if ctx expired. Returns false immediately if conn is nil.

type TargetError 

type TargetError struct {
	SubscriptionName string
	Err              error
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.