goio

package module

v0.0.0-...-28e954e Latest Latest Go to latest Published: Apr 25, 2018 License: MIT Imports: 6 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

Repository

github.com/elsonwu/goio

Links

Open Source Insights

README ¶

goio

A simple long-polling module.

Client: https://github.com/Kimgils/goio-client

Documentation ¶

Index ¶

Constants
Variables
func Clients() *clients
func NewClients() *clients
func NewRooms() *rooms
func NewUsers() *users
func Rooms() *rooms
func Run()
func SendMessage(msg *Message, caller interface{})
func Users() *users
type Client
- func NewClient(user *User) *Client
type Message
type Room
- func NewRoom(roomId string) *Room
type User

Constants ¶

View Source

const (
	MsgJoin      = `join`
	MsgLeave     = `leave`
	MsgBroadcast = `broadcast`
)

Variables ¶

View Source

var GCPeriod int = 5

how many seconds to run gc

View Source

var LifeCycle int64 = 30

for client life cycle, default 30s

Functions ¶

func Clients ¶

func Clients() *clients

func NewClients ¶

func NewClients() *clients

func NewRooms ¶

func NewRooms() *rooms

func NewUsers ¶

func NewUsers() *users

func Rooms ¶

func Rooms() *rooms

func Run ¶

func Run()

func SendMessage ¶

func SendMessage(msg *Message, caller interface{})

func Users ¶

func Users() *users

Types ¶

type Client ¶

type Client struct {
	Id   string
	User *User
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(user *User) *Client

func (*Client) IsDead ¶

func (c *Client) IsDead() bool

func (*Client) Ping ¶

func (c *Client) Ping()

func (*Client) ReadMessages ¶

func (c *Client) ReadMessages() []*Message

func (*Client) SetIsDead ¶

func (c *Client) SetIsDead()

type Message ¶

type Message struct {
	EventName string `json:"e"` // join/leave/broadcast/connect
	Data      string `json:"d"`
	RoomId    string `json:"r"`
	CallerId  string `json:"c"`
	ClientId  string `json:"-"` // don't want to output this field
}

type Room ¶

type Room struct {
	Id string
	// contains filtered or unexported fields
}

func NewRoom ¶

func NewRoom(roomId string) *Room

func (*Room) IsDead ¶

func (r *Room) IsDead() bool

func (*Room) UserCount ¶

func (r *Room) UserCount() int

func (*Room) UserIds ¶

func (r *Room) UserIds() []string

type User ¶

type User struct {
	Id string
	// contains filtered or unexported fields
}

func (*User) AddClt ¶

func (u *User) AddClt(clt *Client)

func (*User) AddData ¶

func (u *User) AddData(k string, v string)

func (*User) AddRoom ¶

func (u *User) AddRoom(room *Room)

func (*User) ClientCount ¶

func (u *User) ClientCount() int

func (*User) DelClt ¶

func (u *User) DelClt(clientId string)

func (*User) DelRoom ¶

func (u *User) DelRoom(roomId string)

func (*User) GetData ¶

func (u *User) GetData(key string) string

func (*User) IsDead ¶

func (u *User) IsDead() bool

func (*User) Rooms ¶

func (u *User) Rooms() map[string]*Room

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
app

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL