channel

README

---

title: Channel weight: 4706

flogo-channel

This trigger provides your flogo application the ability to start an action via a named engine channel

Installation

flogo install github.com/TIBCOSoftware/flogo-contrib/trigger/channel

Schema

Settings, Outputs and Endpoint:

{
  "settings": [
  ],
  "output": [
    {
      "name": "value",
      "type": "any"
    }
  ],
  "handler": {
    "settings": [
      {
        "name": "channel",
        "type": "string",
        "required" : true
      }
    ]
  }
}

Settings

Handler:

Setting	Description
channel	The internal engine channel

Example Configurations

Triggers are configured via the triggers.json of your application. The following are some example configuration of the CHANNEL Trigger.

Run Flow

Configure the Trigger to handle an event recieved on the 'test' channel

{
  "triggers": [
    {
      "name": "flogo-channel",
      "channel": [
        {
          "settings": {
            "channel": "test"
          },
          "action": {
            "ref": "github.com/TIBCOSoftware/flogo-contrib/action/flow",
            "data": {
                "flowURI": "res://flow:testflow"
            }       
          }
        }
      ]
    }
  ]
}

Documentation

Index

• func NewFactory(md *trigger.Metadata) trigger.Factory
• type ChannelFactory
  • func (t *ChannelFactory) New(config *trigger.Config) trigger.Trigger
• type ChannelListener
  • func (l *ChannelListener) OnMessage(msg interface{})
• type ChannelTrigger
  • func (t *ChannelTrigger) Initialize(ctx trigger.InitContext) error
  • func (t *ChannelTrigger) Metadata() *trigger.Metadata
  • func (t *ChannelTrigger) Start() error
  • func (t *ChannelTrigger) Stop() error

Functions

func NewFactory

func NewFactory(md *trigger.Metadata) trigger.Factory

NewFactory create a new Trigger factory

Types

type ChannelFactory

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

ChannelFactory CHANNEL Trigger factory

func (*ChannelFactory) New

func (t *ChannelFactory) New(config *trigger.Config) trigger.Trigger

New Creates a new trigger instance for a given id

type ChannelListener

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

func (*ChannelListener) OnMessage

func (l *ChannelListener) OnMessage(msg interface{})

type ChannelTrigger

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

ChannelTrigger CHANNEL trigger struct

func (*ChannelTrigger) Initialize

func (t *ChannelTrigger) Initialize(ctx trigger.InitContext) error

func (*ChannelTrigger) Metadata

func (t *ChannelTrigger) Metadata() *trigger.Metadata

Metadata implements trigger.Trigger.Metadata

func (*ChannelTrigger) Start

func (t *ChannelTrigger) Start() error

func (*ChannelTrigger) Stop

func (t *ChannelTrigger) Stop() error

Stop implements util.Managed.Stop