pipes

Documentation

Overview

Package pipe provide helpers to pipe states from one machine to another.

Index

• func Add(source, target *am.Machine, sourceState string, targetState string) am.HandlerFinal
• func BindConnected(source, target *am.Machine, ...) error
• func BindErr(source, target *am.Machine, targetErr string) error
• func BindReady(source, target *am.Machine, activeState, inactiveState string) error
• func Remove(source, target *am.Machine, sourceState string, targetState string) am.HandlerFinal

Functions

func Add

func Add(
	source, target *am.Machine, sourceState string, targetState string,
) am.HandlerFinal

Add adds a pipe for an Add mutation between source and target machines.

targetState: default to sourceState

func BindConnected

func BindConnected(
	source, target *am.Machine, disconnected, connecting, connected,
	disconnecting string,
) error

BindConnected binds a ss.ConnectedStruct machine to 4 custom states. Each one is optional and bound with Add/Remove.

func BindErr

func BindErr(source, target *am.Machine, targetErr string) error

BindErr binds Exception to a custom state using Add. Empty state defaults to am.Exception.

func BindReady

func BindReady(
	source, target *am.Machine, activeState, inactiveState string,
) error

BindReady binds Ready to custom states using Add/Remove. Empty state defaults to Ready.

func Remove

func Remove(
	source, target *am.Machine, sourceState string, targetState string,
) am.HandlerFinal