go.ligato.io/vpp-agent/v3@v3.5.0/plugins/vpp/ifplugin/ifplugin_api.go (about)

     1  // Copyright (c) 2018 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 ifplugin
    16  
    17  import (
    18  	"go.ligato.io/cn-infra/v2/idxmap"
    19  
    20  	"go.ligato.io/vpp-agent/v3/plugins/vpp/ifplugin/ifaceidx"
    21  	"go.ligato.io/vpp-agent/v3/proto/ligato/vpp"
    22  )
    23  
    24  // API defines methods exposed by VPP-IfPlugin.
    25  type API interface {
    26  	// GetInterfaceIndex gives read-only access to map with metadata of all configured
    27  	// VPP interfaces.
    28  	GetInterfaceIndex() ifaceidx.IfaceMetadataIndex
    29  
    30  	// GetDHCPIndex gives read-only access to (untyped) map with DHCP leases.
    31  	// Cast metadata to "go.ligato.io/vpp-agent/v3/proto/ligato/vpp/interfaces".DHCPLease
    32  	GetDHCPIndex() idxmap.NamedMapping
    33  
    34  	// SetNotifyService allows to pass function for updating interface notifications.
    35  	SetNotifyService(notify func(notification *vpp.Notification))
    36  }