client

Documentation

Index

• Constants
• func AttachToCmdr(tcp cmdr.OptCmd, opts ...CmdrOpt)
• func DefaultLooper(cmd *cmdr.Command, args []string, mainLoop MainLoop, prefixPrefix string, ...) (err error)
• func New(udpMode bool, config *base.Config, opts ...Opt) error
• type CmdrOpt
  • func WithCmdrClientOptions(opts ...Opt) CmdrOpt
  • func WithCmdrClientProtocolInterceptor(fn protocol.ClientInterceptor) CmdrOpt
  • func WithCmdrCommandAction(action CommandAction) CmdrOpt
  • func WithCmdrInteractiveCommand(enabled bool) CmdrOpt
  • func WithCmdrMainLoop(mainLoop MainLoop) CmdrOpt
  • func WithCmdrNil() CmdrOpt
  • func WithCmdrPort(port int) CmdrOpt
  • func WithCmdrPrefixPrefix(prefixPrefix string) CmdrOpt
  • func WithCmdrUDPMode(mode bool) CmdrOpt
• type CommandAction
• type MainLoop
• type MainLoopHolder
• type Opt
  • func WithClientMainLoop(mainLoop MainLoop) Opt
  • func WithClientPrefixPrefix(prefixPrefix string) Opt
  • func WithClientProtocolInterceptor(fn protocol.ClientInterceptor) Opt
  • func WithClientUDPMode(udpMode bool) Opt

Constants

const (
	DefaultPort = 8883
)

Functions

func AttachToCmdr

func AttachToCmdr(tcp cmdr.OptCmd, opts ...CmdrOpt)

func DefaultLooper

func DefaultLooper(cmd *cmdr.Command, args []string, mainLoop MainLoop, prefixPrefix string, opts ...Opt) (err error)

func New

func New(udpMode bool, config *base.Config, opts ...Opt) error

Types

type CmdrOpt

type CmdrOpt func(*builder)

func WithCmdrClientOptions

func WithCmdrClientOptions(opts ...Opt) CmdrOpt

func WithCmdrClientProtocolInterceptor

func WithCmdrClientProtocolInterceptor(fn protocol.ClientInterceptor) CmdrOpt

func WithCmdrCommandAction

func WithCmdrCommandAction(action CommandAction) CmdrOpt

func WithCmdrInteractiveCommand

func WithCmdrInteractiveCommand(enabled bool) CmdrOpt

func WithCmdrMainLoop

func WithCmdrMainLoop(mainLoop MainLoop) CmdrOpt

func WithCmdrNil

func WithCmdrNil() CmdrOpt

func WithCmdrPort

func WithCmdrPort(port int) CmdrOpt

func WithCmdrPrefixPrefix

func WithCmdrPrefixPrefix(prefixPrefix string) CmdrOpt

func WithCmdrUDPMode

func WithCmdrUDPMode(mode bool) CmdrOpt

type CommandAction

type CommandAction func(cmd *cmdr.Command, args []string, mainLoop MainLoop, prefixPrefix string, opts ...Opt) (err error)

type MainLoop

type MainLoop func(ctx context.Context, conn base.Conn, done chan bool, config *base.Config)

type MainLoopHolder

type MainLoopHolder interface {
	MainLoop(ctx context.Context, conn base.Conn, done chan bool, config *base.Config)
}

type Opt

type Opt func(obj *clientObj)

func WithClientMainLoop

func WithClientMainLoop(mainLoop MainLoop) Opt

func WithClientPrefixPrefix

func WithClientPrefixPrefix(prefixPrefix string) Opt

func WithClientProtocolInterceptor

func WithClientProtocolInterceptor(fn protocol.ClientInterceptor) Opt

func WithClientUDPMode

func WithClientUDPMode(udpMode bool) Opt