protocol

Documentation

Index

• Constants
• Variables
• func ReadCmd(ctx context.Context, buffer chan byte, maxLength int) (string, error)
• type Metadata
• type ModeCommand
  • func (c *ModeCommand) Metadata() Metadata
  • func (c *ModeCommand) Run(proto *Protocol) error
• type Protocol
  • func (p *Protocol) Close()
  • func (p *Protocol) Error(err error)
  • func (p *Protocol) Run(ctx context.Context)
  • func (p *Protocol) Write(data []byte) (int, error)
• type Provider

Constants

const (
	CommandBufferSize = 100
)

Variables

var (
	ErrCommandNotFound       = errors.New("command not found")
	ErrCommandBufferExceeded = errors.New("command buffer length exceeded")
	ErrSocketClosed          = errors.New("socket closed")
	ErrCanNotExecute         = errors.New("can not execute this command")
)

Functions

func ReadCmd

func ReadCmd(ctx context.Context, buffer chan byte, maxLength int) (string, error)

Types

type Metadata

type Metadata struct {
	Name        string
	Description string
}

type ModeCommand

type ModeCommand struct {
}

func (*ModeCommand) Metadata

func (c *ModeCommand) Metadata() Metadata

func (*ModeCommand) Run

func (c *ModeCommand) Run(proto *Protocol) error

type Protocol

type Protocol struct {
	Providers         []Provider
	Stream            io.ReadWriteCloser
	BufferBacklogSize int
	BufferSize        int
	Interactive       bool
	// contains filtered or unexported fields
}

func (*Protocol) Close

func (p *Protocol) Close()

func (*Protocol) Error

func (p *Protocol) Error(err error)

func (*Protocol) Run

func (p *Protocol) Run(ctx context.Context)

func (*Protocol) Write

func (p *Protocol) Write(data []byte) (int, error)

type Provider

type Provider interface {
	Execute(cmd string, protocol *Protocol) error
	CanExecute(cmd string, protocol *Protocol) bool
	List() []Metadata
}