fbp

README

Proof of Concept Flow Based Programming library

Documentation

Index

• Constants
• type Graph
  • func New(comm interface{}) *Graph
  • func (g *Graph) Setup(def string) error
  • func (g *Graph) Start()
  • func (g *Graph) WireUp(w *Wiring) error
• type MakeFn
• type Name
• type Node
• type Port
  • func NewPort(name string, v reflect.Value) *Port
  • func (c *Port) Acquire()
  • func (c *Port) Release()
• type PortName
• type Registry
• type Runnable
• type Type
• type Wire
• type Wiring
  • func ParseWiring(def string) (*Wiring, error)

Constants

const BufferSize = 0

Types

type Graph

type Graph struct {
	// Comm is used for input/output from the Graph
	Comm interface{}
	// Registry contains all the constructors for nodes
	Registry Registry
	// Nodes contains created node information
	Nodes map[Name]Node
	// Ports contains all tha ports
	Ports map[string]*Port
}

func New

func New(comm interface{}) *Graph

func (*Graph) Setup

func (g *Graph) Setup(def string) error

Setup is convenience for parsing the wiring and wiring up the graph

func (*Graph) Start

func (g *Graph) Start()

starts all the nodes

func (*Graph) WireUp

func (g *Graph) WireUp(w *Wiring) error

type MakeFn

type MakeFn func() Node

type Name

type Name string

type Node

type Node interface{}

type Port

type Port struct {
	Name string
	Chan reflect.Value
	Refs int32
}

func NewPort

func NewPort(name string, v reflect.Value) *Port

func (*Port) Acquire

func (c *Port) Acquire()

func (*Port) Release

func (c *Port) Release()

type PortName

type PortName string

type Registry

type Registry map[Type]MakeFn

type Runnable

type Runnable interface {
	Run() error
}

type Type

type Type string

type Wire

type Wire struct {
	From Name
	Src  PortName
	To   Name
	Dst  PortName
}

type Wiring

type Wiring struct {
	Decls map[Name]Type
	Wires []Wire
}

func ParseWiring

func ParseWiring(def string) (*Wiring, error)