counter

package module

v0.0.0-...-d725791 Latest Latest Go to latest Published: Feb 18, 2023 License: BSD-3-Clause Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/JCorpse96/contrib

Links

Open Source Insights

README ¶

Counter

This activity allows you to use a global counter.

Installation

Flogo CLI

flogo install github.com/project-flogo/contrib/activity/counter

Configuration

Settings:

Name	Type	Description
counterName	string	The name of the counter - REQUIRED
op	string	The counter operation, 'get' is the default operation

Output:

Name	Type	Description
value	int	The result of the counter operation

Examples

Increment

The below example increments a 'messages' counter:

{
  "id": "increment_message_count",
  "name": "Increment Message Count",
  "activity": {
    "ref": "github.com/project-flogo/contrib/activity/counter",
    "settings": {
      "counterName": "messages",
      "op": "increment"
    }
  }
}

Get

The below example retrieves the last value of the 'messages' counter:

{
  "id": "get_message_count",
  "name": "Get Message Count",
  "activity": {
    "ref": "github.com/project-flogo/contrib/activity/counter",
    "settings": {
      "counterName": "messages",
      "op": "get"
    }
  }
}

Reset

The below example resets the 'messages' counter:

{
  "id": "reset_message_count",
  "name": "Reset Message Count",
  "activity": {
    "ref": "github.com/project-flogo/contrib/activity/counter",
    "settings": {
      "counterName": "messages",
      "op": "reset"
    }
  }
}

Documentation ¶

Index ¶

func New(ctx activity.InitContext) (activity.Activity, error)
type Activity
- func (a *Activity) Eval(context activity.Context) (done bool, err error)
- func (a *Activity) Metadata() *activity.Metadata
type Counter
type CounterFunc
type Output
type Settings

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(ctx activity.InitContext) (activity.Activity, error)

Types ¶

type Activity ¶

type Activity struct {
	// contains filtered or unexported fields
}

Activity is a Counter Activity implementation

func (*Activity) Eval ¶

func (a *Activity) Eval(context activity.Context) (done bool, err error)

Eval implements activity.Activity.Eval

func (*Activity) Metadata ¶

func (a *Activity) Metadata() *activity.Metadata

Metadata implements activity.Activity.Metadata

type Counter ¶

type Counter struct {
	// contains filtered or unexported fields
}

func (*Counter) Get ¶

func (c *Counter) Get() uint64

func (*Counter) Increment ¶

func (c *Counter) Increment() uint64

func (*Counter) Reset ¶

func (c *Counter) Reset() uint64

type CounterFunc ¶

type CounterFunc func() uint64

type Output ¶

type Output struct {
	Value int `md:"value"` // The result of the counter operation
}

type Settings ¶

type Settings struct {
	CounterName string `md:"counterName,required"`            // The name of the counter
	Op          string `md:"op,allowed(get,increment,reset)"` // The counter operation, 'get' is the default operation
}

Source Files ¶

View all Source files

activity.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL