package
0.0.0-20210226143612-aed1ee41fd31
Repository: https://github.com/opennetworkinglab/gnmi.git
Documentation: pkg.go.dev

# Packages

Package client implements a fake client implementation to be used with streaming telemetry collection.
Package flags defines extra flag types for use in command line flag parsing.
Package client contains transport implementation for the parent client library using gnmi.proto.
Package grpcutil provides helper functions for working with gRPC targets.

# Functions

New returns an initialized caching client.
NewError will return a new error with the provided text.
NewImpl returns a client implementation based on the registered types.
NewQuery returns a populated Query from given gnmi SubscribeRequest.
NewType returns a new QueryType based on the provided string.
Reconnect wraps c and returns a new ReconnectClient using it.
Register will register the transport specific implementation.
RegisteredImpls returns a slice of currently registered client types.
RegisterTest allows tests to override client implementation for any client type.
ResetRegisteredImpls removes and Impls registered with Register.

# Constants

Once will perform a Once query against the agent.
Poll will perform a Polling query against the agent.
Stream will perform a Streaming query against the agent.
Unknown is an unknown query and should always be treated as an error.

# Variables

ErrClientInit is the common error for when making calls before the client has been started via Subscribe.
ErrStopReading is the common error defined to have the client stop a read loop.
ErrUnsupported is returned by Impl's methods when the underlying implementation doesn't support it.
RetryBaseDelay is the initial retry interval for re-Subscribe attempts.
RetryMaxDelay caps the retry interval for re-Subscribe attempts.
RetryRandomization is the randomization factor applied to the retry interval.

# Structs

BaseClient is a streaming telemetry client with minimal footprint.
Client adds a caching layer on top of a simple query client.
Connected is a synthetic notification sent when connection is established.
Credentials contains information necessary to authenticate with the target.
Destination contains data used to connect to a server.
Error is a inband error notification.
Leaf represents a leaf value in the tree.
Query contains all of the parameters necessary to initiate the query.
ReconnectClient is a wrapper around any Client that never returns from Subscribe (unless explicitly closed).
Sync is an inband notification that the client has sent everything in it's cache at least once.
TreeVal contains the current branch's value and the timestamp when the node was last updated.

# Interfaces

Client defines a set of methods which every client must implement.
Impl is the protocol/RPC specific implementation of the streaming Client.
Notification are internal messages used for abstracting protocol specific messages for clients.

# Type aliases

Delete is an explicit delete of the path in the tree.
InitImpl is a constructor signature for all transport specific implementations.
Leaves implements sort.Interface over []Leaf based on paths.
NotificationHandler is a type for the client specific handler function.
Path is a standard type for describing a path inside of streaming telemetry tree.
ProtoHandler is a type for the raw handling of the RPC layer.
Type defines the type of query in a Query.
Update is an update to the leaf in the tree.