cui

package

v1.2.0 Latest Latest Go to latest Published: Apr 11, 2016 License: MIT Imports: 10 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.

func AddCommand(msg common.Message)

Adds a command to logger

func AddGroup(groupName string, users []string)

Adds group to chatMap

func AddMessage(msg common.Message)

Formats and adds message to logger

func AddUser(user string)

Adds user to chatMap

func CUIConsole(ccChan *logger.ChanChanMessage)

Create a CUI Console for logging

func QuitCUI()

Quits CUI

func RemoveUser(user string)

Removes user from usermap

func SetCreateConn(f common.CreateConnFunc)

Sets the chat function for creating connection

func SetSendMessage(f common.SendMessageFunc)

Sets the chat function for sending message

func StartCUI()

type Chat struct {
	History []ChatMessage
	Name    string
	Users   []string
}

Chat struct for chatMap

type ChatMessage struct {
	*common.Message
	Read bool
}

Chat Message that extends the main message to see if user has read the message

type Command struct {
	Regex    *regexp.Regexp
	Command  string
	Desc     string
	Args     string
	Example  []string
	Callback CommandCallback
}

type CommandCallback func(line string, args []string)

Callback for when a command is called