azure-storage-fuse/internal/component.template

/*
    _____           _____   _____   ____          ______  _____  ------
   |     |  |      |     | |     | |     |     | |       |            |
   |     |  |      |     | |     | |     |     | |       |            |
   | --- |  |      |     | |-----| |---- |     | |-----| |-----  ------
   |     |  |      |     | |     | |     |     |       | |       |
   | ____|  |_____ | ____| | ____| |     |_____|  _____| |_____  |_____


   Licensed under the MIT License <http://opensource.org/licenses/MIT>.

   Copyright © 2020-2022 Microsoft Corporation. All rights reserved.
   Author : <blobfusedev@microsoft.com>

   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to deal
   in the Software without restriction, including without limitation the rights
   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included in all
   copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   SOFTWARE
*/

package <component>

import (
	"github.com/Azure/azure-storage-fuse/v2/common/config"
	"github.com/Azure/azure-storage-fuse/v2/common/log"
	"github.com/Azure/azure-storage-fuse/v2/internal"
	"context"
	"fmt"
)

/* NOTES:
   - Component shall have a structure which inherits "internal.BaseComponent" to participate in pipeline
   - Component shall register a name and its constructor to participate in pipeline  (add by default by generator)
   - Order of calls : Constructor -> Configure -> Start ..... -> Stop
   - To read any new setting from config file follow the Configure method default comments
*/

// Common structure for Component
type <component_C> struct {
    internal.BaseComponent
}

// Structure defining your config parameters
type <component_C>Options struct {
	// e.g. var1 uint32 `config:"var1"`
}

const compName = "<component>"

//  Verification to check satisfaction criteria with Component Interface
var _ internal.Component = &<component_C>{}


func (c *<component_C>) Name() string {
	return compName
}

func (c *<component_C>) SetName(name string) {
	c.BaseComponent.SetName(name)
}

func (c *<component_C>) SetNextComponent(nc internal.Component) {
	c.BaseComponent.SetNextComponent(nc)
}

// Start : Pipeline calls this method to start the component functionality
//  this shall not block the call otherwise pipeline will not start
func (c *<component_C>) Start(ctx context.Context) error {
    log.Trace("<component_C>::Start : Starting component %s", c.Name())

    // <component_C> : start code goes here

    return nil
}

// Stop : Stop the component functionality and kill all threads started
func (c *<component_C>) Stop() error {
	log.Trace("<component_C>::Stop : Stopping component %s", c.Name())

	return nil
}

// Configure : Pipeline will call this method after constructor so that you can read config and initialize yourself
//  Return failure if any config is not valid to exit the process
func (c *<component_C>) Configure() error {
	log.Trace("<component_C>::Configure : %s", c.Name())

	// >> If you do not need any config parameters remove below code and return nil
	conf := <component_C>Options{}
	err := config.UnmarshalKey(c.Name(), &conf)
	if err != nil {
		log.Err("<component_C>::Configure : config error [invalid config attributes]")
		return fmt.Errorf("<component_C>: config error [invalid config attributes]")
	}
	// Extract values from 'conf' and store them as you wish here

	return nil
}


// OnConfigChange : If component has registered, on config file change this method is called
func (c *<component_C>) OnConfigChange() {
}

// ------------------------- Factory -------------------------------------------

// Pipeline will call this method to create your object, initialize your variables here
// << DO NOT DELETE ANY AUTO GENERATED CODE HERE >>
func New<component_C>Component() internal.Component {
	comp := &<component_C>{}
	comp.SetName(compName)
	return comp
}

// On init register this component to pipeline and supply your constructor
func init() {
	internal.AddComponent(compName, New<component_C>Component)
}