input

Documentation

Index

• type ConsoleReader
  • func NewConsoleReader(providedQueue chan<- message.Instruction) *ConsoleReader
  • func (c *ConsoleReader) CreateInstruction(text string) (message.Instruction, error)
  • func (c *ConsoleReader) Start()
  • func (c *ConsoleReader) Stop()
• type Readable

Types

type ConsoleReader

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

ConsoleReader will read text from the console, convert it into `messages.Instruction` types and emit them into a read queue

func NewConsoleReader

func NewConsoleReader(providedQueue chan<- message.Instruction) *ConsoleReader

NewConsoleReader will return a console reader configured to emit messages on the provided `messages.Instruction` channel

func (*ConsoleReader) CreateInstruction

func (c *ConsoleReader) CreateInstruction(text string) (message.Instruction, error)

CreateInstruction creates a device.Instruction from the specified text input

func (*ConsoleReader) Start

func (c *ConsoleReader) Start()

Start starts the console reader. This should be wrapped in a gofunc TODO should probably use readrune and define a tokenizer or something

func (*ConsoleReader) Stop

func (c *ConsoleReader) Stop()

Stop will shut down the console reader

type Readable

type Readable interface {
	Start()
	Stop()
}

Readable defines an interface which anything that can consume control signals should satisfy.