cellnet

README

CellNet

A Golang game server framework based on actor model

Feature

本机,跨进程,跨机器通信均使用统一的Actor模型 为游戏服务器优化, 注重开发效率及运行效率

Roadmap

RPC支持 服务器框架例子 服务器可视化部署工具

Dependencies

github.com/golang/protobuf/proto

github.com/BurntSushi/toml

Example

=================================

Hello world

cid := cellnet.Spawn(func(_ cellnet.CellID, cl interface{}) {

	switch v := cl.(type) {
	case string:
		log.Println(v)
	}

})

cellnet.Send(cid, "hello world ")

Client & server with message dispatcher

func server() {

	disp := dispatcher.NewPacketDispatcher()

	dispatcher.RegisterMessage(disp, coredef.TestEchoACK{}, func(ses cellnet.CellID, content interface{}) {
		msg := content.(*coredef.TestEchoACK)

		log.Println("server recv:", msg.String())

		cellnet.Send(ses, &coredef.TestEchoACK{
			Content: proto.String("world"),
		})
	})

	ltvsocket.SpawnAcceptor("127.0.0.1:8001", dispatcher.PeerHandler(disp))
}

func client() {

	disp := dispatcher.NewPacketDispatcher()

	dispatcher.RegisterMessage(disp, coredef.TestEchoACK{}, func(ses cellnet.CellID, content interface{}) {
		msg := content.(*coredef.TestEchoACK)

		log.Println("client recv:", msg.String())

	})

	dispatcher.RegisterMessage(disp, coredef.ConnectedACK{}, func(ses cellnet.CellID, content interface{}) {
		cellnet.Send(ses, &coredef.TestEchoACK{
			Content: proto.String("hello"),
		})
	})

	ltvsocket.SpawnConnector("127.0.0.1:8001", dispatcher.PeerHandler(disp))

}

Contact

博客: http://www.cppblog.com/sunicdavy

知乎: http://www.zhihu.com/people/xu-bo-62-87

技术讨论组: 309800774 加群请说明cellnet

邮箱: sunicdavy@qq.com

Documentation

Index

• Variables
• func GetModuleEntry(name string) func()
• func GetStackInfo(skip int) (string, int)
• func GetStackInfoString(skip int) string
• func IsLocal(id CellID) bool
• func Name2ID(name string) int
• func ParsePacket(pkt *Packet, msgType reflect.Type) (interface{}, error)
• func ReadConfig(data interface{})
• func ReflectContent(d interface{}) string
• func ReflectProtoName(msg proto.Message) string
• func RegisterModuleEntry(entry func())
• func Send(target CellID, data interface{}) bool
• func SendLocal(target CellID, data interface{}) bool
• func SetContentReflector(r ContentReflector)
• func SetExpressDriver(driver func(CellID, interface{}) bool)
• func StartModule()
• func StringHashNoCase(s string) uint32
• func StripFileName(filename string, part int) string
• func Type2ID(msg proto.Message) int
• type CellID
  • func NewCellID(region, index int32) CellID
  • func Spawn(callback func(CellID, interface{})) CellID
  • func (self CellID) Index() int32
  • func (self CellID) Region() int32
  • func (self CellID) String() string
  • func (self CellID) Valid() bool
• type ContentReflector
  • func GetContentReflector() ContentReflector
• type EventDispatcher
  • func NewEventDispatcher() *EventDispatcher
  • func (self *EventDispatcher) Add(name string, callback func(...interface{}))
  • func (self *EventDispatcher) Clear()
  • func (self *EventDispatcher) Invoke(name string, args ...interface{})
  • func (self *EventDispatcher) Remove(name string, callback func(...interface{}))
• type EventInit
• type IPacketStream
• type Packet
  • func BuildPacket(msg proto.Message) *Packet

Variables

var (
	// 本进程的ID
	RegionID int32
)

Functions

func GetModuleEntry

func GetModuleEntry(name string) func()

func GetStackInfo

func GetStackInfo(skip int) (string, int)

获取当前调用信息

func GetStackInfoString

func GetStackInfoString(skip int) string

func IsLocal

func IsLocal(id CellID) bool

CellID是否为本进程内的ID

func Name2ID

func Name2ID(name string) int

func ParsePacket

func ParsePacket(pkt *Packet, msgType reflect.Type) (interface{}, error)

func ReadConfig

func ReadConfig(data interface{})

func ReflectContent

func ReflectContent(d interface{}) string

func ReflectProtoName

func ReflectProtoName(msg proto.Message) string

func RegisterModuleEntry

func RegisterModuleEntry(entry func())

func Send

func Send(target CellID, data interface{}) bool

将制定内容发送到target的Cell中

func SendLocal

func SendLocal(target CellID, data interface{}) bool

将制定内容发送到本地的target的Cell中

func SetContentReflector

func SetContentReflector(r ContentReflector)

设置内容解析器

func SetExpressDriver

func SetExpressDriver(driver func(CellID, interface{}) bool)

设置快递驱动, 负责将给定内容跨进程送达

func StartModule

func StartModule()

func StringHashNoCase

func StringHashNoCase(s string) uint32

字符串转为32位整形值

func StripFileName

func StripFileName(filename string, part int) string

将绝对路径按需要的节从右压缩 例如: c:/Develop/nucleus.git/server/src/core/util/stack.go中 当cStripPathSection=3 返回 core/util/stack.go

func Type2ID

func Type2ID(msg proto.Message) int

Types

type CellID

type CellID int64

func NewCellID

func NewCellID(region, index int32) CellID

func Spawn

func Spawn(callback func(CellID, interface{})) CellID

为消息处理函数生成一个Cell, 返回CellID

func (CellID) Index

func (self CellID) Index() int32

func (CellID) Region

func (self CellID) Region() int32

func (CellID) String

func (self CellID) String() string

func (CellID) Valid

func (self CellID) Valid() bool

type ContentReflector

type ContentReflector interface {
	Reflect(interface{}) string
}

func GetContentReflector

func GetContentReflector() ContentReflector

获取内容解析器

type EventDispatcher

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

func NewEventDispatcher

func NewEventDispatcher() *EventDispatcher

func (*EventDispatcher) Add

func (self *EventDispatcher) Add(name string, callback func(...interface{}))

func (*EventDispatcher) Clear

func (self *EventDispatcher) Clear()

func (*EventDispatcher) Invoke

func (self *EventDispatcher) Invoke(name string, args ...interface{})

func (*EventDispatcher) Remove

func (self *EventDispatcher) Remove(name string, callback func(...interface{}))

type EventInit

type EventInit struct {
}

type IPacketStream

type IPacketStream interface {
	Read() (*Packet, error)
	Write(pkt *Packet) error
	Close() error
}

封包流

type Packet

type Packet struct {
	MsgID uint32 // 消息ID
	Data  []byte
}

私有协议封包

func BuildPacket

func BuildPacket(msg proto.Message) *Packet

消息到封包