go.ligato.io/vpp-agent/v3@v3.5.0/plugins/linux/iptablesplugin/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 iptablesplugin
    16  
    17  import (
    18  	"go.ligato.io/cn-infra/v2/config"
    19  	"go.ligato.io/cn-infra/v2/logging"
    20  
    21  	"go.ligato.io/vpp-agent/v3/plugins/kvscheduler"
    22  	"go.ligato.io/vpp-agent/v3/plugins/linux/nsplugin"
    23  )
    24  
    25  // DefaultPlugin is a default instance of IPTablesPlugin.
    26  var DefaultPlugin = *NewPlugin()
    27  
    28  // NewPlugin creates a new Plugin with the provides Options.
    29  func NewPlugin(opts ...Option) *IPTablesPlugin {
    30  	p := &IPTablesPlugin{}
    31  
    32  	p.PluginName = "linux-iptablesplugin"
    33  	p.KVScheduler = &kvscheduler.DefaultPlugin
    34  	p.NsPlugin = &nsplugin.DefaultPlugin
    35  
    36  	for _, o := range opts {
    37  		o(p)
    38  	}
    39  
    40  	if p.Log == nil {
    41  		p.Log = logging.ForPlugin(p.String())
    42  	}
    43  	if p.Cfg == nil {
    44  		p.Cfg = config.ForPlugin(p.String(),
    45  			config.WithCustomizedFlag(config.FlagName(p.String()), "linux-iptablesplugin.conf"),
    46  		)
    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(*IPTablesPlugin)
    54  
    55  // UseDeps returns Option that can inject custom dependencies.
    56  func UseDeps(f func(*Deps)) Option {
    57  	return func(p *IPTablesPlugin) {
    58  		f(&p.Deps)
    59  	}
    60  }