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