terminalbot

Documentation

Index

• type TerminalBot
  • func New(addr string, nickname string, groups []string) *TerminalBot
  • func (t *TerminalBot) ChatSend(msg, channel string)
  • func (t TerminalBot) CommandStream(reg *botpb.Registration, stream botpb.Riker_CommandStreamServer) error
  • func (t TerminalBot) NewRedShirt(ctx context.Context, cap *botpb.Capability) (*botpb.Registration, error)
  • func (t TerminalBot) NextCommand(ctx context.Context, reg *botpb.Registration) (*botpb.Message, error)
  • func (t *TerminalBot) Run()
  • func (t TerminalBot) Send(ctx context.Context, msg *botpb.Message) (*botpb.SendResponse, error)
  • func (t TerminalBot) SendStream(stream botpb.Riker_SendStreamServer) error

Types

type TerminalBot

type TerminalBot struct {
	*sync.RWMutex
	// contains filtered or unexported fields
}

TerminalBot Is the terminal running bot

func New

func New(addr string, nickname string, groups []string) *TerminalBot

func (*TerminalBot) ChatSend

func (t *TerminalBot) ChatSend(msg, channel string)

ChatSend implements the chat side of sending a message in riker for the TerminalBot

func (TerminalBot) CommandStream

func (t TerminalBot) CommandStream(reg *botpb.Registration, stream botpb.Riker_CommandStreamServer) error

CommandStream is the call a client makes to setup a Push stream from riker -> client

func (TerminalBot) NewRedShirt

func (t TerminalBot) NewRedShirt(ctx context.Context, cap *botpb.Capability) (*botpb.Registration, error)

NewRedShirt registers this shirt with the bot

func (TerminalBot) NextCommand

func (t TerminalBot) NextCommand(ctx context.Context, reg *botpb.Registration) (*botpb.Message, error)

NextCommand is the call a client makes to pull the next command from rikers command buffer

func (*TerminalBot) Run

func (t *TerminalBot) Run()

func (TerminalBot) Send

func (t TerminalBot) Send(ctx context.Context, msg *botpb.Message) (*botpb.SendResponse, error)

Send is the call a client makes to send a message back to riker

func (TerminalBot) SendStream

func (t TerminalBot) SendStream(stream botpb.Riker_SendStreamServer) error

SendStream is the call a client makes to send a stream message back to riker