术语说明

• game

游戏服

• lobby

大厅服

• 官方mod

存在于Apollo引擎中的mod，放在developer_mods目录下，比如处理登录相关的官方mod neteaseOnline，它在lobby/game引擎的developer_mods目录下。

game和lobby服务器事件

配置

ReloadCommonConfigEvent

• 描述

  引擎重新加载配置后触发此事件。

• 返回值

  空

• 备注

  • 目前只用于引擎，用法详情见示例Mod shutdown

服务器

MasterConnectStatusEvent

• 描述

  master成功连接到当前服务器事件.

• 参数

  参数名	数据类型	说明
  is_connect	int	1代表连接建立，0代表连接中断
  serverid	int	当前lobby/game服务器id

• 返回值

  空

• 备注

  • 用法详情见示例Mod sample

MasterForceShutDownEvent

• 描述

  强制关闭当前服务器时会触发本事件。只应用于引擎，不建议开发者使用。

• 返回值

  空

• 备注

  • 用法详情见示例Mod shutdown

MasterGraceShutDownEvent

• 描述

  优雅关闭当前服务器时会触发本事件。只应用于引擎，不建议开发者使用。

• 返回值

  空

• 备注

  • 用法详情见示例Mod shutdown

ServerWillShutDownEvent

• 描述

  游戏即将强制关闭触发本事件。事件回调函数需要好清理和存档工作，同时终止或强制join所有异步线程.

• 返回值

  空

• 备注

  • 用法详情见示例Mod neteaseDatabase

ServiceConnectEvent

• 描述

  service与lobby/game的成功建立连接事件。

• 参数

  参数名	数据类型	说明
  serverid	int	service的服务器id

• 返回值

  空

ServiceDisconnectEvent

• 描述

  service与lobby/game断开连接事件。

• 参数

  参数名	数据类型	说明
  serverid	int	service的服务器id

• 返回值

  空

ServiceRegisterModuleEvent

• 描述

  service向lobby/game注册module。只应用于引擎，不建议开发者使用。

• 参数

  参数名	数据类型	说明
  serverid	int	service服务器id
  modulename	str	模块名，是公共配置netgame_common.json中module_names中某个module

• 返回值

  空

玩家

ServerGetPlayerLockEvent

• 描述

  玩家登录到lobby/game过程中，获取玩家在线锁事件。事件触发时，玩家还处于开始登录阶段，还没有下载行为包，且没有在地图中出生。在线锁实质是redis中记录的玩家在线信息，redis key格式是“online_user_ + netease uid”，它是个hash表，包含两个hash key:serverid,proxyid。

• 参数

  参数名	数据类型	说明
  uid	int	玩家的netease uid，玩家的唯一标识
  serverid	str	当前服务器id
  proxyid	int	当前客户端连接的proxy服务器id

• 返回值

  空

• 备注

  • 目前只用于引擎，具体可以参见官方mod neteaseOnline

ServerPlayerBornPosEvent

• 描述

  创建玩家对象过程中，设置玩家出生位置时触发本事件。

• 参数

  参数名	数据类型	说明
  userId	int	玩家的netease uid
  dimensionId	int	玩家出生dimension，支持修改
  posx	int	玩家出生位置，支持修改
  posy	int	玩家出生位置，支持修改
  posz	int	玩家出生位置，支持修改
  deltax	int	玩家motion位置，初始值为存档中的数据。若修改了posx/posy/posz，则建议设置为0。
  deltay	int	玩家motion位置，初始值为存档中的数据。若修改了posx/posy/posz，则建议设置为0。
  deltaz	int	玩家motion位置，初始值为存档中的数据。若修改了posx/posy/posz，则建议设置为0。
  rotx	int	玩家的rot，初始值为存档中的数据，支持修改
  roty	int	玩家的rot，初始值为存档中的数据，支持修改
  ret	bool	是否需要修改玩家初始位置，设置为True后其他数据的修改才会生效

• 返回值

  空

• 备注

  • 可以设置出生点位置。用法详情见示例Mod sample

ServerReleasePlayerLockEvent

• 描述

  玩家下线过程中，释放在redis中的玩家在线锁事件。事件触发时，客户端同服务端断开了连接，玩家数据已经保存到地图，玩家已经不存在于mc的世界中。在线锁实质是redis中记录的玩家在线信息，redis key格式是“online_user_ + netease uid”，它是个hash表，包含两个hash key:serverid,proxyid。

• 参数

  参数名	数据类型	说明
  uid	str	玩家的netease uid，玩家的唯一标识

• 返回值

  空

• 备注

  • 目前只用于引擎，具体可以参见官方mod neteaseOnline

ServerReleasePlayerLockOnShutDownEvent

• 描述

  游戏强制关闭过程中，玩家强制下线时触发本事件。事件回调函数需要释放在redis中的玩家的在线锁。主要应用于lobby/game官方mod neteaseOnline。

• 参数

  参数名	数据类型	说明
  idx	str	事件唯一id，回调时返回
  uid	str	玩家的netease uid，玩家的唯一标识

• 返回值

  空

• 备注

  • 目前只用于引擎，具体可以参见官方mod neteaseOnline

queryPlayerDataEvent

• 描述

  玩家上线时，引擎读取玩家entity存档数据时触发本事件。不建议开发者使用本事件！只有【set_use_database_save】设置使用数据库存档后，本事件才有效。触发本事件，开发者需要从存档中读取玩家entity数据，然后通过【query_player_data_result】将修改后玩家entity数据设置回引擎。

• 参数

  参数名	数据类型	说明
  idx	str	事件唯一id，【query_player_data_result】会使用到这个id
  playerKey	str	玩家的netease uid，玩家的唯一标识
  dbname	str	数据库存档的前缀，可以通过【set_use_database_save】设置dbname

• 返回值

  空

• 备注

  • 不建议开发者使用本事件！用法详情见示例Mod neteaseDatabase

savePlayerDataEvent

• 描述

  保存玩家数据事件，玩家下线时也会触发该事件。只有【set_use_database_save】 设置useDatabase为True时，本事件才生效。本事件的回调函数必须调用【save_player_data_result】函数，把存档状态告知引擎。

• 参数

  参数名	数据类型	说明
  idx	str	引擎回调函数id，【save_player_data_result】会使用这个id
  playerKey	str	玩家的netease uid，玩家的唯一标识

• 返回值

  空

• 备注

  • 可以用于定时将玩家数据存档，用法详情见示例Mod neteaseDatabase

savePlayerDataOnShutDownEvent

• 描述

  游戏强制关闭过程中，玩家下线时会触发本事件。另外，只有【set_use_database_save】 设置useDatabase为True时，本事件才生效。本事件的回调函数必须调用【save_player_data_result】函数，把存档状态告知引擎。

