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