# 5-功能服API
这里是Service的一些接口
# 配置
# GetCommonConfig
描述
获取服务器公共配置，包括所有服务器和db的配置，具体参见备注
返回值
数据类型 说明 dict 配置内容 备注
服务器公共配置的示例如下，只展示了核心配置信息：
{ "apolloid":111, "extra_redis":{ }, "game_id":0, "game_key":"game_key", "gas_server_url":"http://127.0.0.1:111", "log_debug_level":true, "master":{ "app_type":"master", "app_version":"1.21.0.release20210401", "gb":8, "ip":"127.0.0.1", "keep_alive_period":30, "master_port":0, "mods":"", "port":8000, "serverid":0, "type":"master" }, "mongo":null, "mysql":{ "database":"test_db", "host":"127.0.0.1", "password":"test_password", "port":3306, "user":"test_user" }, "redis":{ "host":"127.0.0.1", "password":"", "port":6379 }, "review_stage":0, "serverlist":[ { "app_type":"proxy", "app_version":"1.21.0.release20210401", "gb":8, "ip":"127.0.0.1", "log_debug_level":false, "master_port":11003, "max_players":0, "mods":"", "optimum_players":0, "port":11002, "save":false, "serverid":2000, "type":"proxy" }, { "app_type":"lobby", "app_version":"1.21.0.release20210401", "gb":8, "ip":"127.0.0.1", "log_debug_level":false, "master_port":13003, "max_players":200, "mods":"neteaseRound", "optimum_players":0, "port":13002, "save":false, "serverid":4000, "type":"lobby" } ], "servicelist":[ ], }示例
import service.netgameApi as netServiceApi
conf = netServiceApi.GetCommonConfig()
serverlist = conf['serverlist'] #获取serverlist配置
serverlist = conf['log_debug_level'] #获取日志等级配置
# GetServerId
描述
获取服务器id，服务器id对应公共配置中serverid，公共配置参见GetCommonConfig备注
返回值
数据类型 说明 int 服务器id 示例
import service.netgameApi as netServiceApi
serverId = netServiceApi.GetServerId()
# GetServiceConfig
描述
获取service配置，该配置对应公共配置中servicelist下对应service的配置，公共配置参见GetCommonConfig备注
返回值
数据类型 说明 dict 配置内容 示例
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"
# }
# 通用
# StartRecordEvent
描述
开始启动大厅服/游戏服与功能服之间的脚本事件收发包统计，启动后调用StopRecordEvent()即可获取两个函数调用之间引擎收发包的统计信息
返回值
数据类型 说明 bool 执行结果 示例
import service.netgameApi as netServiceApi
suc = netServiceApi.StartRecordEvent()
# 之后通过计时器或者其他触发方式调用StopRecordEvent
result = netServiceApi.StopRecordEvent()
# sendEvent对应的value保存了功能服主动发送给大厅服/游戏服、甚至客户端的事件统计
for eventName, data in result["sendEvent"].iteritems():
print "sendEvent event[{}] send={} sendSize={}".format(eventName, data["send_num"], data["send_size"])
# sendRequest对应的value保存了功能服发送给其他的功能服事件，以及对应的功能服返回结果的事件
for eventName, data in result["sendRequest"].iteritems():
print "sendRequest event[{}] request={} requestSize={} response={} responseSize={}".format(eventName, data["request_num"], data["request_size"], data["response_num"], data["response_size"])
# recvRequest对应的value保存了功能服接收到的来自其他服务端的请求，以及对应的返回结果的事件
for eventName, data in result["recvRequest"].iteritems():
print "recvRequest event[{}] request={} requestSize={} response={} responseSize={}".format(eventName, data["request_num"], data["request_size"], data["response_num"], data["response_size"])
# StopRecordEvent
描述
停止大厅服/游戏服与功能服之间的脚本事件收发包统计并输出结果，与StartRecordEvent()配合使用，输出结果为字典，具体见示例
返回值
数据类型 说明 dict 收发包信息，具体见示例，假如没有调用过StartRecordEvent，则返回为None 示例
import service.netgameApi as netServiceApi
suc = netServiceApi.StartRecordEvent()
# 之后通过计时器或者其他触发方式调用StopRecordEvent
result = netServiceApi.StopRecordEvent()
# sendEvent对应的value保存了功能服主动发送给大厅服/游戏服、甚至客户端的事件统计
for eventName, data in result["sendEvent"].iteritems():
print "sendEvent event[{}] send={} sendSize={}".format(eventName, data["send_num"], data["send_size"])
# sendRequest对应的value保存了功能服发送给其他的功能服事件，以及对应的功能服返回结果的事件
for eventName, data in result["sendRequest"].iteritems():
print "sendRequest event[{}] request={} requestSize={} response={} responseSize={}".format(eventName, data["request_num"], data["request_size"], data["response_num"], data["response_size"])
# recvRequest对应的value保存了功能服接收到的来自其他服务端的请求，以及对应的返回结果的事件
for eventName, data in result["recvRequest"].iteritems():
print "recvRequest event[{}] request={} requestSize={} response={} responseSize={}".format(eventName, data["request_num"], data["request_size"], data["response_num"], data["response_size"])
这里是service的一些HTTP接口
# HTTP服务器
# RegisterServiceHttp
描述
注册一个新的TTTP接口
参数
参数名 数据类型 说明 url string 接口url binder instance 响应HTTP请求的实例 func function 响应HTTP请求的实例函数 返回值
无
示例
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字符串 返回值
无
示例
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的内容 返回值
无
示例
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)
这里是service的一些服务的管理接口
# 服务器管理
# GetServerIdsByServerType
描述
根据类型获取服务器id列表
参数
参数名 数据类型 说明 serverType str 服务器类型 返回值
数据类型 说明 list(int) 服务器id列表，若服务器类型不存在，则返回空列表 示例
import service.serverManager as serverManager
#返回的一个示例：[4000, 4001]
serverIds = serverManager.GetServerIdsByServerType("lobby")
# GetServerProtocolVersion
描述
获取服务器的协议版本号。多协议版本引擎中（比如同时支持1.14客户端和1.15客户端），需要把客户端分配到相同协议版本的lobby/game中
参数
参数名 数据类型 说明 serverId int lobby/game服务器id 返回值
数据类型 说明 int 协议版本 示例
import service.serverManager as serverManager
version = serverManager.GetServerProtocolVersion(6000)
# GetServerType
描述
获取服务器类型
参数
参数名 数据类型 说明 serverId int master/service/lobby/game服务器id 返回值
数据类型 说明 str 服务器类型字符串。若服务器不存在，则返回空字符串 示例
import service.serverManager as serverManager
serverType = serverManager.GetServerType(6000)
# GetServersStatus
描述
获取所有lobby/game服务器的状态。只有状态1表示服务器正常服务，其他状态表示服务器不能服务
返回值
数据类型 说明 dict key:int, 服务器id，value:int 服务器状态。服务器状态如下：
1:准备状态
2:停止状态
3:准备状态示例
import service.serverManager as serverManager
statusDict = serverManager.GetServersStatus()
# IsConnectedServer
描述
service是否与lobby/game/proxy建立连接
参数
参数名 数据类型 说明 serverId int 服务器id 返回值
数据类型 说明 bool True，已经建立连接;False未建立连接 示例
import service.serverManager as serverManager
bConnect = serverManager.IsConnectedServer(4000)
← 4-控制服API 6-大厅与游戏服API →