chat

README

gochat

Asyncronous chat engine in Go, supports websocket and HTTP longpoll APIs.

Documentation

Index

• Constants
• func SendData(ch chan Message, data Message)
• type Conn
• type ConnType
• type Decoder
• type Engine
  • func NewEngine(config EngineConfig) Engine
• type EngineConfig
• type Message
• type Object
• type Room
• type Send
• type Subscriber
• type Uid

Constants

const (
	Unknown                  = iota
	Websocket       ConnType = iota
	LongpollingPull          = iota
	LongpollingPush          = iota
)

Functions

func SendData

func SendData(ch chan Message, data Message)

Types

type Conn

type Conn interface {
	Send
	Request() *http.Request
	Cid() Uid
}

type ConnType

type ConnType int

type Decoder

type Decoder interface {
	Decode() (Message, error)
	Encode(msg Message) ([]byte, error)
}

type Engine

type Engine interface {
	Send
	http.Handler
	GetRoom(name Uid) Room
	AddRoom(name Uid) Room
	Config() EngineConfig
	// contains filtered or unexported methods
}

func NewEngine

func NewEngine(config EngineConfig) Engine

type EngineConfig

type EngineConfig interface {
	OnConnection(conn Conn) (*Uid, *Uid)
	OnSubscriberDisconnect(subscriber Subscriber)
	OnMessage(subscriber Subscriber, data Message)
	NewDecoder(reader *bufio.Reader) Decoder
	GetConnType(r *http.Request) ConnType
	GetLpDropTime(subscriber Subscriber) time.Duration
	GetLpWaitTime(subscriber Subscriber) time.Duration
}

type Message

type Message interface {
	GetRoom() string
	SetRoom(room string)
}

type Object

type Object interface {
	Send
	Uid() Uid
	Engine() Engine
}

type Room

type Room interface {
	Object
	Join(client Subscriber)
	Remove(client Subscriber)
	Subscribers() *map[Uid]Subscriber
	// contains filtered or unexported methods
}

type Send

type Send interface {
	Send(data Message)
}

type Subscriber

type Subscriber interface {
	Object
	Rooms() *[]Room
	// contains filtered or unexported methods
}

type Uid

type Uid string