zero

README

zero

A Lightweight Socket Service with heartbeat, Can be easily used in TCP server development.

Wiki Page https://github.com/smtp-http/zero/wiki

Requirements

Go version: 1.9.x or later

Usage

go get -u github.com/smtp-http/zero

import "github.com/smtp-http/zero"

func main() {
 	host := "127.0.0.1:18787"

 	ss, err := zero.NewSocketService(host)
	if err != nil {
		return
	}

	// set Heartbeat
	ss.SetHeartBeat(5*time.Second, 30*time.Second)

	// net event
	ss.RegMessageHandler(HandleMessage)
	ss.RegConnectHandler(HandleConnect)
	ss.RegDisconnectHandler(HandleDisconnect)

	ss.Serv()
}

Example Code: https://github.com/smtp-http/zero/blob/master/service_test.go

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) SendBytes(msg []byte) error
  • 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 Unknown
	STUnknown = iota
	// STInited Inited
	STInited
	// STRunning Running
	STRunning
	// STStop Stop
	STStop
)

const (
	// MsgHeartbeat heartbeat
	MsgHeartbeat = iota
)

Functions

func Encode

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

Encode from Message to []byte

Types

type Conn

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

Conn wrap net.Conn

func NewConn

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

NewConn create new conn

func (*Conn) Close

func (c *Conn) Close()

Close close connection

func (*Conn) GetName

func (c *Conn) GetName() string

GetName Get conn name

func (*Conn) SendBytes

func (c *Conn) SendBytes(msg []byte) error

SendBytes send []byte

func (*Conn) SendMessage

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

SendMessage send message

type Message

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

Message struct

func Decode

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

Decode from []byte to Message

func NewMessage

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

NewMessage create a new message

func (*Message) GetData

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

GetData get message data

func (*Message) GetID

func (msg *Message) GetID() int32

GetID get message ID

func (*Message) String

func (msg *Message) String() string

func (*Message) Verify

func (msg *Message) Verify() bool

Verify verify checksum

type Session

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

Session struct

func NewSession

func NewSession(conn *Conn) *Session

NewSession create a new session

func (*Session) BindUserID

func (s *Session) BindUserID(uid string)

BindUserID bind a user ID to session

func (*Session) GetConn

func (s *Session) GetConn() *Conn

GetConn get zero.Conn pointer

func (*Session) GetSessionID

func (s *Session) GetSessionID() string

GetSessionID get session ID

func (*Session) GetSetting

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

GetSetting get setting

func (*Session) GetUserID

func (s *Session) GetUserID() string

GetUserID get user ID

func (*Session) SetConn

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

SetConn set a zero.Conn to session

func (*Session) SetSetting

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

SetSetting set setting

type SocketService

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

SocketService struct

func NewSocketService

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

NewSocketService create a new socket service

func (*SocketService) Broadcast

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

Broadcast Broadcast to all connections

func (*SocketService) GetConnsCount

func (s *SocketService) GetConnsCount() int

GetConnsCount get connect count

func (*SocketService) GetStatus

func (s *SocketService) GetStatus() int

GetStatus get socket service status

func (*SocketService) RegConnectHandler

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

RegConnectHandler register connect handler

func (*SocketService) RegDisconnectHandler

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

RegDisconnectHandler register disconnect handler

func (*SocketService) RegMessageHandler

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

RegMessageHandler register message handler

func (*SocketService) Serv

func (s *SocketService) Serv()

Serv Start socket service

func (*SocketService) SetHeartBeat

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

SetHeartBeat set heart beat

func (*SocketService) Stop

func (s *SocketService) Stop(reason string)

Stop stop socket service with reason

func (*SocketService) Unicast

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

Unicast Unicast with session ID