The highest tagged major version is
README
¶
Machine is a
Usage Overview
Usage
Want more?
If you were hoping to see an API converted using closures and came up empty handed, there's a chance all can be right. Simply vote on a feature by adding a 👍 reaction.
License
Machine is provided under the APL 2.0 License.
Copyright 2020 jonathan whitaker
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Documentation
¶
Index ¶
- type Builder
- type Initium
- type Machine
- type Packet
- type Processus
- type RouteHandler
- type RouterBuilder
- func (m *RouterBuilder) RouteLeft(left *RouterBuilder) *RouterBuilder
- func (m *RouterBuilder) RouteRight(right *RouterBuilder) *RouterBuilder
- func (m *RouterBuilder) TerminateLeft(t *TerminationBuilder) *RouterBuilder
- func (m *RouterBuilder) TerminateRight(t *TerminationBuilder) *RouterBuilder
- func (m *RouterBuilder) ThenLeft(left *VertexBuilder) *RouterBuilder
- func (m *RouterBuilder) ThenRight(right *VertexBuilder) *RouterBuilder
- type RouterDuplicate
- type RouterError
- type RouterRule
- type TerminationBuilder
- type Terminus
- type VertexBuilder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
Builder builder type for starting a machine
func (*Builder) Route ¶
func (m *Builder) Route(r *RouterBuilder) *Builder
Route func for sending the payload to a router
func (*Builder) Terminate ¶
func (m *Builder) Terminate(t *TerminationBuilder) *Builder
Terminate func for sending the payload to a cap
func (*Builder) Then ¶
func (m *Builder) Then(v *VertexBuilder) *Builder
Then func for sending the payload to a processor
type Machine ¶
type Machine struct {
// contains filtered or unexported fields
}
Machine execution graph for a system
type RouteHandler ¶
RouteHandler func for splitting a payload into 2
type RouterBuilder ¶
type RouterBuilder struct {
// contains filtered or unexported fields
}
RouterBuilder builder type for adding a router to the machine
func NewRouter ¶
func NewRouter(id, name string, fifo bool, r RouteHandler) *RouterBuilder
NewRouter func for providing an instance of RouterBuilder
func (*RouterBuilder) RouteLeft ¶
func (m *RouterBuilder) RouteLeft(left *RouterBuilder) *RouterBuilder
RouteLeft func for sending the payload to a router
func (*RouterBuilder) RouteRight ¶
func (m *RouterBuilder) RouteRight(right *RouterBuilder) *RouterBuilder
RouteRight func for sending the payload to a router
func (*RouterBuilder) TerminateLeft ¶
func (m *RouterBuilder) TerminateLeft(t *TerminationBuilder) *RouterBuilder
TerminateLeft func for sending the payload to a cap
func (*RouterBuilder) TerminateRight ¶
func (m *RouterBuilder) TerminateRight(t *TerminationBuilder) *RouterBuilder
TerminateRight func for sending the payload to a cap
func (*RouterBuilder) ThenLeft ¶
func (m *RouterBuilder) ThenLeft(left *VertexBuilder) *RouterBuilder
ThenLeft func for sending the payload to a processor
func (*RouterBuilder) ThenRight ¶
func (m *RouterBuilder) ThenRight(right *VertexBuilder) *RouterBuilder
ThenRight func for sending the payload to a processor
type RouterDuplicate ¶
type RouterDuplicate struct{}
RouterDuplicate type for splitting errors from successes
func (RouterDuplicate) Handler ¶
func (d RouterDuplicate) Handler(payload []*Packet) (a, b []*Packet)
Handler func for providing a RouteHandler
type RouterError ¶
type RouterError struct{}
RouterError type for splitting errors from successes
func (RouterError) Handler ¶
func (e RouterError) Handler(payload []*Packet) (s, f []*Packet)
Handler func for providing a RouteHandler
type RouterRule ¶
RouterRule type for validating a context at the beginning of a Machine
func (RouterRule) Handler ¶
func (r RouterRule) Handler(payload []*Packet) (t, f []*Packet)
Handler func for providing a RouteHandler
type TerminationBuilder ¶
type TerminationBuilder struct {
// contains filtered or unexported fields
}
TerminationBuilder builder type for adding a termination to the machine
func NewTermination ¶
func NewTermination(id, name string, fifo bool, t Terminus) *TerminationBuilder
NewTermination func for providing an instance of TerminationBuilder
type VertexBuilder ¶
type VertexBuilder struct {
// contains filtered or unexported fields
}
VertexBuilder builder type for adding a processor to the machine
func NewVertex ¶
func NewVertex(id, name string, fifo bool, p Processus) *VertexBuilder
NewVertex func for providing an instance of VertexBuilder
func (*VertexBuilder) Route ¶
func (m *VertexBuilder) Route(r *RouterBuilder) *VertexBuilder
Route func for sending the payload to a router
func (*VertexBuilder) Terminate ¶
func (m *VertexBuilder) Terminate(t *TerminationBuilder) *VertexBuilder
Terminate func for sending the payload to a cap
func (*VertexBuilder) Then ¶
func (m *VertexBuilder) Then(v *VertexBuilder) *VertexBuilder
Then func for sending the payload to a processor
Source Files
Directories