stream

package

v1.0.1 Latest Latest Go to latest Published: Mar 14, 2024 License: AGPL-3.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/e9ctrl/vd

Links

Open Source Insights

Documentation ¶

Overview ¶

string stream protocol package provides a simple and efficient way to parse lab device communication streams

Index ¶

Variables
func NewParser(vdfile *vdfile.VDFile) (protocol.Protocol, error)
type CommandPattern
type Item
- func ItemsFromConfig(input string) []Item
type ItemType
- func (i ItemType) String() string
type Lexer
- func NewConfig(input string) *Lexer
- func NewData(input string) *Lexer
- func (l *Lexer) Items() []Item
- func (l *Lexer) NextItem() Item
type Parser
type StateFn

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrWrongResSyntax = errors.New("illegal syntax in response")
	ErrWrongReqSyntax = errors.New("illegal syntax in request")
)

Functions ¶

func NewParser ¶

func NewParser(vdfile *vdfile.VDFile) (protocol.Protocol, error)

Constructor, returns parser struct with processed commands patterns that are used while parsing incoming data.

Types ¶

type CommandPattern ¶

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

Keeps request and response tokens

type Item ¶

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

Main structure that keeps token type and its value.

func ItemsFromConfig ¶

func ItemsFromConfig(input string) []Item

Convert string input to set of Items config

func (Item) String ¶

func (i Item) String() string

To string representation

func (Item) Type ¶

func (i Item) Type() ItemType

Item type

func (Item) Value ¶

func (i Item) Value() string

Value setter

type ItemType ¶

type ItemType int

const (
	ItemError ItemType = iota

	ItemCommand

	ItemNumberValuePlaceholder
	ItemStringValuePlaceholder

	ItemWhiteSpace

	ItemLeftMeta
	ItemParam
	ItemRightMeta

	ItemNumber

	ItemEOF
	ItemIllegal
	ItemEscape
)

func (ItemType) String ¶

func (i ItemType) String() string

To string representation

type Lexer ¶

type Lexer struct {
	Input string //the input string being scanned

	ItemsCh chan Item //channel of scanned items
	State   StateFn   //current state of the state machine
	// contains filtered or unexported fields
}

Define the lexer struct

func NewConfig ¶

func NewConfig(input string) *Lexer

Create a new lexer with config mode

func NewData ¶

func NewData(input string) *Lexer

Create a new lexer with data mode

func (*Lexer) Items ¶

func (l *Lexer) Items() []Item

Returns the set of items for a lexer define structure

func (*Lexer) NextItem ¶

func (l *Lexer) NextItem() Item

Process the next item when available

type Parser ¶

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

Main parser structure, based on vdfile generates map of commands, and then parses incoming messages

func (*Parser) Decode ¶

func (p *Parser) Decode(data []byte) ([]protocol.Transaction, error)

Method that fullfils main Protocol interface, all logic is implemented here. Based on byte input it returns transactions to be processed.

func (*Parser) Encode ¶

func (p *Parser) Encode(txs []protocol.Transaction) ([]byte, error)

Method that fulfils Protocol interface. Based on received transactions it generates byte response/

func (*Parser) Trigger ¶

func (p *Parser) Trigger(cmdName string) protocol.Transaction

Method that fulfils Protocol interface. It enforces processing of the specified command

type StateFn ¶

type StateFn func(*Lexer) StateFn

Stage function callback

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL