iOS SDK 参考

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

头文件: <GameSdkNetworkManager/GameSdkNetworkManager.h>

GameSdkNetworkManager 类

描述

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

定义

@interface GameSdkNetworkManager : NSObject

@property(nonatomic, copy)NSDictionary * commonParams;
@property(atomic, copy)TTNetworkManagerCommonParamsBlock commonParamsblock;

@property (nonatomic, assign) bool enableVerboseLog;

typedef void (^Monitorblock)(NSDictionary*, NSString*);

+ (void)setMonitorBlock:(Monitorblock)block;
+ (Monitorblock)MonitorBlock;

+ (instancetype)shareInstance;

- (BOOL)ensureEngineStarted;

- (void *)getEngine;

- (void)start;

@end

属性

您需要为 commonParams 参数设置的值

成员方法

头文件: <GameSdkNetworkManager/TTNetDiagnosisService.h>

createRequestWithReqestType 方法

描述

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

定义

- (NSObject<TTNetDiagnosisRequestProtocol> *)createRequestWithReqestType:(TTNetExpRequestType)reqType
                                                                  target:(NSString *)target
                                                           netDetectType:(TTNetExpNetDetectType)netDetectType
                                                          multiNetAction:(TTNetExpMultiNetAction)multiNetAction
                                                               timeoutMs:(int64_t)timeoutMs
                                                                callback:(DiagnosisCallback)callback;

参数

返回值

TTNetDiagnosisRequestProtocol 对象。

createRequestWithRequestParams 方法

描述

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

定义

- (NSObject <TTNetDiagnosisRequestProtocol> *)createRequestWithRequestParams:(TTNetDiagnosisRequestParams* _Nonnull)params
                                                                    callback:(DiagnosisCallback)callback;

参数

返回值

TTNetDiagnosisRequestProtocol 对象。

TTNetDiagnosisRequestParams 类

描述

自助网络分析请求参数。

定义

@interface TTNetDiagnosisRequestParams : NSObject

@property(nonatomic, assign) TTNetExpRequestType requestType;

@property(nonatomic, strong) NSArray<NSString *> *targets;

@property(nonatomic, strong) NSString *dispatchFeature;

@property(nonatomic, assign) TTNetExpNetDetectType detectType;

@property(nonatomic, assign) TTNetExpMultiNetAction multiNetAction;

@property(nonatomic, assign) int64_t timeoutMs;
@end

参数

DiagnosisCallback 回调

描述

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

定义

typedef void (^DiagnosisCallback)(NSString* report);

参数

start 方法

描述

开始玩家自助网络分析。自助网络分析完成后，会触发 createRequestWithReqestType 方法中设置的回调。

定义

- (void)start;

setUserExtraInfo 方法

描述

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

定义

- (void)setUserExtraInfo:(NSString*)extraInfo;

参数

cancel 方法

描述

取消玩家自助网络分析。调用该方法会触发 createRequestWithReqestType 方法中设置的回调。

定义

- (void)cancel;

头文件: <GameSdkNetworkManager/TTGameDiagnosisService.h>

monitorBegin 方法

描述

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

定义

- (void)monitorBegin:(NSString* _Nonnull)target extraInfo:(NSString* _Nullable)extraInfo;

参数

monitorBeginWithParams 方法

描述

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

定义

- (void)monitorBeginWithParams:(TTGameMonitorBeginParams *_Nonnull)params;

参数

TTGameMonitorBeginParams 类

描述

游戏对局网络分析参数。

定义

interface TTGameMonitorBeginParams : NSObject

@property(nonatomic, strong) NSString *target;

@property(nonatomic, strong) NSString *dispatchFeature;

@property(nonatomic, strong) NSString *extraInfo;

@property(nonatomic, copy) DiagnosisCallback reportCallback;
@end

参数

DiagnosisCallback 回调

描述

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

定义

typedef void (^DiagnosisCallback)(NSString* report);

参数

doDiagnosisDuringGaming 方法

描述

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

定义

- (void)doDiagnosisDuringGaming:(nullable NSString*)extraMessage;

参数

monitorEnd 方法

描述

结束游戏对局网络分析。

定义

- (void)monitorEnd:(nullable NSString*)extraInfo;

头文件: <GameSdkNetworkManager/TTNetMpaService.h>

registerInitCallback 方法

描述

注册网络加速所需的回调。

定义

- (void)registerInitCallback:(ICallback)initCallback
             setAddrCallback:(ISetAddrCallback)setAddressCallback
                stopCallback:(ICallback)stopCallback;

参数

ICallback 回调

描述

该回调可用于：

• 调用 initService 方法后触发的回调，用于报告初始化是否成功。该回调需要传入 registerInitCallback 方法的 initCallback 参数。
• 调用 stop 方法后触发的回调，用于报告加速是否成功。该回调需要传入 registerInitCallback 方法的 stopCallback 参数。

定义

typedef void (^ICallback)(BOOL isSuccess, NSString* extraMsg);

参数

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

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

setAddressCallback 回调

描述

调用 stop 方法后触发的回调，用于报告加速是否成功。该回调需要传入 registerInitCallback 方法的 stopCallback 参数。

定义

typedef void (^ISetAddrCallback)(BOOL isSuccess, NSString* extraMsg, NSString* context);

参数

initService 方法

描述

初始化网络加速功能。调用该方法会触发 registerInitCallbacks 方法的 initCallback 参数中设置的回调。

定义

- (void)initService;

enableWiseMultiPath 方法

描述

开启或关闭智能双通道加速。如果您不调用该方法，SDK 默认关闭智能加速。

定义

- (void)enableWiseMultiPath:(BOOL)enable;

参数

start 方法

描述

开始网络加速。

定义

- (void)start:(NSString*)userLog;

参数

setAccAddress 方法

描述

设置需要加速的目标地址列表。调用该方法会触发 registerInitCallbacks 方法的 setAddressCallback 参数中设置的回调。

定义

- (void)setAccAddress:(NSArray<NSString*>*)address context:(NSString*)context append:(BOOL)append;

参数

setAccAddressWithParams 方法

描述

设置需要加速的目标地址列表。调用该方法会触发 registerInitCallbacks 方法的 setAddressCallback 参数中设置的回调。

定义

- (void)setAccAddressWithParams:(TTNetMpaAcceleratedPointParams*)params;

参数

TTNetMpaAcceleratedPointParams

描述

网络加速参数。

定义

@interface TTNetMpaAcceleratedPointParams : NSObject

@property(nonatomic, strong) NSArray<NSString*>* addressList;

@property(nonatomic, assign) TTNetMpaSocketType socketType;

@property(nonatomic, assign) BOOL append;

@property(nonatomic, strong) NSString* context;
@end

参数

reportUserLog 方法

描述

上报用户日志。

定义

- (void)reportUserLog:(NSString*)userLog;

参数

Stop 方法

描述

停止网络加速。调用该方法会触发 registerInitCallbacks 方法的 stopCallback 参数中设置的回调。

定义

- (void)stop:(NSString*)userLog;

参数