firehose

Documentation

Overview

Package firehose is used for twitch's firehose

Index

• Constants
• type Firehose
  • func (f *Firehose) Connect(token string) (messageQueue chan Message, err error)
  • func (f *Firehose) Disconnect()
• type Message

Constants

const AppName string = "goPurple/firehose"

AppName is the name of the application

const FullVersion string = AppName + VersionMajor + "." + VersionMinor + VersionBuild

FullVersion contains the full name and version of this package in a printable string

const VersionBuild string = "s"

VersionBuild is the type of this release. s(table), b(eta), d(evelopment), n(ightly)

const VersionMajor string = "0"

VersionMajor 0 means in development, >1 ensures compatibility with each minor version, but breakes with new major version

const VersionMinor string = "1"

VersionMinor introduces changes that require a new version number. If the major version is 0, they are likely to break compatibility

Types

type Firehose

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

Firehose offers an interface to twitch tmi's firehose. Use with caution.

func (*Firehose) Connect

func (f *Firehose) Connect(token string) (messageQueue chan Message, err error)

Connect to Firehose with given OAuth token

func (*Firehose) Disconnect

func (f *Firehose) Disconnect()

Disconnect from firehose

type Message

type Message struct {
	Command string            `json:"command"`
	Room    string            `json:"room"`
	Nick    string            `json:"nick"`
	Target  string            `json:"target"`
	Body    string            `json:"body"`
	Tags    map[string]string `json:"tags"`
	Raw     string
}

Message is the Firehose version of an IRC message