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