go.ligato.io/vpp-agent/v3@v3.5.0/plugins/vpp/abfplugin/options.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 abfplugin
    16  
    17  import (
    18  	"go.ligato.io/cn-infra/v2/health/statuscheck"
    19  	"go.ligato.io/cn-infra/v2/logging"
    20  	"go.ligato.io/vpp-agent/v3/plugins/govppmux"
    21  	"go.ligato.io/vpp-agent/v3/plugins/kvscheduler"
    22  	"go.ligato.io/vpp-agent/v3/plugins/vpp/aclplugin"
    23  	"go.ligato.io/vpp-agent/v3/plugins/vpp/ifplugin"
    24  )
    25  
    26  // DefaultPlugin is a default instance of ABFPlugin.
    27  var DefaultPlugin = *NewPlugin()
    28  
    29  // NewPlugin creates a new Plugin with the provides Options
    30  func NewPlugin(opts ...Option) *ABFPlugin {
    31  	p := &ABFPlugin{}
    32  
    33  	p.PluginName = "vpp-abfplugin"
    34  	p.StatusCheck = &statuscheck.DefaultPlugin
    35  	p.Scheduler = &kvscheduler.DefaultPlugin
    36  	p.VPP = &govppmux.DefaultPlugin
    37  	p.ACLPlugin = &aclplugin.DefaultPlugin
    38  	p.IfPlugin = &ifplugin.DefaultPlugin
    39  
    40  	for _, o := range opts {
    41  		o(p)
    42  	}
    43  
    44  	if p.Log == nil {
    45  		p.Log = logging.ForPlugin(p.String())
    46  	}
    47  
    48  	return p
    49  }
    50  
    51  // Option is a function that can be used in NewPlugin to customize Plugin.
    52  type Option func(plugin *ABFPlugin)
    53  
    54  // UseDeps returns Option that can inject custom dependencies.
    55  func UseDeps(f func(*Deps)) Option {
    56  	return func(p *ABFPlugin) {
    57  		f(&p.Deps)
    58  	}
    59  }