Unity SDK 参考

本文档介绍 GNA Unity SDK 的参考信息。

命名空间: GNASDK

IGnaClient 接口

描述

包含 SDK 初始化所需的参数和方法。

定义

public interface IGnaClient
{
   public void SetAppId(string appId);

   public void SetDeviceId(string deviceId);

   public void SetSecret(string secret);
        
   public void SetEnableVerbose(bool enable);

   public void Init(GnaMonitorCallback monitorCallback, GnaInitEndCallback initCallback);
}

成员方法

GnaMonitorCallback 委托

描述

日志监控委托。您可以通过该委托查看事件类型和日志。

定义

public delegate void GnaMonitorCallback(string log, string eventType);

参数

GnaInitEndCallback 委托

描述

初始化结果委托。您可以通过该委托查看初始化结果。

定义

public delegate void GnaInitEndCallback(bool initSuccess, string errorMsg);

参数

命名空间: GNASDK

CreateDiagnosisRequest 方法 [1/2]

描述

创建玩家自助网络分析请求。

定义

public interface INetExperienceService
{
    IDiagnosisRequest CreateDiagnosisRequest(GnaExpRequestType reqType, List<string> target,
            GnaExpNetDetectType detectType, GnaExpMultiNetAction multiNetAction, int timeout);


     void ReportUserLog(string userLog);
}

参数

返回值

IDiagnosisRequest 对象。

CreateDiagnosisRequest 方法 [2/2]

描述

创建玩家自助网络分析请求。

定义

IDiagnosisRequest CreateDiagnosisRequest(RequestParams requestParams);

参数

返回值

IDiagnosisRequest 对象。

RequestParams 类

描述

网络分析请求参数。

定义

public class RequestParams
    {
        public GnaExpRequestType RequestType;
        
        public List<string> Targets;
        
        public string DispatchFeature;
        
        public GnaExpNetDetectType DetectType;
        
        public GnaExpMultiNetAction MultiNetAction;
        
        public int Timeout;
    }

参数

DiagnosisCompleteCallback 委托

描述

报告网络分析的结果。您需要实现该回调并在调用 CreateDiagnosisRequest 方法时传入该回调。当网络分析完成、被取消、因网络切换中止、超时或失败时，SDK 都会通过该回调返回结果。

定义

public interface IDiagnosisRequest
    {
        delegate void DiagnosisCompleteCallback(string report);

        ...
    }

参数

start 方法

描述

开始玩家自助网络分析。自助网络分析完成后，会触发通过 DiagnosisCompleteCallback 委托注册的回调。

定义

public interface IDiagnosisRequest
    {

        void Start(DiagnosisCompleteCallback callback);

        ...

    }

参数

SetUserExtraInfo 方法

描述

辅助描述信息。该信息会记录在分析报告里的 user_extra_info 字段。

定义

public interface IDiagnosisRequest
    {
        void SetUserExtraInfo(string userExtraInfo);

        ...
    }

参数

Cancel 方法

描述

取消玩家自助网络分析。调用该方法会触发通过 DiagnosisCompleteCallback 委托注册的回调。

定义

public interface IDiagnosisRequest
    {

        void Cancel();

        ...

    }

命名空间: GNASDK

MonitorBegin 方法 [1/2]

描述

开始游戏对局网络分析。当玩家网络发生跳变时，SDK 会对从玩家客户端到您设置的目标地址之间的网络进行分析。

定义

public interface IGameNetDiagnosisService
    {
        void MonitorBegin(string target, string extraInfo);
        
        ...
    }

参数

MonitorBegin 方法 [2/2]

描述

开始游戏对局网络分析。当玩家网络发生跳变时，SDK 会对从玩家客户端到您设置的目标地址之间的网络进行分析。

定义

public interface IGameNetDiagnosisService
    {
        void MonitorBegin(MonitorBeginParams beginParams);
        
        ...
    }

参数

MonitorBeginParams 类

描述

游戏对局网络分析参数。

定义

public class MonitorBeginParams
    {
        public string Target;
        
        public string DispatchFeature;
        
        public string ExtraInfo;
    }

参数

DoDiagnosisDuringGaming 方法

描述

在游戏对局中，手动对从玩家客户端到您在 MonitorBegin 方法中设置的目标地址之间的网络进行分析。

定义

public interface IGameNetDiagnosisService
    {
        void DoDiagnosisDuringGaming(string extraMessage);

        ...
    }

参数

MonitorEnd 方法

描述

结束游戏对局网络分析。

定义

public interface IGameNetDiagnosisService
    {

        void MonitorEnd(string extraInfo);

        ...

    }

参数

命名空间: GNASDK

MpaEventHandler 委托

描述

用于注册开始和关闭网络加速的回调。

定义

public delegate void MpaEventHandler(bool isSuccess, string extraMsg);

参数

对于调用 Init 方法后触发的回调，参数如下：

对于调用 Stop 方法后触发的回调，参数如下：

MpaSetAddressHandler 委托

描述

用于注册报告加速目标地址的设置结果的回调。

定义

public delegate void MpaSetAddressHandler(bool isSuccess, string extraMsg, string context);

参数

MpaInitEvent 事件

描述

调用 Init 方法后触发。

定义

public interface INetMpaService
    {
        event MpaEventHandler MpaInitEvent;

        ...
    }

MpaSetAccAddressEvent 事件

描述

调用 SetAccAddress 方法后触发。

public interface INetMpaService
    {

        event MpaSetAddressHandler MpaSetAccAddressEvent;

        ...

    }

MpaStopEvent 事件

描述

调用 Stop 方法后触发。

定义

public interface INetMpaService
    {

        event MpaEventHandler MpaStopEvent;

        ...
  
    }

Init 方法

描述

初始化网络加速功能。调用该方法会触发 MpaInitEvent 事件注册的回调。

定义

public interface INetMpaService
    {
        void Init();

        ...

    }

Start 方法

描述

开始网络加速。

定义

public interface INetMpaService
    {

        void Start(string beginLog);

        ...

    }

参数

SetAccAddress 方法 [1/2]

描述

设置需要加速的目标地址列表。调用该方法会触发 MpaSetAccAddressEvent 事件注册的回调。

定义

public interface INetMpaService
    {

        void SetAccAddress(List<string> addressList, string context, bool append);

        ...

    }

参数

SetAccAddress 方法 [2/2]

描述

设置需要加速的目标地址列表。调用该方法会触发 MpaSetAccAddressEvent 事件注册的回调。

定义

public interface INetMpaService
    {

        void SetAccAddress(AcceleratedPointsParams pointsParams);

        ...

    }

参数

AcceleratedPointsParams 类

描述

网络加速参数。

定义

public class AcceleratedPointsParams
    {
        public List<string> AddressList;
            
        public SocketType SocketType = SocketType.Unspecified;
            
        public bool Append;
            
        public string Context;
    }

参数

ReportUserLog 方法

描述

上报用户日志。

定义

public interface INetMpaService
    {    
        void ReportUserLog(string userLog);

        ...
    }

参数

Stop 方法

描述

停止网络加速。调用该方法会触发 MpaStopEvent 事件注册的回调。

定义

public interface INetMpaService
    {

        void Stop(string endLog);

        ...

    }

参数