path

Documentation

Overview

Package providers implements support for Go service providers.

YANG Development Kit Copyright 2017 Cisco Systems. All rights reserved. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func ExecuteGnmiRPC(provider types.ServiceProvider, rpcTag string, entity types.Entity, ...) types.DataNode
• func GetSubscribeDataPayload(provider types.ServiceProvider, entity types.Entity) string
• func GnmiServiceGet(provider types.CServiceProvider, filter types.Entity, operation string) types.DataNode
• func GnmiServiceGetCapabilities(provider types.CServiceProvider) string
• func GnmiServiceProviderConnect(state *errors.State, repo types.Repository, address string, port int, ...) types.CServiceProvider
• func GnmiServiceProviderDisconnect(provider types.CServiceProvider)
• type GnmiSession
  • func GnmiServiceProviderGetSession(provider types.CServiceProvider) *GnmiSession
  • func (gs *GnmiSession) Connect()
  • func (gs *GnmiSession) Disconnect()
  • func (gs *GnmiSession) ExecuteRpc(rpc types.Rpc) types.DataNode
  • func (gs *GnmiSession) ExecuteSubscribeRpc(rpc types.Rpc)
  • func (gs *GnmiSession) GetLastSubscribeResponse(previousResponse string) string
  • func (gs *GnmiSession) GetRootSchemaNode() types.RootSchemaNode
  • func (gs *GnmiSession) SubscribeInProgress() bool

Functions

func ExecuteGnmiRPC

func ExecuteGnmiRPC(
	provider types.ServiceProvider,
	rpcTag string,
	entity types.Entity,
	options map[string]string) types.DataNode

ExecuteRPC executes payload converted from entity for CRUD/Netconf services. Returns a data node (types.DataNode) representing the result of the executed rpc.

func GetSubscribeDataPayload

func GetSubscribeDataPayload(provider types.ServiceProvider, entity types.Entity) string

func GnmiServiceGet

func GnmiServiceGet(provider types.CServiceProvider, filter types.Entity, operation string) types.DataNode

func GnmiServiceGetCapabilities

func GnmiServiceGetCapabilities(provider types.CServiceProvider) string

GnmiService C-wrapper functions

func GnmiServiceProviderConnect

func GnmiServiceProviderConnect(
	state *errors.State,
	repo types.Repository,
	address string, port int,
	username, password string,
	serverCert, privateKey string) types.CServiceProvider

gNMI Service Provider C-wrapper functions

func GnmiServiceProviderDisconnect

func GnmiServiceProviderDisconnect(provider types.CServiceProvider)

Types

type GnmiSession

type GnmiSession struct {
	Repo       types.Repository
	Address    string
	Username   string
	Password   string
	Port       int
	ServerCert string
	PrivateKey string

	Private interface{}
	State   errors.State
}

GnmiSession declaration and methods

func GnmiServiceProviderGetSession

func GnmiServiceProviderGetSession(provider types.CServiceProvider) *GnmiSession

func (*GnmiSession) Connect

func (gs *GnmiSession) Connect()

Connect to gNMI Session

func (*GnmiSession) Disconnect

func (gs *GnmiSession) Disconnect()

Disconnect from gNMI Session

func (*GnmiSession) ExecuteRpc

func (gs *GnmiSession) ExecuteRpc(rpc types.Rpc) types.DataNode

func (*GnmiSession) ExecuteSubscribeRpc

func (gs *GnmiSession) ExecuteSubscribeRpc(rpc types.Rpc)

func (*GnmiSession) GetLastSubscribeResponse

func (gs *GnmiSession) GetLastSubscribeResponse(previousResponse string) string

func (*GnmiSession) GetRootSchemaNode

func (gs *GnmiSession) GetRootSchemaNode() types.RootSchemaNode

func (*GnmiSession) SubscribeInProgress

func (gs *GnmiSession) SubscribeInProgress() bool

Utility functions