go.ligato.io/vpp-agent/v3@v3.5.0/plugins/govppmux/plugin_api_govppmux.go (about)

     1  //  Copyright (c) 2019 Cisco and/or its affiliates.
     2  //
     3  //  Licensed under the Apache License, Version 2.0 (the "License");
     4  //  you may not use this file except in compliance with the License.
     5  //  You may obtain a copy of the License at:
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  //  Unless required by applicable law or agreed to in writing, software
    10  //  distributed under the License is distributed on an "AS IS" BASIS,
    11  //  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  //  See the License for the specific language governing permissions and
    13  //  limitations under the License.
    14  
    15  package govppmux
    16  
    17  import (
    18  	"go.ligato.io/vpp-agent/v3/plugins/govppmux/vppcalls"
    19  	"go.ligato.io/vpp-agent/v3/plugins/vpp"
    20  )
    21  
    22  // API for other plugins to get connectivity to VPP.
    23  type API interface {
    24  	// VPPInfo returns VPP information which is retrieved immediatelly after connecting to VPP.
    25  	VPPInfo() VPPInfo
    26  
    27  	vpp.Client
    28  }
    29  
    30  // VPPInfo defines retrieved information about the connected VPP instance.
    31  type VPPInfo struct {
    32  	Connected bool
    33  	vppcalls.VersionInfo
    34  	vppcalls.SessionInfo
    35  	Plugins []vppcalls.PluginInfo
    36  }
    37  
    38  // GetReleaseVersion returns VPP release version (XX.YY), which is normalized from GetVersion.
    39  func (vpp VPPInfo) GetReleaseVersion() string {
    40  	if len(vpp.Version) < 5 {
    41  		return ""
    42  	}
    43  	return vpp.Version[:5]
    44  }