UCloud NetAnalysis SDK for iOS

README of Chinese

Introduction

This document is intended to help users integrate with the UCloud NetAnalysis SDK for iOS. We will introduce the following aspects:

About SDK repository
Environmental requirements
Installation
Function introduction
F&Q
Contact us

About SDK repository

The repository includes the source code of the SDK and sample projects. The sample project contains two versions of "Objective-C" and `Swift".

Directory	Description
`SDK/UNetAnalysisSDK`	SDK source code
`SDK/documents/devDocuments.zip`	SDK development documentation
`SDK/Demo/oc/UNetAnalysisDemo_01`	sample project(`OC`)
`SDK/Demo/swift/UNetAnalysisSwiftDemo_01`	sample project(`Swift`)

Environmental requirements

iOS version >= 9.0
The customer of UCloud and opened UCloud net analysis service

Xcode version

The Deployment target of UNetAnalysisSDK is 9.0, so you can use XCode7.0 and above and first set Enable Bitcode to NO:

Project->Build Setting->Build Operation->Enable Bitcode

Installation

Pod dependency

Add the following dependencies to your project's Podfile:

pod 'UNetAnalysisSDK'

Quick start

Import the SDK header file to the project:

#import <UNetAnalysisSDK/UNetAnalysisSDK.h>

In addition, you need to add -lc++,-ObjC,$(inherited) to the project's Build Setting->other link flags. As shown below:

Function introduction

Network diagnosis function

You can set the ip address of the app's server,which is used for network diagnosis
SDK will auto diagnose the network status and report it(Triggered when opening APP and network is switching[WWAN<=>WIFI])
You can manually diagnose network conditions

Other functions

Setting SDK log level
Get the SDK version

Code example

Regist SDK

Suppose you have already registered your app in the UCloud Console and opened the UCloud net analysis service, then you will get a pair of AppKey and PublicToken (public key), when registering SDK need to use these parameters.

We hope that you register as early as possible SDK, we recommend but not limited to register when the application is just started. You can register in the - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions method in AppDelegate.

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [[UCNetAnalysisManager shareInstance] uNetSettingSDKLogLevel:UCSDKLogLevel_DEBUG];  // setting log level
    
    // Appkey and public token can be obtained from the ucloud console, or contact our technical support
    NSString *appKey = @""; //your AppKey
    NSString *appToken = @""; // your publick token
    [[UCNetAnalysisManager shareInstance] uNetRegistSdkWithAppKey:appKey publicToken:appToken completeHandler:^(UCError * _Nullable ucError) {
        if (ucError) {
            NSLog(@"regist UNetAnalysisSDK error , error info: %@",ucError.error.description);
        }else{
        	NSLog(@"regist UNetAnalysisSDK success...");
	        NSArray *customerIps = @[@"220.181.112.244",@"221.230.143.58"]; // Fill in your application's main service address here (only support ip address, which is used for manual network diagnostics)
	        [[UCNetAnalysisManager shareInstance] uNetSettingCustomerIpList:customerIps];
        }
    }];
    
    return YES;
}

Manually diagnose network conditions

When the mobile phone network is not good, you can call the manual network diagnostic interface of SDK in the network diagnosis of your application to get the current network status of your application, and the SDK will report the current network status.

[[UCNetAnalysisManager shareInstance] uNetManualDiagNetStatus:^(UCManualNetDiagResult * _Nullable manualNetDiagRes, UCError * _Nullable ucError) {
        if (ucError) {
            if (ucError)
                NSLog(@"Manual diagnosis error info: %@",ucError.error.description);
            return;
        }
        dispatch_async(dispatch_get_main_queue(), ^{
            NSLog(@"netType:%@, pingInfo:%@ ",manualNetDiagRes.networkType,manualNetDiagRes.pingInfo);
        });
    }];

For more detailed introduction of each interface, please refer to the declaration of each interface in SDK or SDK development documentation.

Stop network data collection

Stop network data collection when the application is about to move from active to inactive state. This is done in the - (void)applicationWillResignActive:(UIApplication *)application method in AppDelegate.

- (void)applicationWillResignActive:(UIApplication *)application {
    [[UCNetAnalysisManager shareInstance] uNetStopDataCollectionWhenAppWillResignActive];
}

F&Q

The app on iOS 9+ is forced to use HTTPS. Projects created with XCode do not support HTTP by default, so you need to add NSAppTransportSecurity in project build info and NSAllowsArbitraryLoads in NSAppTransportSecurity,The value is set to YES, as shown below:

Contact us

UCloud official website
If you have any questions, please submit issue or contact our technical support, we will solve the problem in the first time.

MaxwellQi/netanalysis-sdk-ios