ngs

Documentation

Index

• Constants
• Variables
• func Listen(addr string, opts ...Option)
• func Shutdown()
• type Group
  • func NewGroup(n string) *Group
  • func (c *Group) Add(session *session.Session) error
  • func (c *Group) Broadcast(route string, v interface{}) error
  • func (c *Group) Close() error
  • func (c *Group) Contains(uid int64) bool
  • func (c *Group) Count() int
  • func (c *Group) Leave(s *session.Session) error
  • func (c *Group) LeaveAll() error
  • func (c *Group) Member(uid int64) (*session.Session, error)
  • func (c *Group) MemberBySID(id int64) (*session.Session, error)
  • func (c *Group) MemberUIDs() []int64
  • func (c *Group) Members() []*session.Session
  • func (c *Group) Multicast(route string, v interface{}, filter SessionFilter) error
  • func (c *Group) PeekMembers(fn func(sId int64, s *session.Session) bool)
• type Option
  • func WithAdvertiseAddr(addr string, retryInterval ...time.Duration) Option
  • func WithCheckOriginFunc(fn func(*http.Request) bool) Option
  • func WithClientAddr(addr string) Option
  • func WithComponents(components *component.Components) Option
  • func WithDebugMode() Option
  • func WithDictionary(dict map[string]uint16) Option
  • func WithGrpcOptions(opts ...grpc.DialOption) Option
  • func WithHandshakeValidator(fn func([]byte) error) Option
  • func WithHeartbeatInterval(d time.Duration) Option
  • func WithIsWebsocket(enableWs bool) Option
  • func WithLabel(label string) Option
  • func WithLogger(l log.Logger) Option
  • func WithMaster() Option
  • func WithPipeline(pipeline pipeline.Pipeline) Option
  • func WithSerializer(serializer serialize.Serializer) Option
  • func WithTSLConfig(certificate, key string) Option
  • func WithTimerPrecision(precision time.Duration) Option
  • func WithWSPath(path string) Option
• type SessionFilter

Constants

const VERSION = "1.0.2"

VERSION returns current ngs version

Variables

var (
	ErrCloseClosedGroup   = errors.New("close closed group")
	ErrClosedGroup        = errors.New("group closed")
	ErrMemberNotFound     = errors.New("member not found in the group")
	ErrSessionDuplication = errors.New("session has existed in the current group")
)

Errors that could be occurred during message handling.

Functions

func Listen

func Listen(addr string, opts ...Option)

Listen listens on the TCP network address addr and then calls Serve with handler to handle requests on incoming connections.

func Shutdown

func Shutdown()

Shutdown send a signal to let 'ngs' shutdown itself.

Types

type Group

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

Group represents a session group which used to manage a number of sessions, data send to the group will send to all session in it.

func NewGroup

func NewGroup(n string) *Group

NewGroup returns a new group instance

func (*Group) Add

func (c *Group) Add(session *session.Session) error

Add add session to group

func (*Group) Broadcast

func (c *Group) Broadcast(route string, v interface{}) error

Broadcast push the message(s) to all members

func (*Group) Close

func (c *Group) Close() error

Close destroy group, which will release all resource in the group

func (*Group) Contains

func (c *Group) Contains(uid int64) bool

Contains check whether a UID is contained in current group or not

func (*Group) Count

func (c *Group) Count() int

Count get current member amount in the group

func (*Group) Leave

func (c *Group) Leave(s *session.Session) error

Leave remove specified UID related session from group

func (*Group) LeaveAll

func (c *Group) LeaveAll() error

LeaveAll clear all sessions in the group

func (*Group) Member

func (c *Group) Member(uid int64) (*session.Session, error)

Member returns specified UID's session

func (*Group) MemberBySID

func (c *Group) MemberBySID(id int64) (*session.Session, error)

MemberBySID returns specified sId's session

func (*Group) MemberUIDs

func (c *Group) MemberUIDs() []int64

MemberUIDs returns all member's UID in current group

func (*Group) Members

func (c *Group) Members() []*session.Session

func (*Group) Multicast

func (c *Group) Multicast(route string, v interface{}, filter SessionFilter) error

Multicast push the message to the filtered clients

func (*Group) PeekMembers

func (c *Group) PeekMembers(fn func(sId int64, s *session.Session) bool)

PeekMembers returns all members in current group

type Option

type Option func(*cluster.Options)

func WithAdvertiseAddr

func WithAdvertiseAddr(addr string, retryInterval ...time.Duration) Option

WithAdvertiseAddr sets the advertisement address option, it will be the listen address in master node and an advertisement address which cluster member to connect

func WithCheckOriginFunc

func WithCheckOriginFunc(fn func(*http.Request) bool) Option

WithCheckOriginFunc sets the function that check `Origin` in http headers

func WithClientAddr

func WithClientAddr(addr string) Option

WithClientAddr sets the listen address which is used to establish connection between cluster members. Will select an available port automatically if no member address setting and panic if no available port

func WithComponents

func WithComponents(components *component.Components) Option

WithComponents sets the Components

func WithDebugMode

func WithDebugMode() Option

WithDebugMode let 'ngs' to run under Debug mode.

func WithDictionary

func WithDictionary(dict map[string]uint16) Option

WithDictionary sets routes map

func WithGrpcOptions

func WithGrpcOptions(opts ...grpc.DialOption) Option

WithGrpcOptions sets the grpc dial options

func WithHandshakeValidator

func WithHandshakeValidator(fn func([]byte) error) Option

WithHandshakeValidator sets the function that Verify `handshake` data

func WithHeartbeatInterval

func WithHeartbeatInterval(d time.Duration) Option

WithHeartbeatInterval sets Heartbeat time interval

func WithIsWebsocket

func WithIsWebsocket(enableWs bool) Option

WithIsWebsocket indicates whether current node WebSocket is enabled

func WithLabel

func WithLabel(label string) Option

WithLabel sets the current node label in cluster

func WithLogger

func WithLogger(l log.Logger) Option

WithLogger overrides the default logger

func WithMaster

func WithMaster() Option

WithMaster sets the option to indicate whether the current node is master node

func WithPipeline

func WithPipeline(pipeline pipeline.Pipeline) Option

func WithSerializer

func WithSerializer(serializer serialize.Serializer) Option

WithSerializer customizes application serializer, which automatically Marshal and UnMarshal handler payload

func WithTSLConfig

func WithTSLConfig(certificate, key string) Option

WithTSLConfig sets the `key` and `certificate` of TSL

func WithTimerPrecision

func WithTimerPrecision(precision time.Duration) Option

WithTimerPrecision sets the ticker precision, and time precision can not less than a Millisecond, and can not change after application running. The default precision is time.Second

func WithWSPath

func WithWSPath(path string) Option

type SessionFilter

type SessionFilter func(*session.Session) bool

SessionFilter represents a filter which was used to filter session when Multicast, the session will receive the message while filter returns true.