gosocket

README

gosocket

About:

• A Simple Go Socket Framework

Installation:

$ go get -u github.com/golangpros/gosocket

Tutorial:

import "github.com/golangpros/gosocket"

func main() {
 	myhost := "127.0.0.1:8080"

 	ss, err := gosocket.NewSocketService(myhost)
	if err != nil {
		return
	}

	ss.SetHeartBeat(5*time.Second, 30*time.Second)

	ss.RegMessageHandler(HandleMessage)
	ss.RegConnectHandler(HandleConnect)
	ss.RegDisconnectHandler(HandleDisconnect)

	ss.Serv()
}

Thanks for contributors:

• krishpranav
• NukeWilliams

Documentation

Index

• Constants
• func Encode(msg *Message) ([]byte, error)
• type Conn
  • func NewConn(c net.Conn, hbInterval time.Duration, hbTimeout time.Duration) *Conn
  • func (c *Conn) Close()
  • func (c *Conn) GetName() string
  • func (c *Conn) SendMessage(msg *Message) error
• type Message
  • func Decode(data []byte) (*Message, error)
  • func NewMessage(msgID int32, data []byte) *Message
  • func (msg *Message) GetData() []byte
  • func (msg *Message) GetID() int32
  • func (msg *Message) String() string
  • func (msg *Message) Verify() bool
• type Session
  • func NewSession(conn *Conn) *Session
  • func (s *Session) BindUserID(uid string)
  • func (s *Session) GetConn() *Conn
  • func (s *Session) GetSessionID() string
  • func (s *Session) GetSetting(key string) interface{}
  • func (s *Session) GetUserID() string
  • func (s *Session) SetConn(conn *Conn)
  • func (s *Session) SetSetting(key string, value interface{})
• type SocketService
  • func NewSocketService(laddr string) (*SocketService, error)
  • func (s *SocketService) Broadcast(msg *Message)
  • func (s *SocketService) GetConnsCount() int
  • func (s *SocketService) GetStatus() int
  • func (s *SocketService) RegConnectHandler(handler func(*Session))
  • func (s *SocketService) RegDisconnectHandler(handler func(*Session, error))
  • func (s *SocketService) RegMessageHandler(handler func(*Session, *Message))
  • func (s *SocketService) Serv()
  • func (s *SocketService) SetHeartBeat(hbInterval time.Duration, hbTimeout time.Duration) error
  • func (s *SocketService) Stop(reason string)
  • func (s *SocketService) Unicast(sid string, msg *Message)

Constants

const (
	STUnknown = iota
	STInited
	STRunning
	STStop
)

const (
	MsgHeartbeat = iota
)

Functions

func Encode

func Encode(msg *Message) ([]byte, error)

Types

type Conn

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

func NewConn

func NewConn(c net.Conn, hbInterval time.Duration, hbTimeout time.Duration) *Conn

func (*Conn) Close

func (c *Conn) Close()

func (*Conn) GetName

func (c *Conn) GetName() string

func (*Conn) SendMessage

func (c *Conn) SendMessage(msg *Message) error

type Message

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

func Decode

func Decode(data []byte) (*Message, error)

func NewMessage

func NewMessage(msgID int32, data []byte) *Message

func (*Message) GetData

func (msg *Message) GetData() []byte

func (*Message) GetID

func (msg *Message) GetID() int32

func (*Message) String

func (msg *Message) String() string

func (*Message) Verify

func (msg *Message) Verify() bool

type Session

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

func NewSession

func NewSession(conn *Conn) *Session

func (*Session) BindUserID

func (s *Session) BindUserID(uid string)

func (*Session) GetConn

func (s *Session) GetConn() *Conn

func (*Session) GetSessionID

func (s *Session) GetSessionID() string

func (*Session) GetSetting

func (s *Session) GetSetting(key string) interface{}

func (*Session) GetUserID

func (s *Session) GetUserID() string

func (*Session) SetConn

func (s *Session) SetConn(conn *Conn)

func (*Session) SetSetting

func (s *Session) SetSetting(key string, value interface{})

type SocketService

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

func NewSocketService

func NewSocketService(laddr string) (*SocketService, error)

func (*SocketService) Broadcast

func (s *SocketService) Broadcast(msg *Message)

func (*SocketService) GetConnsCount

func (s *SocketService) GetConnsCount() int

func (*SocketService) GetStatus

func (s *SocketService) GetStatus() int

func (*SocketService) RegConnectHandler

func (s *SocketService) RegConnectHandler(handler func(*Session))

func (*SocketService) RegDisconnectHandler

func (s *SocketService) RegDisconnectHandler(handler func(*Session, error))

func (*SocketService) RegMessageHandler

func (s *SocketService) RegMessageHandler(handler func(*Session, *Message))

func (*SocketService) Serv

func (s *SocketService) Serv()

func (*SocketService) SetHeartBeat

func (s *SocketService) SetHeartBeat(hbInterval time.Duration, hbTimeout time.Duration) error

func (*SocketService) Stop

func (s *SocketService) Stop(reason string)

func (*SocketService) Unicast

func (s *SocketService) Unicast(sid string, msg *Message)