protocol

package

v0.0.0-...-a0c0297 Latest Latest Go to latest Published: Jun 11, 2023 License: MIT Imports: 5 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/ibrahimduran/hub

Links

Open Source Insights

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
type Provider

Constants ¶

View Source

const (
	CommandBufferSize = 100
)

Variables ¶

View Source

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
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
local

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