nano

README

Nano

Nano is an easy to use, fast, lightweight game server networking library for Go. It provides a core network architecture and a series of tools and libraries that can help developers eliminate boring duplicate work for common underlying logic. The goal of nano is to improve development efficiency by eliminating the need to spend time on repetitious network related programming.

Nano was designed for server-side applications like real-time games, social games, mobile games, etc of all sizes.

How to build a system with Nano

What does a Nano application look like?

The simplest "nano" application as shown in the following figure, you can make powerful applications by combining different components.

In fact, the nano application is a collection of  Component , and a component is a bundle of  Handler, once you register a component to nano, nano will register all methods that can be converted to Handler to nano service container. Service was accessed by Component.Handler, and the handler will be called while client request. The handler will receive two parameters while handling a message:

• *session.Session: corresponding a client that apply this request or notify.
• *protocol.FooBar: the payload of the request.

While you had processed your logic, you can response or push message to the client by session.Response(payload) and session.Push('eventName', payload), or returns error when some unexpected data received.

How to build distributed system with Nano

Nano contains built-in distributed system solution, and make you creating a distributed game server easily.

See: The distributed chat demo

The Nano will remain simple, but you can perform any operations in the component and get the desired goals. You can startup a group of Nano application as agent to dispatch message to backend servers.

How to execute the asynchronous task

func (manager *PlayerManager) Login(s *session.Session, msg *ReqPlayerLogin) error {
    var onDBResult = func(player *Player) {
        manager.players = append(manager.players, player)
        s.Push("PlayerSystem.LoginSuccess", &ResPlayerLogin)
    }
    
    // run slow task in new gorontine
    go func() {
        player, err := db.QueryPlayer(msg.PlayerId) // ignore error in demo
        // handle result in main logical gorontine
        nano.Invoke(func(){ onDBResult(player) })
    }
    return nil
}

Documents

• English

  • How to build your first nano application
  • Route compression
  • Communication protocol
  • Design patterns
  • API Reference(Server)
  • How to integrate Lua into Nano component(incomplete)

• 简体中文

  • 如何构建你的第一个nano应用
  • 路由压缩
  • 通信协议
  • API参考(服务器)
  • 如何将lua脚本集成到nano组件中(未完成)

Resources

• Javascript

  • nano-websocket-client
  • nano-egret-client

• Typescript/cocos-creator

  • nano-client-ts

• Demo

  • Implement a chat room in 100 lines with nano and WebSocket
  • Tadpole demo
  • 四川麻将, 血战到底(三人模式/四人模式)完整项目实例

Community

• QQGroup: 289680347
• Reddit: nanolabs

Successful cases

• 空来血战

Go version

> go1.8

Installation

go get github.com/lonng/nano

# dependencies
go get -u github.com/pingcap/check
go get -u github.com/pingcap/errors
go get -u github.com/urfave/cli

go get -u google.golang.org/protobuf/proto
go get -u github.com/gorilla/websocket
go get -u google.golang.org/grpc

Protocol Buffers

# protoc
# download form: https://github.com/protocolbuffers/protobuf/releases
# protoc-gen-go
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
# delve
go install github.com/go-delve/delve/cmd/dlv@latest

Test

go test -v ./...

Benchmark

# Case:   PingPong
# OS:     Windows 10
# Device: i5-6500 3.2GHz 4 Core/1000-Concurrent   => IOPS 11W(Average)
# Other:  ...

cd ./benchmark/io
go test -v -tags "benchmark"

License

MIT License

Documentation

Index

• 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) Members() []int64
  • func (c *Group) Multicast(route string, v interface{}, filter SessionFilter) error
• 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 WithCustomerRemoteServiceRoute(route cluster.CustomerRemoteServiceRoute) 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 WithNodeId(nodeId uint64) 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 WithUnregisterCallback(fn func(member cluster.Member)) Option
  • func WithWSPath(path string) Option
• type SessionFilter

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.

var VERSION = "0.5.0"

VERSION returns current nano version

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 'nano' 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) Members

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

Members returns all member's UID in current group

func (*Group) Multicast

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

Multicast push the message to the filtered clients

type Option

type Option func(*cluster.Options)

func WithAdvertiseAddr

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

WithAdvertiseAddr sets the advertise address option, it will be the listen address in master node and an advertise 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

WithMemberAddr 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 WithCustomerRemoteServiceRoute

func WithCustomerRemoteServiceRoute(route cluster.CustomerRemoteServiceRoute) Option

WithCustomerRemoteServiceRoute register remote service route

func WithDebugMode

func WithDebugMode() Option

WithDebugMode let 'nano' to run under Debug mode.

func WithDictionary

func WithDictionary(dict map[string]uint16) Option

SetDictionary 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 WithNodeId

func WithNodeId(nodeId uint64) Option

WithNodeId set nodeId use snowflake nodeId generate sessionId, default: pid

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

SetTimerPrecision 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 WithUnregisterCallback

func WithUnregisterCallback(fn func(member cluster.Member)) Option

WithUnregisterCallback master unregister member event call fn

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.