• 参数

  参数名	数据类型	说明
  idx	str	引擎回调函数id，【save_player_data_result】函数会使用这个id
  playerKey	str	玩家的netease uid，玩家的唯一标识

• 返回值

  空

• 备注

  • 用于游戏关闭前把玩家数据存档，具体参见示例Mod neteaseDatabase。

master服务器事件

配置

NetGameCommonConfChangeEvent

• 描述

  master公共配置netgame_common.json发生变化时触发。比如新增或删服服务器。

• 返回值

  空

服务器

ServerConnectedEvent

• 描述

  lobby/game/proxy成功建立连接时触发。

• 参数

  参数名	数据类型	说明
  serverId	int	服务器id
  protocolVersion	int	协议版本号

• 返回值

  空

ServerDisconnectEvent

• 描述

  lobby/game/proxy断开连接时触发。

• 参数

  参数名	数据类型	说明
  serverId	int	服务器id

• 返回值

  空

玩家

PlayerLoginServerEvent

• 描述

  玩家开始登陆事件，此时master开始给玩家分配lobby/game。可以区分玩家是登录还是切服。

• 参数

  参数名	数据类型	说明
  serverId	int	客户端连接的proxy服务器id
  neteaseId	int	玩家的netease uid
  protocolVersion	int	协议版本号
  isTransfer	bool	True: 切服，False：登录

• 返回值

  空

PlayerLogoutServerEvent

• 描述

  玩家登出时触发，玩家在lobby/game下载行为包的过程中退出也会触发该事件。可以以区分玩家是登出还是切服。

• 参数

  参数名	数据类型	说明
  serverId	int	客户端连接的proxy服务器id
  neteaseId	int	玩家的netease uid
  isTransfer	bool	True: 切服，False：登出

• 返回值

  空

PlayerTransferServerEvent

• 描述

  玩家开始切服事件，此时master开始为玩家准备服务器，玩家还没切服完毕，后续可能切服失败。

• 参数

  参数名	数据类型	说明
  serverId	int	客户端连接的proxy服务器id
  neteaseId	int	玩家的netease uid
  targetServerId	int	目标lobby/game服务器id
  targetServerType	str	目标服务器类型，比如"game"或"lobby"。若targetServerId为0，则会从目标类型的多个服务器中随机选一个，作为目标服务器
  protocolVersion	int	协议版本号
  transferParam	str	切服参数。调用【TransferToOtherServer】或【TransferToOtherServerById】传入的切服参数。

• 返回值

  空

service服务器事件

配置

NetGameCommonConfChangeEvent

• 描述

  service公共配置netgame_common.json发生变化时触发。比如新增或删服服务器。

• 返回值

  空

服务器

ServerConnectedEvent

• 描述

  lobby/game/proxy成功建立连接时触发。

• 参数

  参数名	数据类型	说明
  serverId	int	服务器id
  protocolVersion	int	协议版本号

• 返回值

  空

ServerDisconnectEvent

• 描述

  lobby/game/proxy断开连接时触发。

• 参数

  参数名	数据类型	说明
  serverId	int	服务器id

• 返回值

  空

UpdateServerStatusEvent

• 描述

  lobby/game/proxy状态发生变化时触发。

• 参数

  参数名	数据类型	说明
  服务器id的字符串	str	服务器状态。服务器状态如下：‘1’ 就绪状态，‘2’ 停止状态，‘3’ 准备状态。服务器状态为'1'时，服务器才可用，其他状态下，服务器不可用。

• 返回值

  空

• 示例

  xxxxxxxxxx
  class TestService(ServiceSystem):
          def __init__(self, namespace, systemName):
          ServiceSystem.__init__(self, namespace, systemName)
          self.ListenForEvent(
                  serviceApi.GetEngineNamespace(),
                  serviceApi.GetEngineSystemName(),
                  "UpdateServerStatusEvent",
                  self,
                  self.OnUpdateServerStatusEvent)
  ​
    def OnUpdateServerStatusEvent(self, args):
            print args
            # 结果的一个示例:{'1000000':'1', '2000000':'3'}
            # 含义：服务器id为1000000的服务器正常运行，服务器id为2000000的服务器处于准备状态。
  

master API

配置

GetCommonConfig

• 描述

  获取公共配置netgame_common.json中内容，将该文件内容映射为一个dict。

• 返回值

  数据类型	说明
  dict	配置内容

• 示例

  xxxxxxxxxx
  import master.netgameApi as netMasterApi
  conf = netMasterApi.GetCommonConfig()
  serverlist = conf['serverlist'] #获取serverlist配置
  bDebugLevel = conf['log_debug_level'] #获取日志等级配置
  

• 备注

  • 取代【masterConf.netgameConf】，【masterConf.netgameConf】废弃。

IsService

• 描述

  服务器是否是service服。

• 参数

  参数名	数据类型	说明
  serverId	int	服务器id

• 返回值

  数据类型	说明
  bool	True表示是service，False不是service

• 示例

  xxxxxxxxxx
  import master.netgameApi as netMasterApi
  bService = netMasterApi.IsService(10)
  

• 备注

  • 本api取代【masterConf.isService】，【masterConf.isService】废弃。

HTTP服务器

RegisterMasterHttp

• 描述

  注册一个新的TTTP接口。

• 参数

  参数名	数据类型	说明
  url	str	接口url
  binder	instance	响应HTTP请求的实例
  func	function	响应HTTP请求的实例函数

• 返回值

  空

• 示例

  xxxxxxxxxx
  import json
  import master.masterHttp as masterHttp
  class HttpHandler(object):
          def __init__(self):
                  # 设置接口URI及回调
                  url = '/kick-user'
                  func = self.HttpTest
                  # 注册
                  masterHttp.RegisterMasterHttp(url, self, func)
  ​
          def HttpTest(self, clientId, requestBody):
                  # clientId识别请求唯一id，SendHttpResponse中要携带该参数
                  # requestBody为post body内容。如果是json格式，则可以通过下面方式加载内容。
                  # import ujson as json
                  # request = json.loads(requestBody)
                  # 返回处理结果
                  response = '{"code":0,"message":"ok"}'
                  masterHttp.SendHttpResponse(clientId, response)
  

SendHttpRequestToService

• 描述

  给service发送http请求。

• 参数

  参数名	数据类型	说明
  serverId	int	service的服务器id
  requestUrl	str	请求url，例如“/test-reqeust”
  body	str	HTTP post body，是个json字符串

• 返回值

  空

• 示例

  xxxxxxxxxx
  import json
  import master.masterHttp as masterHttp
  params = {
          "message":"content",
          "code":1
   }
  url = "/test-reqeust"
  masterHttp.SendHttpRequestToService(10, url, json.dumps(params))
  

