chc

Documentation

Index

• type InitRoom
• type Message
• type Room
• type User

Types

type InitRoom

type InitRoom struct {
	// creating ? Name : Token
	Data     string `json:"d"`
	Password string
}

type Message

type Message struct {
	// The type of the message:
	//  1 (welcome)
	//  100 (text message)
	//  200 (create room), 210 (user join), 211 (user leave),
	//    212 (delete room)
	//  300 (status change)
	//  400 (ok), 401 (unauthorized), 404 (not found)
	Type int `json:"op"`

	Data interface{} `json:"d"`

	Token  string `json:"tkn"`
	RoomID string `json:"rid"`
}

Message is a JSON packet sent both by the server and clients. See Type.

type Room

type Room struct {
	// The room's name formatted to be
	// valid in a URL.
	ID string

	Name     string
	Password string

	// The room owner's ID.
	OwnerID string

	// This is a map of IDs so users can easily
	// be fetched.
	Users map[string]*User `json:"-"`
}

type User

type User struct {
	// The user's connection to the websocket.
	Conn *websocket.Conn `json:"-"`

	Token string
	Name  string

	// All the IDs of rooms this user is a part of.
	Rooms []string
}