data

type Channel ¶

type Channel struct {
	Name       string
	Connection Connection

	Topic    string
	Presence Presence
	Mode     string
}

Channel represents the state of a user's presence in a channel.

type ChannelState ¶

type ChannelState struct {
	Network, Channel string
	Presence         Presence
	// TODO: This representation is incorrect.
	// A user's mode is for the network, not to the channel.
	ChannelMode, UserMode string

	Topic   string
	Members int

	Unread      int
	LastMessage Event
}

ChannelState summarizes the state of a channel.

type Connection ¶

type Connection struct {
	Network string
	Nick    string
	State   ConnectionState
}

Connection represents a user's relation with an IRC network.

type ConnectionState ¶

type ConnectionState int

ConnectionState represents the status of a user's connection to an IRC network.

const (
	Disconnected ConnectionState = iota
	Connecting
	Connected
)

type Event ¶

type Event struct {
	EventID

	Contents string
}

An Event represents an event in IRC, e.g. a message.

func (e *Event) String() string

type EventID ¶

type EventID struct {
	Epoch int
	Seq   uint
}

An EventID is a unique, sequenceable identifier for an event. Within a scope, e.g. a channel, events are lexicographically ordered- by epoch, then by sequence. An Epoch may be ticked over when a log file rolls over, when a server disconnects, or in other circumstances. Usually, it represents when there was a potential discontinuity in events. Epochs may be negative because they may extend indefinitely into the past, e.g. via logfiles or an external log server.

type EventList ¶

type EventList []Event

func NewEvents(es []Event) EventList

func (e EventList) Len() int

func (e EventList) Less(i, j int) bool

func (e EventList) SelectMinMax(min, max EventID) []Event

func (e EventList) SelectMinSize(min EventID, n uint) []Event

func (e EventList) SelectSize(n uint) []Event

func (e EventList) SelectSizeMax(n uint, max EventID) []Event

func (e EventList) Swap(i, j int)

type Events ¶

type Events interface {
	SelectSize(uint) []Event
	SelectSizeMax(uint, EventID) []Event
	SelectMinSize(EventID, uint) []Event
	SelectMinMax(EventID, EventID) []Event
}

type NetworkState ¶

type NetworkState struct {
	Network, Nick string
	State         ConnectionState
	// TODO: make UserMode and ChannelMode their own types
	UserMode string
}

type Presence ¶

type Presence int

Presence is a user's presence, or lack thereof, in a channel.

const (
	NotPresent Presence = iota
	Joined
)