SendHttpResponse

• 描述

  发送HTTP的Response。支持异步返回，返回时候指定请求传入的clientId。

• 参数

  参数名	数据类型	说明
  clientId	int	请求唯一id，识别HTTP请求。
  message	str	HTTP Response的内容

• 返回值

  空

• 示例

  xxxxxxxxxx
  import json
  import master.masterHttp as masterHttp
  class HttpHandler(object):
          def __init__(self):
                  # 设置接口URI及回调
                  url = '/kick-user'
                  func = self.HttpTest
                  # 注册
                  masterHttp.RegisterMasterHttp(url, self, func)
  ​
          def HttpTest(self, clientId, requestBody):
                  # clientId识别请求唯一id，SendHttpResponse中要携带该参数
                  # requestBody为post body内容。如果是json格式，则可以通过下面方式加载内容。
                  # import ujson as json
                  # request = json.loads(requestBody)
                  # 返回处理结果
                  response = '{"code":0,"message":"ok"}'
                  masterHttp.SendHttpResponse(clientId, response)
  

服务器管理

GetAllServerStatus

• 描述

  获取所有服务器的状态。只有状态2表示服务器正常服务，其他状态表示服务器不能服务。

• 返回值

  数据类型	说明
  dict	key:int类型，服务器id，value:int类型，服务器状态。服务器状态如下： 1:断开连接状态 2:已连接状态 3:关服状态 4:优雅关服状态 6, 滚动更新中间状态，即将转换到状态7 7 也是滚动更新中间状态，即将转换到状态1或2

• 示例

  xxxxxxxxxx
  import master.serverManager as serverManager
  statusDict = serverManager.GetAllServerStatus()
  

GetAllServersOnlineNum

• 描述

  获取所有服务器的在线人数。

• 返回值

  数据类型	说明
  dict	key，int类型，表示服务器id，value，int类型，表示服务器在线人数

• 示例

  xxxxxxxxxx
  import master.serverManager as serverManager
  onlineDict = serverManager.GetAllServersOnlineNum()
  

GetConnectedLobbyAndGameIds

• 描述

  获取所有已经连接的lobby/game的服务器id列表。

• 返回值

  数据类型	说明
  list	服务器id列表，服务器id是int类型。

• 示例

  xxxxxxxxxx
  import master.serverManager as serverManager
  idList = serverManager.GetConnectedLobbyAndGameIds()
  

GetOneServerStatus

• 描述

  获取服务器状态。只有状态2表示服务器正常服务，其他状态表示服务器不能服务。

• 参数

  参数名	数据类型	说明
  serverId	int	服务器id

• 返回值

  数据类型	说明
  int	服务器状态。服务器状态如下： 1:断开连接状态 2:已连接状态 3:关服状态 4:优雅关服状态 6, 滚动更新中间状态，即将转换到状态7 7 也是滚动更新中间状态，即将转换到状态1或2

• 示例

  xxxxxxxxxx
  import master.serverManager as serverManager
  status = serverManager.GetOneServerStatus(10)
  

GetOnlineNumByServerId

• 描述

  获取服务器(lobby/game/proxy)的在线人数。

• 参数

  参数名	数据类型	说明
  serverId	int	服务器id

• 返回值

  数据类型	说明
  int	在线人数

• 示例

  xxxxxxxxxx
  import master.serverManager as serverManager
  num = serverManager.GetOnlineNumByServerId(10)
  

GetServerProtocolVersion

• 描述

  获取服务器的协议版本号。多协议版本引擎中（比如同时支持1.14客户端和1.15客户端），需要把客户端分配到相同协议版本的lobby/game中。

• 参数

  参数名	数据类型	说明
  serverId	int	lobby/game服务器id

• 返回值

  数据类型	说明
  int	协议版本

• 示例

  xxxxxxxxxx
  import master.serverManager as serverManager
  version = serverManager.GetServerProtocolVersion(10)
  

GetTotalOnlineNum

• 描述

  获取总得在线人数。

• 返回值

  数据类型	说明
  int	在线人数

• 示例

  xxxxxxxxxx
  import master.serverManager as serverManager
  num = serverManager.GetTotalOnlineNum()
  

IsConnectedServer

• 描述

  master是否与lobby/game/proxy建立连接。

• 参数

  参数名	数据类型	说明
  serverId	int	服务器id

• 返回值

  数据类型	说明
  bool	True，已经建立连接;False未建立连接

• 示例

  xxxxxxxxxx
  import master.serverManager as serverManager
  bConnect = serverManager.IsConnectedServer(10)
  

IsValidServer

• 描述

  服务器是否有效。一种用途：master将玩家分配到服务器之前，会检查服务器是否有效，避免把玩家分配到一个即将关闭的服务器中。

• 参数

  参数名	数据类型	说明
  serverId	int	服务器id

• 返回值

  数据类型	说明
  bool	True，master已经同服务器建立链接，且服务器正在提供服务，不是即将关闭的服务。

• 示例

  xxxxxxxxxx
  import master.serverManager as serverManager
  bValid = serverManager.IsValidServer(10)
  

StopServerByServerid

• 描述

  关闭某个服务器。

• 参数

  参数名	数据类型	说明
  serverId	int	proxy/lobby/game服务器id
  actType	int	1:强制踢出所有玩家后关服;2:等待所有玩家退出后关服

• 返回值

  空

• 示例

  xxxxxxxxxx
  import master.serverManager as serverManager
  serverManager.StopServerByServerid(10, 2)
  

service API

配置

GetCommonConfig

• 描述

  获取公共配置netgame_common.json中内容，将该文件内容映射为一个dict。

• 返回值

  数据类型	说明
  dict	配置内容

• 示例

  xxxxxxxxxx
  import service.netgameApi as netServiceApi
  conf = netServiceApi.GetCommonConfig()
  serverlist = conf['serverlist'] #获取serverlist配置
  serverlist = conf['log_debug_level'] #获取日志等级配置
  

• 备注

  • 取代【serviceConf.netgameConf】，【serviceConf.netgameConf】废弃。

GetServerId

• 描述

  获取服务器id。

• 返回值

  数据类型	说明
  int	服务器id，对应netgame_common.json中配置的serverid

• 示例

  xxxxxxxxxx
  import service.netgameApi as netServiceApi
  serverId = netServiceApi.GetServerId()
  

GetServiceConfig

• 描述

  获取service配置，该配置对应公共配置netgame_common.json中servicelist下对应service的配置。

• 返回值

  数据类型	说明
  dict	配置内容

