cmd

Documentation

Index

• type Cmd
• type Cmds
  • func (c *Cmds) Get(line string) (Cmd, error)
  • func (c *Cmds) Put(cmds ...Cmd) error
  • func (c *Cmds) Run(line string, ctx RunContext) (exist bool, err error)
• type DynamicCmd
  • func (d DynamicCmd) Prefix() []byte
  • func (d DynamicCmd) String() string
• type RunContext
• type SingleCmd
  • func (s SingleCmd) Match(line string) error
  • func (s SingleCmd) Prefix() []byte
  • func (s SingleCmd) String() string

Types

type Cmd

type Cmd interface {
	Prefix() []byte               // prefix of command, used for pattern matching
	Match(string) error           // whether the parameter is matching current command
	Run(string, RunContext) error // execute command
	String() string
}

type Cmds

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

var (
	AllCommands *Cmds = new(Cmds)
)

func (*Cmds) Get

func (c *Cmds) Get(line string) (Cmd, error)

func (*Cmds) Put

func (c *Cmds) Put(cmds ...Cmd) error

func (*Cmds) Run

func (c *Cmds) Run(line string, ctx RunContext) (exist bool, err error)

type DynamicCmd

type DynamicCmd string

func (DynamicCmd) Prefix

func (d DynamicCmd) Prefix() []byte

func (DynamicCmd) String

func (d DynamicCmd) String() string

type RunContext

type RunContext interface {
	NetworkManager() models.NetworkManager // network service interface
	DataManager() models.DataManager       // data service interface
	Engine() models.Engine                 // consensus engine
	Eventer() models.Eventer               // event queue
	Config() *config.Config                // system configuration
}

type SingleCmd

type SingleCmd string

func (SingleCmd) Match

func (s SingleCmd) Match(line string) error

func (SingleCmd) Prefix

func (s SingleCmd) Prefix() []byte

func (SingleCmd) String

func (s SingleCmd) String() string