Table of Contents

Class GnmiClient

Namespace
Skyline.DataMiner.DataSources.OpenConfig.Gnmi.Api
Assembly
Skyline.DataMiner.DataSources.OpenConfig.Gnmi.dll

A class that represents a single gRPC connection which can be used to handle gNMI communication. This requires the CommunicationGateway DxM to be available.

'Channel' refers to a virtual connection to a conceptual endpoint in the DxM. 'Connection' refers to an active gRPC (HTTP2) connection with an endpoint. 'DataSource' refers to a conceptual endpoint and its identifying parameters. 'Node' refers to a location in the OpenConfig schema, represented by a path. A node can be a leaf, a container, a list, etc.

public class GnmiClient : IMiddlewareClient
Inheritance
GnmiClient
Implements
Extension Methods

Constructors

GnmiClient(uint, uint, string, DataSourceConfiguration, ILogger)

Constructs a gNMI/gRPC client that will use the CommunicationGateway DxM to connect to a device. The connection is only set up when Connect() is called.

Properties

ChannelId
ChannelName
IsConnected
Logger
WorkloadMonitor

Methods

Capabilities()

Get the capabilities of the endpoint.

ChangeConfiguration(DataSourceConfiguration)
Connect()
Delete(Path)

Deletes a path from the data tree. When the path is specified to an element that has children, these children will be recursively deleted.

Delete(string)

Deletes a path from the data tree. When the path is specified to an element that has children, these children will be recursively deleted.

Disconnect()
Dispose()

The dispose will also call Disconnect.

Dispose(bool)

Disposing the object.

Get(IEnumerable<Path>)

Get the gNMI values for the specified paths.

Get(IEnumerable<string>)

Get the gNMI values for the specified paths.

Set(Path, bool)

Sets the value for a specific path.

Set(Path, double)

Sets the value for a specific path.

Set(Path, long)

Sets the value for a specific path.

Set(Path, string)

Sets the value for a specific path.

Set(Path, string, StringValueContentType)

Sets the value for a specific path.

Set(Path, ulong)

Sets the value for a specific path.

Set(string, bool)

Sets the value for a specific path.

Set(string, double)

Sets the value for a specific path.

Set(string, long)

Sets the value for a specific path.

Set(string, string)

Sets the value for a specific path.

Set(string, string, StringValueContentType)

Sets the value for a specific path.

Set(string, ulong)

Sets the value for a specific path.

SetDataMapper(IDataMapper)

Sets the data mapper that will process incoming messages. An SLProtocol compatible implementation is available in the Skyline.DataMiner.DataSources.OpenConfig.Gnmi.Protocol Nuget: DataMinerConnectorDataMapper.

Subscribe(string, IEnumerable<Path>, Action<IEnumerable<GnmiResponseValue>>, bool)

Adds a subscription for changed values on the endpoint for the specified paths.

Subscribe(string, IEnumerable<string>, Action<IEnumerable<GnmiResponseValue>>, bool)

Adds a subscription for changed values on the endpoint for the specified paths.

Subscribe(string, TimeSpan, IEnumerable<Path>, Action<IEnumerable<GnmiResponseValue>>)

Adds a subscription with a sample interval on the endpoint for the specified paths.

Subscribe(string, TimeSpan, IEnumerable<Path>, bool, TimeSpan, Action<IEnumerable<GnmiResponseValue>>)

Adds a subscription with a sample interval on the endpoint for the specified paths.

Subscribe(string, TimeSpan, IEnumerable<string>, Action<IEnumerable<GnmiResponseValue>>)

Adds a subscription with a sample interval on the endpoint for the specified paths.

Subscribe(string, TimeSpan, IEnumerable<string>, bool, TimeSpan, Action<IEnumerable<GnmiResponseValue>>)

Adds a subscription with a sample interval on the endpoint for the specified paths.

Unsubscribe(string)

Events

ConnectionStateChanged
SubscriptionDataCleared
SubscriptionLost