• 示例

  xxxxxxxxxx
  import service.netgameApi as netServiceApi
  serviceConf = netServiceApi.GetServiceConfig()
  print serviceConf
  # 结果实例如下：
  # {
  #     "app_type": "service", 
  #     "app_version": "1.15.0.release20191128", 
  #     "http_port": 8520, 
  #     "ip": "127.0.0.1", 
  #     "mods": "service", 
  #     "module_names": [
  #         "netease_salog_0", 
  #         "netease_salog_1",
  #               "netease_uniqueid",
  #               "netease_stats_log_0",
  #               "netease_stats_log_1",
  #               "netease_stats_monitor"
  #     ], 
  #     "serverid": 11, 
  #     "type": "service"
  # }
  

HTTP服务器

RegisterServiceHttp

• 描述

  注册一个新的TTTP接口。

• 参数

  参数名	数据类型	说明
  url	string	接口url
  binder	instance	响应HTTP请求的实例
  func	function	响应HTTP请求的实例函数

• 返回值

  空

• 示例

  xxxxxxxxxx
  import service.serviceHttp as serviceHttp
  class HttpHandler(object):
          def __init__(self):
                  # 设置接口URI及回调
                  url = '/kick-user'
                  func = self.HttpTest
                  # 注册
                  serviceHttp.RegisterServiceHttp(url, self, func)
  ​
          def HttpTest(self, clientId, requestBody):
                  # clientId识别请求唯一id，send_http_response中要携带该参数
                  # requestBody为post body内容。如果是json格式，则可以通过下面方式加载内容。
                  # import ujson as json
                  # request = json.loads(requestBody)
                  # 返回处理结果
                  response = '{"code":0,"message":"ok"}'
                  serviceHttp.SendHttpResponse(clientId, response)
  

SendHttpRequestToMaster

• 描述

  给master发送http请求。

• 参数

  参数名	数据类型	说明
  requestUrl	string	请求url，例如“/test-reqeust”
  message	string	HTTP post body，是个json字符串

• 返回值

  空

