graph

Documentation

Index

• type Connection
  • func (connection *Connection) String() string
• type Description
  • func NewDescription() *Description
  • func ParseFBP(definition []byte) (*Description, error)
  • func ParseJSON(definition []byte) (*Description, error)
• type Endpoint
  • func (endpoint *Endpoint) String(isInput bool) string
• type Export
• type Process
  • func (process *Process) String() string

Types

type Connection

type Connection struct {
	Data     string            `json:"data,omitempty"`
	Src      *Endpoint         `json:"src,omitempty"`
	Tgt      *Endpoint         `json:"tgt,omitempty"`
	Metadata map[string]string `json:"omitempty"`
}

Connection between processes in the network

func (*Connection) String

func (connection *Connection) String() string

type Description

type Description struct {
	Properties  map[string]string  `json:"properties"`
	Processes   map[string]Process `json:"processes`
	Connections []Connection       `json:"connections"`
	Inports     []Export           `json:"inports"`
	Outports    []Export           `json:"outports`
}

Description describes FBP network

func NewDescription

func NewDescription() *Description

NewDescription is a Description constructor

func ParseFBP

func ParseFBP(definition []byte) (*Description, error)

ParseFBP parses a given definition in NoFlo's .fbp DSL and returns unified Description structure

func ParseJSON

func ParseJSON(definition []byte) (*Description, error)

ParseJSON parses a given definition in NoFlo's .JSON and returns unified Description structure

type Endpoint

type Endpoint struct {
	Process string `json:"process"`
	Port    string `json:"port"`
	Index   *int   `json:"index,omitempty"`
}

Endpoint of the process

func (*Endpoint) String

func (endpoint *Endpoint) String(isInput bool) string

type Export

type Export struct {
	Private string `json:"private"`
	Public  string `json:"public"`
}

Export exported port of the process

type Process

type Process struct {
	Component string
	Metadata  map[string]string `json:"omitempty"`
}

Process of the network

func (*Process) String

func (process *Process) String() string