terminalbot

package

v0.0.0-...-10acafb Latest Latest Go to latest Published: Mar 29, 2022 License: Apache-2.0 Imports: 13 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

This section is empty.

This section is empty.

This section is empty.

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

TerminalBot Is the terminal running bot

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

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

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

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 (t TerminalBot) NewRedShirt(ctx context.Context, cap *botpb.Capability) (*botpb.Registration, error)

NewRedShirt registers this shirt with the bot

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 (t *TerminalBot) Run()

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 (t TerminalBot) SendStream(stream botpb.Riker_SendStreamServer) error

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