• 示例

  xxxxxxxxxx
  import service.serviceHttp as serviceHttp
  params = {
          "message":"content",
          "code":1
  url = "/test-reqeust"
  serviceHttp.SendHttpRequestToMaster(url, json.dumps(params))
  

SendHttpResponse

• 描述

  发送HTTP的Response。支持异步返回，返回时指定输入clientId。

• 参数

  参数名	数据类型	说明
  clientId	int	请求唯一id，识别HTTP请求
  message	string	HTTP Response的内容

• 返回值

  空

• 示例

  xxxxxxxxxx
  import service.serviceHttp as serviceHttp
  class HttpHandler(object):
          def __init__(self):
                  # 设置接口URI及回调
                  url = '/kick-user'
                  func = self.HttpTest
                  # 注册
                  serviceHttp.RegisterServiceHttp(url, self, func)
  ​
          def HttpTest(self, clientId, requestBody):
                  # clientId识别请求唯一id，send_http_response中要携带该参数
                  # requestBody为post body内容。如果是json格式，则可以通过下面方式加载内容。
                  # import ujson as json
                  # request = json.loads(requestBody)
                  # 返回处理结果
                  response = '{"code":0,"message":"ok"}'
                  serviceHttp.SendHttpResponse(clientId, response)
  

服务器管理

GetServerProtocolVersion

• 描述

  获取服务器的协议版本号。多协议版本引擎中（比如同时支持1.14客户端和1.15客户端），需要把客户端分配到相同协议版本的lobby/game中。

• 参数

  参数名	数据类型	说明
  serverId	int	lobby/game服务器id

• 返回值

  数据类型	说明
  int	协议版本

• 示例

  xxxxxxxxxx
  import service.serverManager as serverManager
  version = serverManager.GetServerProtocolVersion(10)
  

GetServersStatus

• 描述

  获取所有lobby/game服务器的状态。只有状态1表示服务器正常服务，其他状态表示服务器不能服务。

• 返回值

  数据类型	说明
  dict	key:int, 服务器id，value:int 服务器状态。服务器状态如下： 1:准备状态 2:停止状态 3:准备状态

• 示例

  xxxxxxxxxx
  import service.serverManager as serverManager
  statusDict = serverManager.GetServersStatus()
  

IsConnectedServer

• 描述

  service是否与lobby/game/proxy建立连接。

• 参数

  参数名	数据类型	说明
  serverId	int	服务器id

• 返回值

  数据类型	说明
  bool	True，已经建立连接;False未建立连接

• 示例

  xxxxxxxxxx
  import service.serverManager as serverManager
  bConnect = serverManager.IsConnectedServer(10)
  

lobby和game服务器API

服务器

CheckMasterExist

• 描述

  检查服务器是否与master建立连接。

• 返回值

  数据类型	说明
  bool	是否与master建立连接

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  exist = lobbyGameApi.CheckMasterExist()
  

GetOnlinePlayerNum

• 描述

  获取当前服务器的在线人数。

• 返回值

  数据类型	说明
  int	当前服务器在线人数

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  num = lobbyGameApi.GetOnlinePlayerNum()
  

IsShowDebugLog

• 描述

  当前服务器是否打印debug等级的日志

• 返回值

  数据类型	说明
  bool	True，打印debug log，否则不打印debug log

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  bDebug = lobbyGameApi.IsShowDebugLog()
  

• 备注

  • 基本无需关注

玩家

GetConnectingProxyIdOfPlayer

• 描述

  获取玩家客户端连接的proxy服务器id。

• 参数

  参数名	数据类型	说明
  playerId	str	玩家对象的entityId

• 返回值

  数据类型	说明
  int	proxy服务器id

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  nickname = lobbyGameApi.GetConnectingProxyIdOfPlayer(playerId)
  

GetPlayerLockResult

• 描述

  把获取玩家在线锁结果告知给引擎层。本api应用于官方mod neteaseOnline，不建议开发者使用。

• 参数

  参数名	数据类型	说明
  id	int	对应【ServerGetPlayerLockEvent】事件的传入唯一ID
  success	bool	是否成功

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.GetPlayerLockResult(id, suc)
  

• 备注

  • 用法详情见示例Mod online

GetPlayerNickname

• 描述

  获取玩家的昵称。

• 参数

  参数名	数据类型	说明
  playerId	str	玩家对象的entityId

• 返回值

  数据类型	说明
  str	昵称

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  nickname = lobbyGameApi.GetPlayerNickname(playerId)
  

• 备注

  • 用法详情见示例Mod sample

GetPlayerUid

• 描述

  获取玩家的uid。

• 参数

  参数名	数据类型	说明
  playerId	str	玩家对象的entityId

• 返回值

  数据类型	说明
  int	玩家的uid；玩家的唯一标识。

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  uid = lobbyGameApi.GetPlayerUid(playerId)
  

• 备注

  • 用法详情见示例Mod sample

ReleasePlayerLockResult

• 描述

  把释放玩家在线锁结果告知给引擎层。本api应用于官方mod neteaseOnline，不建议开发者使用。

• 参数

  参数名	数据类型	说明
  id	int	对应【ServerReleasePlayerLockEvent/ServerReleasePlayerLockOnShutDownEvent】事件传入的唯一ID
  success	bool	是否成功

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.ReleasePlayerLockResult(id, suc)
  

• 备注

  • 用法详情见示例Mod online

SetAutoRespawn

• 描述

  设置是否启用自动重生逻辑。

• 参数

  参数名	数据类型	说明
  autoRespawn	bool	是否启用自动重生逻辑
  internalSeconds	int	每隔多少秒，检查是否满足自动重生条件
  minY	int	高度低于多少，就会触发自动重生逻辑
  x	int	自动重生逻辑触发后，重生点的坐标
  y	int	自动重生逻辑触发后，重生点的坐标
  z	int	自动重生逻辑触发后，重生点的坐标

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.SetAutoRespawn(autoRespawn, internalSeconds, minY, x, y, z)
  

ShieldPlayerJoinText

• 描述

  是否屏蔽客户端左上角 “xxx 加入了游戏”的提示。

• 参数

  参数名	数据类型	说明
  bShield	bool	True，不显示提示；False，显示提示

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.ShieldPlayerJoinText(True)
  

TryToKickoutPlayer

• 描述

  把玩家踢下线，message中的文字会显示在客户端的断线提示中

• 参数

  参数名	数据类型	说明
  playerId	str	玩家对象的entityId
  message	str	踢掉玩家的理由，默认为空

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.TryToKickoutPlayer(playerId, "GM把你踢下线")
  

切服

TransferToOtherServer

• 描述

  玩家转移到指定类型的服务器，假如同类服务器有多个，就根据负载均衡选择一个。

• 参数

  参数名	数据类型	说明
  playerId	str	玩家对象的entityId
  typeName	str	目标服务器的类型，netgame_commom.json中配置的type,比如lobby，game
  transferParam	str	切服传入参数，默认空字符串。当玩家跳转到目标服务器触发AddServerPlayerEvent事件时，AddServerPlayerEvent事件会携带这个参数

• 返回值

  空

• 示例

  xxxxxxxxxx
  import json
  import lobbyGame.netgameApi as lobbyGameApi
  transData = {'position' : [1,2,3]}
  lobbyGameApi.TransferToOtherServer('123', 'game', json.dumps(transData))
  

TransferToOtherServerById

• 描述

  玩家迁移到指定服务器id的服务器。

• 参数

  参数名	数据类型	说明
  playerId	str	玩家对象的entityId
  serverId	str	目标服务器id，对应netgame_common.json中配置的serverid
  transferParam	str	切服传入参数，默认空字符串。当玩家跳转到目标服务器触发AddServerPlayerEvent事件时，AddServerPlayerEvent事件会携带这个参数

• 返回值

  空

• 示例

  xxxxxxxxxx
  import json
  import lobbyGame.netgameApi as lobbyGameApi
  transData = {'position' : [1,2,3]}
  lobbyGameApi.TransferToOtherServerById('123', 2000000, json.dumps(transData))
  

• 备注

  • 用法详情见示例Mod sample

商城

NotifyClientToOpenShopUi

• 描述

  通知客户端打开商城界面。

• 参数

  参数名	数据类型	说明
  playerId	str	玩家对象的entityId

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.NotifyClientToOpenShopUi('123456')
  

性能开关

ChangeAllPerformanceSwitch

• 描述

  整体关闭/打开预定义的游戏原生逻辑，所有的逻辑默认状态均为【开】（也就是is_disable=False），只有当调用此接口关闭之后，才会进入到【关】的状态，关闭这类原生逻辑能够提高服务器的性能，承载更高的同时在线人数，同时也会使一些生存服的玩法失效。另外，强烈建议在服务器初始化时调用此接口，同时不要在服务器运行中途修改。

• 参数

  参数名	数据类型	说明
  is_disable	bool	True代表【关】，False代表【开】
  extra	list	剔除掉不需要改变开关状态的具体功能的枚举值列表。默认为空

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.ChangeAllPerformanceSwitch(True)
  

• 备注

  • 当extra的值为None的时候，默认影响到的开关不包括【LoadSavedEntityFromChunk】和【ScanNearbyEntityOnTick】。

ChangePerformanceSwitch

• 描述

  关闭/打开某个游戏原生逻辑，所有的逻辑默认状态均为【开】（也就是is_disable=False），只有当调用此接口关闭之后，才会进入到【关】的状态，关闭这类原生逻辑能够提高服务器的性能，承载更高的同时在线人数，同时也会使一些生存服的玩法失效。另外，强烈建议在服务器初始化时调用此接口，同时不要在服务器运行中途修改。

• 参数

  参数名	数据类型	说明
  key	int	具体功能的枚举值，详情见备注
  isDisable	bool	True代表【关】，False代表【开】

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  import lobbyGame.netgameConsts as netgameConsts
  lobbyGameApi.ChangePerformanceSwitch(netgameConsts.DisableSwitch.ChunkLoadUsePriority, True)
  

• 备注

  • 所有开关的枚举值以及涵义

    xxxxxxxxxx
    class DisableSwitch(object):
          # 加载chunk时，是否根据chunk的坐标与当前在线玩家的坐标计算加权优先级（性能较低），disable后所有chunk的加载优先级相同
          ChunkLoadUsePriority = 1
          # 是否刷新红石帧，disable后红石不再刷新
          RedstoneOnTick = 2
          # 是否存档chunk，disable后对地图chunk的修改不会再存档到地图文件
          ChunkSaveOnTick = 3
          # 是否关闭服务器的移动开始/移动结束事件（性能较低），disable后服务器引擎层不再dispatch上述两个事件
          WalkAnimPostEvent = 4
          # 是否在登录完成后发送服务器配方表，disable后客户端无法收到登录后的配方表
          RecipesSyncOnLogin = 5
          # 是否执行滑翔状态的每帧刷新逻辑，disable后一旦进入滑翔状态，将会出现状态更新异常
          UpdateGlidingOnTick = 6
          # 是否执行背包/操作栏的每帧刷新逻辑，disable后服务器停止背包帧刷新
          UpdateContainerOnTick = 7
          # 是否执行物品推挤的每帧刷新逻辑，disable后无法推动地图上的物品
          PushEntitiesOnTick = 8
          # 是否执行entity在block中的每帧特殊判定逻辑，disable后传送门无法启动传送，另外被卡在方块中也不会掉血
          UpdateInsideBlockOnTick = 9
          # 是否执行entity在特殊地形上的每帧特殊判定逻辑，disable后站在仙人掌、熔岩石上面不会受伤（站在仙人掌侧面依旧会受伤）
          BlockDamageOnTick = 10
          # 是否每帧检查环境音的播放，disable之后从每帧检测降频到每秒检测
          PlayAmbientSoundPerTick = 11
          # 是否每帧刷新剩余无敌时间，disable之后会导致伤害判定异常，仅适合非战斗场景
          UpdateHurtOnTick = 12
          # 是否每帧检查entity属性变化并同步，disable之后从每帧检测降频到每秒检测
          SendDirtyActorPerTick = 13
          # 是否执行饥饿逻辑，disable之后饥饿不再按时间增长
          ApplyExhaustionOnTick = 14
          # 是否每帧检查人物朝向，disable之后，一些特殊NPC或怪物的朝向逻辑不再生效
          UpdateInteractionOnTick = 15
          # 是否每帧检查人物副手装备变化并同步，disable之后不再群发同步副手装备变化
          UpdateOffhandItemOnTick = 16
          # 是否每帧检查附近可捡取的物品道具，disable之后会捡不到经验球等物品
          PickEntityOnTick = 17
          # 是否每帧同步附近的道具箱等特殊物件的内容物，disable之后自带物品格的刷新会失效
          SyncComplexItemOnTick = 18
          # 是否每帧执行chunk的tick逻辑，disable之后从每帧执行降频到每秒执行
          UpdateChunkPerTick = 19
          # 是否在条件符合时，刷新生物群落，disable之后不会按群落刷新生物
          SpawnMobsOnTick = 20
          # 是否在条件符合时，清理多余的群落生物，disable之后群落生物不再回收
          DespawnMobsOnTick = 21
          # 是否每帧刷新天气相关的特殊block逻辑，disable之后，闪电、骷髅陷阱等不再刷新
          UpdateBlocksOnTick = 22
          # 是否每帧执行天气刷新逻辑，disable之后，天气不再刷新（打雷下雨）
          UpdateWeatherOnTick = 23
          # 是否每帧执行季节刷新逻辑，disable之后，季节不再刷新
          UpdateSeasonOnTick = 24
          # 是否每帧执行季节后处理逻辑，disable之后，会影响积雪等相关逻辑
          BackgroundSeasonOnTick = 25
          # 是否执行全局entity和自由entity的逻辑帧刷新，disable之后，所有不在player视野内的entity都会停止刷新
          LevelEntityOnTick = 26
           是否不加载chunk存档中的entity，disable之后，entity的存档将失效
          LoadSavedEntityFromChunk = 27
          # 是否每帧执行视野范围内的entity对象刷新，disable之后，服务器不再会将视野范围内的entity对象同步给客户端
          ScanNearbyEntityOnTick = 28
    

关服

SetGracefulShutdownOk

• 描述

  设置脚本层的优雅关机逻辑已经执行完毕，引擎可以开始优雅关机了。

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.SetGracefulShutdownOk()
  

• 备注

  • 用法详情见示例Mod shutdown

SetShutdownOk

• 描述

  设置脚本层的强制关机逻辑已经执行完毕，引擎可以开始强制关机了。

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.SetShutdownOk()
  

• 备注

  • 用法详情见示例Mod shutdown

配置

GetCommonConfig

• 描述

  获取公共配置netgame_common.json中内容，将该文件内容映射为一个dict。

• 返回值

  数据类型	说明
  dict	配置内容

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  conf = lobbyGameApi.GetCommonConfig()
  bDebugLevel = conf['log_debug_level'] #获取日志等级配置
  

• 备注

  • 注意：lobby/game 公共配置中"serverlist"和"servicelist"配置不是最新的。

GetMongoConfig

• 描述

  获取mongo数据库的连接参数，对应netgame_common.json中mongo配置

• 返回值

  数据类型	说明
  tuple	(exist, host, user, password, database, port).exist：bool,是否存在mongo数据库配置; host：str, mongo数据库的地址;user：str,mongo数据库的访问用户; port：int, mongo数据库的端口; password：str,mongo数据库的访问密码;database：str,mongo数据库的数据库名

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  exist, host, user, password, database, port = lobbyGameApi.GetMongoConfig()
  

GetMysqlConfig

• 描述

  获取mysql数据库的连接参数，对应netgame_common.json中mysql配置

• 返回值

  数据类型	说明
  tuple	(exist, host, user, password, database, port).exist：bool,是否存在mysql数据库配置; host：string, mysql数据库的地址;user：string,mysql数据库的访问用户; port：int, mysql数据库的端口; password：string,mysql数据库的访问密码;database：string,mysql数据库的数据库名

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  exist, host, user, password, database, port = lobbyGameApi.GetMysqlConfig()
  

GetRedisConfig

• 描述

  获取redis数据库的连接参数，对应netgame_common.json中redis配置

• 返回值

  数据类型	说明
  tuple	(exist, host, port, password).exist：bool,是否存在redis配置; host：str, redis数据库的地址;port：int, redis数据库的端口; password：str,redis数据库的访问密码

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  exist, host, port, password = lobbyGameApi.GetRedisConfig()
  

GetServerId

• 描述

  获取服务器id。

• 返回值

  数据类型	说明
  int	服务器id，对应netgame_common.json中配置的serverid

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  serverId = lobbyGameApi.GetServerId()
  

存档

QueryPlayerDataResult

• 描述

  把mc地图中玩家存档字符串告知引擎。仅用于引擎，不建议使用本api。需要在queryPlayerDataEvent事件的监听函数中调用本api。

• 参数

  参数名	数据类型	说明
  dbCallIndex	int	对应【queryPlayerDataEvent】事件的传入唯一ID
  success	bool	是否成功
  dataStr	str	mc地图中玩家存档字符串。

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.QueryPlayerDataResult(dbCallIndex, success, dataStr)
  

• 备注

  • 用法详情见示例Mod neteaseDatabase

SavePlayerDataResult

• 描述

  把玩家数据存档状态告知引擎。mod中需要把玩家数据保存到mysql/mongo中。在savePlayerDataOnShutDownEvent/savePlayerDataEvent事件的监听函数中调用本api。

• 参数

  参数名	数据类型	说明
  dbCallIndex	int	【savePlayerDataEvent/savePlayerDataOnShutDownEvent】事件中传入唯一ID
  success	bool	存档是否成功

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.SavePlayerDataResult(dbCallIndex, success)
  

• 备注

  • 用法详情见示例Mod neteaseDatabase

SetUseDatabaseSave

• 描述

  设置是否使用数据库定时存档。定时存档会定时触发savePlayerDataEvent事件。

• 参数

  参数名	数据类型	说明
  bUseDatabase	bool	是否使用数据库
  dbName	str	30个字符内的英文字符串，建议使用项目英文名
  internalSaveSecond	int	触发定时存档的时间间隔，单位秒

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.SetUseDatabaseSave(True, 'test', 30)
  

• 备注

  • 用法详情见示例Mod neteaseDatabase

地图

SetEnableLimitArea

• 描述

  设置地图最大区域，超过区域的地形不再生成。

• 参数

  参数名	数据类型	说明
  limit	bool	是否启用地区区域限制
  x	int	地图区域的中心点
  y	int	地图区域的中心点
  z	int	地图区域的中心点
  offsetX	int	地图区域在x方向和z方向的最大偏移
  offsetZ	int	地图区域在x方向和z方向的最大偏移

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.SetEnableLimitArea(limit, x, y, z, offsetX, offsetZ)
  

• 备注

  • 真实应用中，请用墙壁把区域围起来。

SetLevelGameType

• 描述

  强制设置游戏的玩法模式。

• 参数

  参数名	数据类型	说明
  mode	int	0生存模式，1创造模式，2冒险模式

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobbyGame.netgameApi as lobbyGameApi
  lobbyGameApi.SetLevelGameType(2)
  

• 备注

  • 真实应用中，请在服务器Mod初始化时调用此函数

lobby服务器API

主城模式

SetCityMode

• 描述

  设置游戏为主城模式：包括有无法改变地形，不切换日夜，不改变天气，不刷新生物等限制。

• 参数

  参数名	数据类型	说明
  isCityMode	bool	是否为主城模式

• 返回值

  空

• 示例

  xxxxxxxxxx
  import lobby.netgameApi as lobbyApi
  lobbyApi.SetCityMode(isCityMode)
  

• 备注

  • 用法详情见示例Mod sample

master/service/game/lobby 公共API

myqsl、redis、mong连接池用于处理单个db实例，myqsl、redis、mong连接池扩展用于处理多个db实例。

异步线程池

EmitOrder

• 描述

  添加一个异步任务。

• 参数

  参数名	数据类型	说明
  key	string/int	相同key的任务，线程池顺序执行；不同key的任务，线程池会并行执行。可以确认某些任务按照顺序执行。
  func	function	任务对应的函数，该函数会在线程池中运行。该任务和主线程会并行执行，需要确认任务是线程安全的。函数必须返回一个元组，若返回为空则要求返回空元组("()")。函数输入参数是*args
  callback	function	回调函数，它在主线程执行。func的返回值会是callback的实参
  *args	*args	func函数的非关键字参数

• 返回值

  空

• 示例

  xxxxxxxxxx
  import time
  import apolloCommon.workerPool as workerPool
  def Callbacks(idx, result):
          print "callbacks",idx, result
  ​
  def Test(idx):
          print "test start %d" % idx
          time.sleep(1)
          print "test fin %d" % idx
          result = idx + 5
          return (idx, result)#任务必须有返回值。若没有返回值，请返回 "()"
  ​
  ins = workerPool.ForkNewPool(4)
  for i in xrange(4):
          #添加异步任务。i为奇数的任务顺序执行，i为偶数的任务顺序执行。这两批任务并行执行。
          ins.EmitOrder(i%2, Test, Callbacks, i)
  ins.Finish(None) #等待线程池退出。
  

Finish

• 描述

  等待线程池退出，线程池会执行完所有异步任务后退出，会阻塞主线程。建议Mod退出时执行。

• 参数

  参数名	数据类型	说明
  timeout	int	等待线程池退出时间，单位秒。若为None，则会一直等待。建议用None。

• 返回值

  空

• 示例

  xxxxxxxxxx
  import apolloCommon.workerPool as workerPool
  ins = workerPool.ForkNewPool(4)
  ins.Finish(None) #等待线程池退出。
  

ForkNewPool

• 描述

  创建线程池，设置线程池大小。

• 参数

  参数名	数据类型	说明
  orderSize	int	线程池的大小

• 返回值

  数据类型	说明
  MainPool	线程池实例

• 示例

  xxxxxxxxxx
  import apolloCommon.workerPool as workerPool
  ins = workerPool.ForkNewPool(10)
  

mysql连接池

AsyncExecuteWithOrderKey

• 描述

  添加一个异步mysql任务，执行所有mysql操作。

• 参数

  参数名	数据类型	说明
  orderKey	str/int	相同的orderKey会顺序执行，不同的orderKey会并行执行
  sql	str	mysql查询语句，格式化字符串
  params	tuple	填充sql
  callback	function	回调函数，只有一个输入参数，它在主线程执行。func的返回值会是callback的实参。若func抛出异常，则callback输入参数是None

• 返回值

  空

• 示例

  xxxxxxxxxx
  import apolloCommon.mysqlPool as mysqlPool
  mysqlPool.InitDB(30)
  def Cb(t):
          print "cb", t
  #添加异步任务。
  mysqlPool.AsyncExecuteWithOrderKey('player', 'insert into player values (%s, %s)', (1, "test1"), Cb)
  mysqlPool.Finish()
  

AsyncExecutemanyWithOrderKey

• 描述

  添加一个异步mysql任务，针对同一条sql语句，使用paramsList中的每个参数各执行一次，并且返回成功修改/新建的记录数，其中任何一条语句执行失败，最终所有语句都会被执行失败，返回None

• 参数

  参数名	数据类型	说明
  orderKey	string/int	相同的orderKey会顺序执行，不同的orderKey会并行执行
  sql	string	mysql插入语句，格式化字符串
  list	list	填充sql的参数列表，每个元素都会被执行一次
  callback	function	回调函数，在主线程执行，只有唯一一个参数，成功修改/新建的记录数，假如sql执行失败，返回参数将会是None

• 返回值

  空

• 示例

  xxxxxxxxxx
  import time
  import apolloCommon.mysqlPool as mysqlPool
  mysqlPool.InitDB(30)
  def Cb(t):
          print "cb", t
  #添加异步任务。
  mysqlPool.AsyncExecutemanyWithOrderKey('pay', 'insert into pay values (%s, %s)', [(1,"648"),(1,"328")], Cb)
  for i in xrange(100):
          mysqlPool.Tick()
          time.sleep(0.2)
  mysqlPool.Finish()
  

AsyncInsertOneWithOrderKey

• 描述

  添加一个异步mysql任务，向主键为AUTO INCREASEl类型的表格中插入一条记录，并且返回新建记录的主键。

• 参数

  参数名	数据类型	说明
  orderKey	string/int	相同的orderKey会顺序执行，不同的orderKey会并行执行
  sql	string	mysql插入语句，格式化字符串
  params	tuple	填充sql
  callback	function	回调函数，在主线程执行，只有唯一一个参数，是新建记录的主键，假如sql执行失败，返回参数将会是None

• 返回值

  空

• 示例

  xxxxxxxxxx
  import apolloCommon.mysqlPool as mysqlPool
  mysqlPool.InitDB(30)
  def Cb(t):
          print "cb", t
  #添加异步任务。
  mysqlPool.AsyncInsertOneWithOrderKey('pay', 'insert into pay values (%s, %s)', (1, "648"), Cb)
  mysqlPool.Finish()
  

AsyncQueryWithOrderKey

• 描述

  添加一个异步mysql任务，执行mysql查询。

• 参数

  参数名	数据类型	说明
  orderKey	str/int	相同的orderKey会顺序执行，不同的orderKey会并行执行
  sql	str	mysql查询语句，格式化字符串
  params	tuple	填充sql
  callback	function	回调函数，只有一个输入参数，它在主线程执行。func的返回值会是callback的实参。若func抛出异常，则callback输入参数是None

• 返回值

  空

• 示例

  xxxxxxxxxx
  import apolloCommon.mysqlPool as mysqlPool
  mysqlPool.InitDB(30)
  def Cb(t):
          print "cb", t
  #添加异步任务。
  mysqlPool.AsyncQueryWithOrderKey('player', 'select uid,name from player where uid = %s', (1,), Cb)
  #等价于
  #mysqlPool.AsyncQuery('player', 'select uid,name from player where uid = %s', (1,), Cb)
  #orderKey都是'player'，两个任务顺序执行。
  mysqlPool.AsyncQueryWithOrderKey('player', 'select uid,name from player where uid = %s', (1,), Cb)
  mysqlPool.Finish()
  

Finish

• 描述

  等待mysql线程池退出，会等待线程池中所有异步任务执行完毕后退出。

• 返回值

  空

• 示例

  xxxxxxxxxx
  import apolloCommon.mysqlPool as mysqlPool
  mysqlPool.Finish()
  

InitDB

• 描述

  初始化myqsl连接池。要求公共配置 netgame_common.json中配置“mysql”。

• 参数

  参数名	数据类型	说明
  poolSize	int	连接池大小

• 返回值

  空

• 示例

  xxxxxxxxxx
  import apolloCommon.mysqlPool as mysqlPool
  mysqlPool.InitDB(30)
  

• 备注

  • netgame_common.json中部分配置的示例如下：

  xxxxxxxxxx
  "mysql": {
          "database": "mod_test",
          "host": "127.0.0.1",
          "password": "test",
          "port": 3306,
          "user": "test"
  },
  

redis连接池

AsyncDelete

• 描述

  执行redis操作，删除某个redis key,相当于redis中执行命令:del key。

• 参数

  参数名	数据类型	说明
  key	string	redis中的key
  callback	function	回调函数，输入参数是redis操作返回值,是个int，表示删除redis key的个数 ,它在主线程执行。可以不传入回调函数。若redis操作抛出异常，则callback输入参数是None

• 返回值

  空

• 示例

  xxxxxxxxxx
  import apolloCommon.redisPool as redisPool
  def Cb1(t):
          print "cb", t
  redisPool.InitDB(30) #建立连接池
  keys = ("player_121", "player_122")
  redisPool.AsyncDelete('player_121', cb1)
  redisPool.Finish()
  

AsyncFuncWithKey

• 描述

  添加一个异步redis任务。

• 参数

  参数名	数据类型	说明
  func	function	redis异步任务，可以没有返回值。该任务和主线程会并行执行，要求任务是线程安全的。第一个参数是一个redis长连接，是一个redis.StrictRedis实例，其他参数是*args
  orderKey	str/int	相同的orderKey会顺序执行，不同的orderKey会并行执行
  callback	function	回调函数，只有一个输入参数，它在主线程执行。func的返回值是callback的输入参数。若func抛出异常，则callback输入参数是None
  *args	*args	func的其它非关键字参数
  **kwargs	**kwargs	暂无用，预留用。

• 返回值

  空

• 示例

  xxxxxxxxxx
  import apolloCommon.redisPool as redisPool
  redisPool.InitDB(30) #建立连接池
  #回调，可以获取player的信息。这里只是打印结果。
  def Cb1(t):
          print "cb", t
  #第一个参数是redis.StrictRedis实例。
  def GetValueFromKey(conn, key):
          return conn.get(key)
  #插入一个任务，从redis中获取uid为123玩家的信息。
  redisPool.AsyncFuncWithKey(GetValueFromKey, "player_123", Cb1, 123)
  #插入同样任务，orderKey都是“player_123”,因此两个任务会顺序执行。
  redisPool.AsyncFuncWithKey(GetValueFromKey, "player_123", Cb1, 123)
  redisPool.Finish()
  

AsyncGet

• 描述

  执行redis操作，获取key的value,相当于redis中执行命令:get key。

• 参数

  参数名	数据类型	说明
  key	str	redis中的key
  callback	function	回调函数，默认为空。函数输入参数是redis key对应的value字符串，它在主线程执行。若redis操作抛出异常，则callback输入参数是None

• 返回值

  空

• 示例

  xxxxxxxxxx
  import apolloCommon.redisPool as redisPool
  def Cb1(t):
          print "cb", t
  redisPool.InitDB(30) #建立连接池
  redisPool.AsyncGet("player_123", Cb1)
  redisPool.Finish()
  

AsyncHgetall

• 描述

  执行redis操作，获取key的value,相当于redis中执行命令:hgetall key。

• 参数

  参数名	数据类型	说明
  key	string	redis中的key
  callback	function	回调函数，输入参数是redis key对应的值，是个dict，它在主线程执行。可以不传入回调函数。若redis操作抛出异常，则callback输入参数是None

• 返回值

  空

• 示例

  xxxxxxxxxx
  import apolloCommon.redisPool as redisPool
  def Cb1(t):
          print "cb", t
  redisPool.InitDB(30) #建立连接池
  redisPool.AsyncHgetall("mplayer_123", Cb1)
  redisPool.Finish()
  

AsyncMget

• 描述

  执行redis操作，获取多个key的值,相当于redis中执行命令:mget key1 key2 ...。

• 参数

  参数名	数据类型	说明
  key	list/tuple	多个redis中的key
  callback	function	回调函数，默认为空。函数输入参数redis操作返回值, 是个列表，每个元素对应单个redis key的值，它在主线程执行。若redis操作抛出异常，则callback输入参数是None

• 返回值

  空

• 示例

  xxxxxxxxxx
  import apolloCommon.redisPool as redisPool
  def Cb1(t):
          print "cb", t
  redisPool.InitDB(30) #建立连接池
  keys = ("player_121", "player_122")
  redisPool.AsyncMget(keys, Cb1)
  redisPool.Finish()
  

AsyncSet