API Overview

Download

Mode fokus

Ukuran font

Terakhir diperbarui: 2026-05-21 16:50:39

MpAccClient
MpAccClient Properties
Required
Description
shared
The MpAccClient singleton
accType
Acceleration mode: .vpn / .socks5 / .unowned
isStart
Whether acceleration is active, which is true when status == .started.
status
Acceleration status: .initialize / .launching / .launched / .started
accConfig
The Config used by the current acceleration
MpAccClient Methods
Methodology
Description
register(mode:completion:)
Registration (accelerates the start process)
start(config:)
Start acceleration
stop
Stop acceleration.
getVpnStatus
Obtains the VPN status asynchronously.
resumeVpn
Call this API after the APP restarts to resume VPN event listening.
updateUDPDirect
Update UDP direct-connection status.
updateTCPDirect
Update TCP direct-connection status.
setupLogDelegate
Set up a log delegate to take over log processing.
setupLogLevel
Set the log level.
setupCallbackQueue
Sets the callback queue, which defaults to a sub-thread.
registerAccCallback
Register acceleration status listener.
unRegisterAccCallback
Unregister acceleration status listener.
setupDatakey
Set public cloud registration parameters.
setSign
Set signature and App ID.
setGatewayId
Set gateway ID.
enableOverseas
Switches to the international site. The default is false (domestic site).
setupRegisterConnectTimeout
Sets the registration timeout duration. The default is 10s.
startMeasure
Enable network measurement.
stopMeasure
Stop network measurement.
addEventInfo
Add custom reporting event.
registerMeasureCallback
Register network measurement callback listener.
unRegisterMeasureCallback
Unregister the callback to listen for network measurement results.
getSdkVersion
Obtaining the SDK Version Number
register
Pre-registration (to improve speed at start)
func register(mode: AccMode, completion: ((_ error: NSError?) -> Void)?)
Parameter
Description
mode
Acceleration mode: enum AccMode
completion
Pre-registration result
start(config:)
Initiate acceleration.
func start(config: AccConfig)
Parameter
Description
config
Acceleration parameter configuration. For details, see AccConfig.
stop
Stop acceleration.
func stop()
getVpnStatus
Get VPN status, return asynchronously.
func getVpnStatus(_ completion: @escaping (_ status: NEVPNStatus) -> Void)
Parameter
Description
completion
Asynchronous callback status. The reference values are as follows:
Not configured: NEVPNStatus.invalid
Connected: NEVPNStatus.connected 
Connecting: NEVPNStatus.connecting 
Disconnected: NEVPNStatus.disconnected
Disconnecting: NEVPNStatus.disconnecting 
Reasserting: NEVPNStatus.reasserting 
resumeVpn
After restart, call this API to restore VPN event monitoring.
func resumeVpn()
updateUDPDirect
Update UDP direct connection status.
// asynchronous method
func updateUDPDirect(_ direct: Bool, completion: @escaping (_ result: Bool) -> Void)
// synchronized method (cannot be called in the main thread in vpn mode)
func updateUDPDirect(_ direct: Bool) -> Bool
Parameter
Description
direct
Whether to connect directly. When set to false, the system queries the access gateway load status. This is a time-consuming operation and is recommended to be executed in a sub-thread.
completion
Completion callback. A result of true indicates a successful update.
updateTCPDirect
Update TCP direct connection status.
// async mode
func updateTCPDirect(_ direct: Bool, completion: @escaping (_ result: Bool) -> Void)
// sync mode (cannot be called in the main thread in vpn mode)
func updateTCPDirect(_ direct: Bool) -> Bool
Parameter
Description
direct
Direct or Not
completion
Completion callback. A result of true indicates a successful update.
setupLogDelegate
Set log agent and take over log processing.
func setupLogDelegate(_ delegate: MpLoggerDelegate)
Parameter
Description
delegate
Log delegate
setupLogLevel
Set log level.
func setupLogLevel(_ logLevel: LogLevel)
Parameter
Description
logLevel
Log level enumeration
setupCallbackQueue
Set callback queue.
func setupCallbackQueue(_ queue: DispatchQueue)
Parameter
Description
queue
Callback queue, which defaults to the main queue.
registerAccCallback
Signup speed up listen for status.
﻿
func registerAccCallback(_ callback: AccCallback)
Parameter
Description
callback
Acceleration status callback interface
unRegisterAccCallback
Cancel speed up listen for status.
func unRegisterAccCallback(_ callback: AccCallback)
Parameter
Description
callback
Acceleration status callback interface
setupDataKey
Set public cloud registration parameters.
func setupDatakey(_ datakey: String, deviceId: String)
Parameter
Description
datakey
Device secret key
deviceId
Unique device identifier
setSign
Set application signature authentication.
func setSign(appId: String, sign: String)
Parameter
Description
appId
Application ID
sign
Signature
setGatewayId
Set Gateway ID.
func setGatewayId(_ gwId: String)
Parameter
Description
gwId
Gateway ID
enableOverseas
Switch to international site, default to false (domestic site).
func enableOverseas(enabled: Bool)
Parameter
Description
enabled
Whether to switch to the international site
false (domestic site) 
true (international site)
setupRegisterConnectTimeout
Set registration timeout duration, default 10s.
func setupRegisterConnectTimeout(_ connectTimeout: Int)
Parameter
Description
connectTimeout
Timeout time
startMeasure
Enable network measurement.
func startMeasure(measureConfig: MpMeasureConfig)
Parameter
Description
measureConfig
Speed test configuration
stopMeasure
Terminate network measurement.
func stopMeasure()
addEventInfo
Add custom event reporting.
func addEventInfo(event: Int, msg: String)
Parameter
Description
event
Event ID
msg
Event Description
registerMeasureCallback
Register network measurement callback listener
func registerMeasureCallback(_ callback: MpMeasureCallback)
Parameter
Description
callback
Speed test callback interface
unRegisterMeasureCallback
Cancel network measurement callback listening.
func unRegisterMeasureCallback(_ callback: MpMeasureCallback)
Parameter
Description
callback
Speed test callback interface
getSdkVersion
Get SDK version number.
func getSdkVersion() -> String 
MpPacketTunnelManager
VPN process API class.
Methodology
Description
startTunnel
Starts the VPN Tunnel and passes parameters to the SDK.
stopTunnel
Stops the VPN Tunnel.
handleAppMessage
Receives messages from the main program and passes parameters to the SDK.
getSdkVersion
Obtaining the version number.
setupLogDelegate
Setting up a log delegate.
registerMeasureCallback
Registering a network speed test callback listener.
unRegisterMeasureCallback
Unregistering the network speed test callback listener.
startTunnel
Enable VPN Tunnel, parameter passthrough to SDK.
public func startTunnel(packetTunnel: NEPacketTunnelProvider, options: [String : NSObject]?, completionHandler: @escaping (Error?) -> Void)
Parameter
Description
packetTunnel
An instance object of the NEPacketTunnelProvider VPN Provider
options
Parameters passed through to the SDK, which include Config data.
completionHandler
Completion callback
stopTunnel
Disable VPN Tunnel.
func stopTunnel()
handleAppMessage
Receive main program messages, parameter passthrough to SDK
func handleAppMessage(_ messageData: Data, completionHandler: ((Data?) -> Void)?)
Parameter
Description
messageData
Binary data, with parameters passed through to the SDK.
completionHandler
Completion callback, with parameters passed through to the SDK.
getSdkVersion
Get version number.
func getSdkVersion() -> String
setupLogDelegate
Set log agent.
func setupLogDelegate(_ delegate:MpLoggerDelegate?)
Parameter
Description
delegate
Log delegate instance
registerMeasureCallback
Register network speed test callback listener
func registerMeasureCallback(_ callback: MpMeasureCallback)
Parameter
Description
callback
Speed test callback interface
unRegisterMeasureCallback
Cancel network speed test callback listening.
func unRegisterMeasureCallback(_ callback: MpMeasureCallback)
Parameter
Description
callback
Speed test callback interface
AccCallback
Acceleration status and event callback.
Methodology
Description
onAccSuccess
Acceleration success callback
onAccFail
Acceleration startup failure
onAccDataUpdate
Network speed callback
onSummaryInfoUpdate
Acceleration summary information update
onNetworkStateChanged
Network adapter link state change callback
onAccSuccess
Success callback.
func onAccSuccess(ip: String, port: Int) -> Void
Parameter
Description
ip
Acceleration node IP address
port
Acceleration node port
onAccFail
Start acceleration failed.
func onAccFail(_ error: NSError) -> Void
Parameter
Description
error
Determines whether acceleration is terminated normally or abnormally based on the error code.
onAccDataUpdate
Network rate callback. The callback frequency is set by AccConfig.pingInterval.
func onAccDataUpdate(tRx: Int64, tTx: Int64, pathDetails: [MpPathDetail]) -> Void
Parameter
Description
tRx
Total received data volume (unit: byte)
tTx
Total transmitted data volume (unit: byte)
pathDetails
Detailed link information
onSummaryInfoUpdate
Acceleration summary update.
func onSummaryInfoUpdate(_ summaryInfo: String) -> Void
Parameter
Description
summaryInfo
Acceleration summary information
onNetworkStateChanged
Network interface card link status change callback.
func onNetworkStateChanged(type: MpInterfaceType, available: Bool, ip: String) -> Void
Parameter
Description
type
0:mobile 
1:Wi-Fi
available
NIC availability:
true: Available 
false: Unavailable
ip
NIC IP (IPv4), left blank if unavailable.
MpMeasureCallback
Speed test callback.
Methodology
Description
onStartMpAcc
Enable acceleration (recommended)
onStopMpAcc
Disable acceleration (recommended)
onNoPolicy
No policy is available for the current network state.
onAccException
The acceleration link is abnormal. (In this case, the SDK automatically disables acceleration and switches back to normal mode.)
onRttChanged
Callback for bypass udping rtt latency
onAccStateChanged
Acceleration state change callback
onStartMpAcc
Enable acceleration.
func onStartMpAcc(code: Int) -> Void
Parameter
Description
code
trigger code  
0: Aggregation mode trigger (Aggregation mode is always triggered.)
1: Latency exception trigger 
2: Packet loss rate exception trigger 
3: Jitter exception trigger
onStopMpAcc
Disable acceleration.
func onStopMpAcc(code: Int, msg: String) -> Void
Parameter
Description
code
Trigger code 
1: Single NIC trigger 
2: No optimization trigger 
3: No network trigger 
4: The acceleration NIC and the actual active NIC are inconsistent.
msg
Trigger message
onNoPolicy
Current network status: No policy available.
func onNoPolicy(code: Int, message: String?) -> Void
Parameter
Description
code
Trigger code 
2: Single Wi-Fi 
3: No network available 
4: Internal error 
-12: Authentication timeout 
-13: Authentication exception 
-19: Speed test service failure 
-23: Account authentication failed.
message
Trigger message. If the message is not empty, the message information takes precedence.
onAccException
The accelerated link encounters an exception (in this case, the SDK will proactively disable acceleration and switch back to normal mode).
func onAccException(errorCode: Int, msg: String) -> Void
Parameter
Description
errorCode
Error Code:
 -6: acc speed test sustained packet loss anomaly
 -7: acc speed test maximum number of delays anomaly
 -8: acc speed test vs. Wi-Fi delay anomaly
 -9: acc speed test average latency exceeds maximum threshold
msg
Error Message
onRttChanged
Bypass udping rtt delay callback.
﻿
func onRttChanged(type: Int, rtt: Int) -> Void
Parameter
Description
type
NIC type:
0:mobile 
1:Wi-Fi 
2:acc
rtt
Latency (ms), packet loss value: 460.
onAccStateChanged
Aggregate acceleration status change callback.
﻿
func onAccStateChanged(state: Bool, code: Int) -> Void
Parameter
Description
state
Acceleration status 
false: Disable 
true: Enable
code
0: Enabled 
1: Disabled 
2: Abnormal Disable
AccPluginManager
Plugin Management (Currently used only in SOCKS5 acceleration).
Methodology
Description
shared
Singleton method
setAccProxyPlugin
Sets the SOCKS5 plugin.
getAccProxyPlugin
Obtains the SOCKS5 plugin instance.
setLogPlugin
Setting up a log plugin
getLogPlugin
Obtains the log plugin instance.
shared
Singleton method.
shared
setAccProxyPlugin
Set SOCKS5 plug-in.
func setAccProxyPlugin(_ accProxyPlugin: AccProxyPlugin?)
Parameter
Description
accProxyPlugin
SOCKS5 plugin instance
For example: setAccProxyPlugin(TRTCAccPlugin()).
TRTCAccPlugin can be obtained by importing the plugin package provided by Tencent.
getAccProxyPlugin
Retrieve the SOCKS5 plugin instance.
func getAccProxyPlugin() -> AccProxyPlugin?
setLogPlugin
Set log plugin
func setLogPlugin(_ logUploadPlugin: AccLogPlugin?)
Parameter
Description
logUploadPlugin
Log plugin instance
For example: setLogPlugin(LogPlugin()).
LogPlugin can be obtained by importing the plugin package provided by Tencent.
getLogPlugin
Obtain the log plugin instance.
func getLogPlugin() -> AccLogPluginModel
Model
AccConfig
Required
Description
node
Acceleration nodes. Mandatory in private cloud deployments. Optional in public cloud deployments. If they are configured, they are prioritized for use.
accMode
Acceleration mode:
Enumeration (AccMode)
Aggregation (Bonding)  
Dual-transmit (Redundant)   
Real-time fast switching (FastSwitching)
pingInterval
Interval for the onAccDataUpdate callback.
congestionMode
Congestion algorithm (BBR / CUBIC)
encryption
Whether encryption is enabled. Default: true.
tcpDirect
Whether TCP direct connection is enabled. Default: false.
udpDirect
Whether UDP direct connection is enabled. Default: false.
udpTimeout
UDP attempt duration
maxReconnectTimeout
Maximum connection timeout. No reconnection attempts are made after this duration is exceeded. Unit: seconds.
accRules
Acceleration rules
priority
Link priority
key: 0: mobile, 1: Wi-Fi. The priority.put(0,64) call sets the link priority for type=0 (mobile) to 64.
value: The priority is a number ranging from 0-255, where a lower number indicates a higher priority, with a default value of 64. When the priority number is >= 128, it indicates that the link is a backup link.
keepAlive
Configures whether the acc connection is kept alive. If kept alive, the acceleration status is determined by whether UDP acceleration is enabled.
networkConditions
Network conditions required to start acceleration. No conditions are required by default.
groupId
AppGroup
vpnName
VPN name
dnsServerlp
VPN DNS Server IP address. Default: 119.29.29.29.
whiteList
Allowlist. All IP addresses are blocked by default.
blackList
Sets the blocklist.
socksProxyPort
socks proxy port number. The default is 3000. If Acc is used.
socksUsername
Preset username for socks5 proxy.
socksPassword
Preset password for socks5 proxy.
extraParams
Extended parameters, such as keyId, which are passed via extended parameters.
enableMultiNetwork
Whether to enable multiple NICs in EO scenarios. Default: false.
false: Default network adapter
true: Enumerates available network adapters based on the configured priority. If the priority is not configured, enumerates all available network adapters.
addLineType(:)
Adding acceleration links in EO scenarios. 0: Direct connection, 1: EO.
Setting extraParams
Method
Description
setBool(_:,forKey:)
Sets the bool-type extraParams parameter.
setString(_:,forKey:)
Sets the String-type extraParams parameter.
setStringList(_:,forKey:)
Sets the [String]-type extraParams parameter.
setInt(_:,forKey:)
Sets the Int-type extraParams parameter.
setFloat(_:,forKey:)
Sets the Float-type extraParams parameter.
Parameters Supported by extraParams
KEY
Description
Private cloud-related parameters
﻿
AccConfig.KEY_SECRET_KEY_ID
[String] Secret key ID
AccConfig.KEY_CIPHERTEXT
[String] Signature string
AccConfig.KEY_SIGNATURE
[String] Digital signature
Parameters related to the link disabling algorithm
﻿
AccConfig.KEY_MAX_RTT_THRESHOLD
[Int] The CheckLatestRTT judgment is performed only when the link latency exceeds this value. Unit: ms. Default: 150 ms.
AccConfig.KEY_MIN_RTT_FACTOR
[Float64] The amplification factor for the minimum link latency. If the current link latency > minimum link latency * factor, the link is considered to have high latency. Default: 15.
AccConfig.KEY_LATEST_RTT_FACTOR
[Float64] The amplification factor for the last sampled latency. If the current link latency > last sampled latency * factor, the link is considered to have high latency. Default: 5.
AccConfig.KEY_MIN_WAITING_WHEN_PATH_FAILED
[Int] Minimum waiting duration for prohibiting link retention. Unit: s. Default: 3s. // Fast switchover.
Fast switch-related parameters
﻿
AccConfig.KEY_MIN_SWITCH_RTT
[Int] For fast switchover mode, link switching is not triggered when the latency is below this value. Unit: ms. Default: 20 ms.
AccConfig.KEY_SWITCH_TOLERANCE
[Float64] For fast switchover mode, the tolerance coefficient. The current path latency is amplified and then compared with other paths to avoid frequent switching. Default: 1.125.
AccConfig.KEY_DISABLE_AUTO_SWITCH
[Bool] For fast switchover mode, whether to disable the dynamic switchover feature. Default: false.
AccConfig.KEY_MIN_DELAY_UNTIL_LOST
[Int] For fast switchover mode, the minimum latency for determining packet loss. Link disabling is considered only when the latency exceeds this value. Unit: ms. Default: 150 ms.
AccConfig.KEY_MAX_DELAY_UNTIL_FAILED
[Int] For fast switchover mode, the maximum tolerable time threshold. Packet transmission on the link is disabled when the latency exceeds this threshold. Unit: ms. Default: 460 ms.
AccConfig.KEY_TIME_REORDERING_FRACTION
[Float64] For fast switchover mode, the amplification factor for link latency, used to determine whether a link failure has occurred. Default: 2.25.
Parameters related to aggregation mode
﻿
AccConfig.KEY_MAX_RTT_DISABLE_AGGREGATION
[Int] For aggregation mode, the link is excluded from aggregation when its latency exceeds this value. Unit: ms. Default: 460 ms.
UDP Enhanced Aggregation
﻿
AccConfig.KEY_JITTER_DELAY
[Int] For UDP enhanced aggregation mode, the compensation latency. Unit: ms. Default: 0 ms.
AccConfig.KEY_PATH_IDLE_TIMEOUT
[Int] For UDP enhanced aggregation mode, the path idle duration. This duration is excluded from compensation. Unit: s. Default: 1 s.
AccConfig.KEY_ENABLE_SINGLE_PATH_SMOOTHING
[Bool] For UDP enhanced aggregation parameters, latency smoothing is also performed on a single path after enabling. Default: false.
AccConfig.KEY_DELAY_FACTOR
[Float64] For UDP enhanced aggregation parameters, used to calculate the one-way smoothed latency. Default: 0.125.
AccConfig.KEY_OUTER_CWND_GAIN
[Float64] quic congestion window gain factor
T2 acceleration
1. AccConfig.KEY_ENABLE_T2ACC must be set to true.
2. Set AccConfig.KEY_T2OUT for cross-domain operations. Otherwise, access may be blocked.
3. AccConfig.KEY_T2_APP_ID_LIST must be configured. Otherwise, rules cannot be matched.
4. AccConfig.dnsServerIp must be set to a non-encrypted resolution server, for example: "162.14.21.56" (Tencent International dns server).
﻿
AccConfig.KEY_ENABLE_T2ACC
[Bool] Whether to enable T2 acceleration. Default: false.
AccConfig.KEY_T2OUT
[String] Specifies the T2 segment egress. Default: empty (automatic routing).
AccConfig.KEY_T2_APP_ID_LIST
[String] Specifies the T2 acceleration applications: App ID List.
AccConfig.KEY_T2ACC_IP_PREFIX_BLACKLIST
[String] T2 acceleration IP address CIDR blocklist (Direct).
AccConfig.KEY_T2ACC_IP_PREFIX_WHITELIST
[String] T2 acceleration IP CIDR allowlist (ACC).
AccConfig.KEY_T2ACC_DOMAIN_BLACKLIST
[String] T2 acceleration domain blocklist (Direct).
AccConfig.KEY_T2ACC_DOMAIN_WHITELIST
[String] T2 acceleration domain allowlist (ACC).
AccConfig.KEY_T2ACC_DOMAIN_SUFFIX_BLACKLIST
[String] T2 acceleration domain suffix blocklist (Direct).
AccConfig.KEY_T2ACC_DOMAIN_SUFFIX_WHITELIST
[String] T2 acceleration domain suffix allowlist (ACC).
Others
﻿
AccConfig.KEY_SERVER_DOMAIN
[String] Certificate domain name
AccConfig.KEY_ALLOW_PRIVATE
[Bool] Allows private network interconnection.
AccConfig.KEY_MAX_RETRY_TIMES
[Int] The maximum number of retries. Default: 3. Avoid setting it to 0, as this may cause issues when there is no network connectivity.
AccConfig.KEY_ENABLE_OBFUSCATED
[Bool] Whether to enable origin IP address obfuscation.
AccNode
Required
Description
ipList
Node IP list, empty by default.
port
Node port, with a default value of -1.
AccRule
Required
Description
priority
Set the priority. A lower value indicates a higher priority. The priority is a number from 0 to 255. A lower number indicates a higher priority. The default is 64.
dstIPCIDR
Set the destination IP address. Supports CIDR notation. For example: 10.8.0.0/8. An empty value indicates matching any destination IP address.
dstPortRange
Set the destination port. Supports a range. For example: 5002-5003. An empty value indicates matching any destination port.
proto
Set the protocol type. Supported values are "TCP" and "UDP". An empty value indicates matching any protocol.
mode
Setting the acceleration mode. Supported values: 1: bonding, 2: redundant, 3: RTC.
MpMeasureConfig
Required
Description
addr
The speed test address (for private cloud setup) is in the format "IP address:PORT". Multiple probe points are separated by semicolons, for example, "172.17.0.4:9000;172.17.0.4:9001".
t2AccProbeAddr
T2 segment speed test address
time
Sliding window measurement time (ms), default 30000
rtt
Latency threshold, default 90
loss
Packet loss rate threshold, default 5
jitter
Jitter threshold, default 15
quickTime
Quick start window time, default 10000
quickRtt
Quick start latency threshold, default 100
interval
Measurement callback frequency, default 1000
mode
Acceleration mode. Options: 1: bonding, 2: redundant, 3: RTC. Default: 2.
delayRemindTime
Delay reminder time, unit: milliseconds, default 10000
pingTimeout
ping packet timeout, unit: ms
disableQuickDetect
Disables quick detection.
true: Disable 
false: Do not disable
additionalOptions
Fallback attachment options
disableSlaveLossDetect
Disables packet loss detection on the secondary path.
true: Disable 
false: Do not disable
Common speed test addresses: usable as T1 and T2 segment speed test addresses.
﻿
FRANKFURT_ADDRESS
162.62.215.101:8888
SILICON_VALLEY_ADDRESS
43.130.30.222:8888
SAO_PAULO_ADDRESS
43.135.207.42:8888
TOKYO_ADDRESS
43.128.254.208:8888
BANGKOK_ADDRESS
43.128.200.25:8888
SINGAPORE_ADDRESS
101.33.46.84:8888
HONG_KONG_ADDRESS
43.159.234.5:8888
MpAdditionalOptions
Required
Description
packetLossEscape
The acceleration link is disconnected for [packetLossCount] consecutive times.
maxRttEscape
The ping value of the acceleration link is greater than or equal to [rttThreshold] ms for [maxRttCount] consecutive times.
rttExceptionEscape
The average ping value of the acceleration link over [detectWindowTime] is greater than that of the primary link by [rttDiffThreshold]%, and the average latency of the acc link is greater than [accBenchmarkRtt] ms.
stopAccRemind
If the average latency of the acceleration link within [detectWindowTime] is greater than that of the primary link by [rttDiffRate]%, and the jitter is greater than that of the primary link by [jitterRate]%, it is recommended to disable acceleration.
MpPathDetail
Required
Description
rxBytes
Downlink data
txBytes
Uplink data
lost
Packet loss rate.
RTT
Data latency
type
NIC type
 case mobile = 0
 case Wi-Fi  = 1
InterfaceName
NIC name
TotalRxBytes
Total downlink traffic
TotalTxBytes
Total uplink traffic
peakRxBytes
Peak downlink traffic
peakTxBytes
Peak uplink traffic
NetworkConditions
Required
Description
MUST_NONE
No restrictions
MUST_WIFI_ACTIVE
Wi-Fi must be available.
MUST_SIM_CARD_READY
SIM card must be inserted.
MUST_MOBILE_DATA_ENABLE
Cellular data must be enabled.
Methodology
Description
combine
Combine multiple conditions
Error Code Definition
public enum AccErrorType: Int {
    /// vpn fd null pointer exception
    case vpnInterfaceNullPoint = -1
    /// mpquic exception
    case mpQuicLibraryException = -2
    /// vpn connection establishment exception
    case establishVpnException = -3
    
    /// **⚠️andriod code**  Invalid package name (allowlist) exception
    @available(*, deprecated, message: "andriod code")
    case invalidPackageName = -4
    
    /// System exception
    case vpnDisconnectException = -5
    
    /// acc speed test packet loss rate anomaly
    case accContinuePackageLossException = -6
    /// acc acceleration maximum delay count anomaly
    case accMaxRttCountException = -7
    /// acc speed test contrast Wi-Fi delay anomaly
    case accRttContrastException = -8
    /// acc speed test average latency exceeds maximum threshold
    case accAvgRttException = -9
    /// acc speed test average packet loss rate anomaly
    case accAvgPackageLossException = -10
    
    /// acc authentication fail
    case accAuthenticationFailed = -11
    /// Authentication connection timeout
    case accAuthenticationTimeOut = -12
    /// Authentication connection exception
    case accAuthenticationException = -13
    /// SLA normal negative optimization
    case slaNormalAccException = -16
    /// Invalid acceleration parameter
    case accIllegalParamter = -17
    
    /// **⚠️andriod code** Failed to pull up vpn service
    @available(*, deprecated, message: "andriod code")
    case setUpVpnServiceFailed = -18
    
    /// Failed to pull up speed test service
    case setUpMeasureFailed = -19
    /// No valid access point
    case noValidAccessPoint = -20
    /// Account authentication fail
    case accountAuthenticationError = -21
    
    /// Network interface status fails to satisfy acceleration conditions
    case notMeetAccConditions = -22
    
    /// Invalid speed test address
    case invalidSpeedTestAddress = -23
    
    /// Invalid custom network interface card ⚠️ Android error code
    @available(*, deprecated, message: "andriod code")
    case invalidReflectObject = -24
    
    /// Invalid acceleration plug-in
    case invalidAccProxyPlugin = -25
    
    /// No active network interface card on current device
    case noConnectedNetworkCard = -26
    
    /// Node udping Unreachable
    case accessPointUdpingFailed = -28
    
    /// Unsupported acceleration for this device
    case unsupportAccDevice = -29
    
    /// MpAccClient.shared.status incorrect status
    case statusError = -50
    
    /// Multi-channel acceleration has been pulled up
    case mulitpathStarted = 100
    /// Multi-channel acceleration internal error
    case mulitpathCoreFailed = 101
    /// Failed to pull up acceleration proxy
    case mulitpathTunDevFailed = 102
    /// Invalid acceleration node IP
    case mulitpathCoreAccIpInvalid = 103
    /// Invalid acceleration mode
    case mulitpathCoreAccModeInvalid = 104
    /// Acceleration token authentication failure
    case mulitpathCoreAccAuthFailed = 105
    /// Accelerated link notification is disabled
    case mulitpathCoreAccControllerClose = 106
    /// Channel handshake establishment timeout
    case mulitpathCoreAccHandshakeTimeout = 107
    /// Acceleration reconnection timeout
    case mulitpathCoreAccReconnectTimeout = 108
    /// socks5 proxy failure
    case mulitpathCoreSocks5Failed = 109
    /// Reached the maximum gateway access count
    case reachedMaximumNumberGratewayAccesses = 110
}
﻿
﻿

Bantuan dan Dukungan

Apakah halaman ini membantu?

Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.

masukan

Required	Description
shared	The MpAccClient singleton
accType	Acceleration mode: `.vpn / .socks5 / .unowned`
isStart	Whether acceleration is active, which is true when status == .started.
status	Acceleration status: `.initialize / .launching / .launched / .started`
accConfig	The Config used by the current acceleration

Methodology	Description
register(mode:completion:)	Registration (accelerates the start process)
start(config:)	Start acceleration
stop	Stop acceleration.
getVpnStatus	Obtains the VPN status asynchronously.
resumeVpn	Call this API after the APP restarts to resume VPN event listening.
updateUDPDirect	Update UDP direct-connection status.
updateTCPDirect	Update TCP direct-connection status.
setupLogDelegate	Set up a log delegate to take over log processing.
setupLogLevel	Set the log level.
setupCallbackQueue	Sets the callback queue, which defaults to a sub-thread.
registerAccCallback	Register acceleration status listener.
unRegisterAccCallback	Unregister acceleration status listener.
setupDatakey	Set public cloud registration parameters.
setSign	Set signature and App ID.
setGatewayId	Set gateway ID.
enableOverseas	Switches to the international site. The default is false (domestic site).
setupRegisterConnectTimeout	Sets the registration timeout duration. The default is 10s.
startMeasure	Enable network measurement.
stopMeasure	Stop network measurement.
addEventInfo	Add custom reporting event.
registerMeasureCallback	Register network measurement callback listener.
unRegisterMeasureCallback	Unregister the callback to listen for network measurement results.
getSdkVersion	Obtaining the SDK Version Number

Parameter	Description
mode	Acceleration mode: enum AccMode
completion	Pre-registration result

Parameter	Description
config	Acceleration parameter configuration. For details, see AccConfig.

Parameter	Description
direct	Whether to connect directly. When set to false, the system queries the access gateway load status. This is a time-consuming operation and is recommended to be executed in a sub-thread.
completion	Completion callback. A result of true indicates a successful update.

Parameter	Description
queue	Callback queue, which defaults to the main queue.

Parameter	Description
callback	Acceleration status callback interface

Parameter	Description
datakey	Device secret key
deviceId	Unique device identifier

Parameter	Description
enabled	Whether to switch to the international site false (domestic site) true (international site)

Methodology	Description
startTunnel	Starts the VPN Tunnel and passes parameters to the SDK.
stopTunnel	Stops the VPN Tunnel.
handleAppMessage	Receives messages from the main program and passes parameters to the SDK.
getSdkVersion	Obtaining the version number.
setupLogDelegate	Setting up a log delegate.
registerMeasureCallback	Registering a network speed test callback listener.
unRegisterMeasureCallback	Unregistering the network speed test callback listener.

Parameter	Description
packetTunnel	An instance object of the NEPacketTunnelProvider VPN Provider
options	Parameters passed through to the SDK, which include Config data.
completionHandler	Completion callback

Parameter	Description
messageData	Binary data, with parameters passed through to the SDK.
completionHandler	Completion callback, with parameters passed through to the SDK.

Methodology	Description
onAccSuccess	Acceleration success callback
onAccFail	Acceleration startup failure
onAccDataUpdate	Network speed callback
onSummaryInfoUpdate	Acceleration summary information update
onNetworkStateChanged	Network adapter link state change callback

Parameter	Description
ip	Acceleration node IP address
port	Acceleration node port

Parameter	Description
error	Determines whether acceleration is terminated normally or abnormally based on the error code.

Parameter	Description
tRx	Total received data volume (unit: byte)
tTx	Total transmitted data volume (unit: byte)
pathDetails	Detailed link information

Parameter	Description
summaryInfo	Acceleration summary information

Parameter	Description
type	0:mobile 1:Wi-Fi
available	NIC availability: true: Available false: Unavailable
ip	NIC IP (IPv4), left blank if unavailable.

Methodology	Description
onStartMpAcc	Enable acceleration (recommended)
onStopMpAcc	Disable acceleration (recommended)
onNoPolicy	No policy is available for the current network state.
onAccException	The acceleration link is abnormal. (In this case, the SDK automatically disables acceleration and switches back to normal mode.)
onRttChanged	Callback for bypass udping rtt latency
onAccStateChanged	Acceleration state change callback

Parameter	Description
code	trigger code 0: Aggregation mode trigger (Aggregation mode is always triggered.) 1: Latency exception trigger 2: Packet loss rate exception trigger 3: Jitter exception trigger

tencent cloud

Multiple Network Acceleration

API Overview

MpAccClient

MpAccClient Properties

MpAccClient Methods

register

start(config:)

stop

getVpnStatus

resumeVpn

updateUDPDirect

updateTCPDirect

setupLogDelegate

setupLogLevel

setupCallbackQueue

registerAccCallback

unRegisterAccCallback

setupDataKey

setSign

setGatewayId

enableOverseas

setupRegisterConnectTimeout

startMeasure

stopMeasure

addEventInfo

registerMeasureCallback

unRegisterMeasureCallback

getSdkVersion

MpPacketTunnelManager

startTunnel

stopTunnel

handleAppMessage

getSdkVersion

setupLogDelegate

registerMeasureCallback

unRegisterMeasureCallback

AccCallback

onAccSuccess

onAccFail

onAccDataUpdate

onSummaryInfoUpdate

onNetworkStateChanged

MpMeasureCallback

onStartMpAcc

onStopMpAcc

onNoPolicy

onAccException

onRttChanged

onAccStateChanged

AccPluginManager

shared

setAccProxyPlugin

getAccProxyPlugin

setLogPlugin

getLogPlugin

Model

AccConfig

Setting extraParams

Parameters Supported by extraParams

AccNode

AccRule

MpMeasureConfig

MpAdditionalOptions

MpPathDetail

NetworkConditions

Error Code Definition

Bantuan dan Dukungan

Parameter	Description
errorCode	Error Code: -6: acc speed test sustained packet loss anomaly -7: acc speed test maximum number of delays anomaly -8: acc speed test vs. Wi-Fi delay anomaly -9: acc speed test average latency exceeds maximum threshold
msg	Error Message

Parameter	Description
state	Acceleration status false: Disable true: Enable
code	0: Enabled 1: Disabled 2: Abnormal Disable

Parameter	Description
accProxyPlugin	SOCKS5 plugin instance For example: setAccProxyPlugin(TRTCAccPlugin()). TRTCAccPlugin can be obtained by importing the plugin package provided by Tencent.

Parameter	Description
logUploadPlugin	Log plugin instance For example: setLogPlugin(LogPlugin()). LogPlugin can be obtained by importing the plugin package provided by Tencent.

Required	Description
node	Acceleration nodes. Mandatory in private cloud deployments. Optional in public cloud deployments. If they are configured, they are prioritized for use.
accMode	Acceleration mode: Enumeration (AccMode) Aggregation (Bonding) Dual-transmit (Redundant) Real-time fast switching (FastSwitching)
pingInterval	Interval for the onAccDataUpdate callback.
congestionMode	Congestion algorithm (BBR / CUBIC)
encryption	Whether encryption is enabled. Default: true.
tcpDirect	Whether TCP direct connection is enabled. Default: false.
udpDirect	Whether UDP direct connection is enabled. Default: false.
udpTimeout	UDP attempt duration
maxReconnectTimeout	Maximum connection timeout. No reconnection attempts are made after this duration is exceeded. Unit: seconds.
accRules	Acceleration rules
priority	Link priority key: 0: mobile, 1: Wi-Fi. The priority.put(0,64) call sets the link priority for type=0 (mobile) to 64. value: The priority is a number ranging from 0-255, where a lower number indicates a higher priority, with a default value of 64. When the priority number is >= 128, it indicates that the link is a backup link.
keepAlive	Configures whether the acc connection is kept alive. If kept alive, the acceleration status is determined by whether UDP acceleration is enabled.
networkConditions	Network conditions required to start acceleration. No conditions are required by default.
groupId	AppGroup
vpnName	VPN name
dnsServerlp	VPN DNS Server IP address. Default: 119.29.29.29.
whiteList	Allowlist. All IP addresses are blocked by default.
blackList	Sets the blocklist.
socksProxyPort	socks proxy port number. The default is 3000. If Acc is used.
socksUsername	Preset username for socks5 proxy.
socksPassword	Preset password for socks5 proxy.
extraParams	Extended parameters, such as keyId, which are passed via extended parameters.
enableMultiNetwork	Whether to enable multiple NICs in EO scenarios. Default: false. false: Default network adapter true: Enumerates available network adapters based on the configured priority. If the priority is not configured, enumerates all available network adapters.
addLineType(:)	Adding acceleration links in EO scenarios. 0: Direct connection, 1: EO.

Method	Description
setBool(_:,forKey:)	Sets the bool-type extraParams parameter.
setString(_:,forKey:)	Sets the String-type extraParams parameter.
setStringList(_:,forKey:)	Sets the [String]-type extraParams parameter.
setInt(_:,forKey:)	Sets the Int-type extraParams parameter.
setFloat(_:,forKey:)	Sets the Float-type extraParams parameter.

KEY	Description
Private cloud-related parameters
AccConfig.KEY_SECRET_KEY_ID	[String] Secret key ID
AccConfig.KEY_CIPHERTEXT	[String] Signature string
AccConfig.KEY_SIGNATURE	[String] Digital signature
Parameters related to the link disabling algorithm
AccConfig.KEY_MAX_RTT_THRESHOLD	[Int] The CheckLatestRTT judgment is performed only when the link latency exceeds this value. Unit: ms. Default: 150 ms.
AccConfig.KEY_MIN_RTT_FACTOR	[Float64] The amplification factor for the minimum link latency. If the current link latency > minimum link latency * factor, the link is considered to have high latency. Default: 15.
AccConfig.KEY_LATEST_RTT_FACTOR	[Float64] The amplification factor for the last sampled latency. If the current link latency > last sampled latency * factor, the link is considered to have high latency. Default: 5.
AccConfig.KEY_MIN_WAITING_WHEN_PATH_FAILED	[Int] Minimum waiting duration for prohibiting link retention. Unit: s. Default: 3s. // Fast switchover.
Fast switch-related parameters
AccConfig.KEY_MIN_SWITCH_RTT	[Int] For fast switchover mode, link switching is not triggered when the latency is below this value. Unit: ms. Default: 20 ms.
AccConfig.KEY_SWITCH_TOLERANCE	[Float64] For fast switchover mode, the tolerance coefficient. The current path latency is amplified and then compared with other paths to avoid frequent switching. Default: 1.125.
AccConfig.KEY_DISABLE_AUTO_SWITCH	[Bool] For fast switchover mode, whether to disable the dynamic switchover feature. Default: false.
AccConfig.KEY_MIN_DELAY_UNTIL_LOST	[Int] For fast switchover mode, the minimum latency for determining packet loss. Link disabling is considered only when the latency exceeds this value. Unit: ms. Default: 150 ms.
AccConfig.KEY_MAX_DELAY_UNTIL_FAILED	[Int] For fast switchover mode, the maximum tolerable time threshold. Packet transmission on the link is disabled when the latency exceeds this threshold. Unit: ms. Default: 460 ms.
AccConfig.KEY_TIME_REORDERING_FRACTION	[Float64] For fast switchover mode, the amplification factor for link latency, used to determine whether a link failure has occurred. Default: 2.25.
Parameters related to aggregation mode
AccConfig.KEY_MAX_RTT_DISABLE_AGGREGATION	[Int] For aggregation mode, the link is excluded from aggregation when its latency exceeds this value. Unit: ms. Default: 460 ms.
UDP Enhanced Aggregation
AccConfig.KEY_JITTER_DELAY	[Int] For UDP enhanced aggregation mode, the compensation latency. Unit: ms. Default: 0 ms.
AccConfig.KEY_PATH_IDLE_TIMEOUT	[Int] For UDP enhanced aggregation mode, the path idle duration. This duration is excluded from compensation. Unit: s. Default: 1 s.
AccConfig.KEY_ENABLE_SINGLE_PATH_SMOOTHING	[Bool] For UDP enhanced aggregation parameters, latency smoothing is also performed on a single path after enabling. Default: false.
AccConfig.KEY_DELAY_FACTOR	[Float64] For UDP enhanced aggregation parameters, used to calculate the one-way smoothed latency. Default: 0.125.
AccConfig.KEY_OUTER_CWND_GAIN	[Float64] quic congestion window gain factor
T2 acceleration 1. AccConfig.KEY_ENABLE_T2ACC must be set to true. 2. Set AccConfig.KEY_T2OUT for cross-domain operations. Otherwise, access may be blocked. 3. AccConfig.KEY_T2_APP_ID_LIST must be configured. Otherwise, rules cannot be matched. 4. AccConfig.dnsServerIp must be set to a non-encrypted resolution server, for example: "162.14.21.56" (Tencent International dns server).
AccConfig.KEY_ENABLE_T2ACC	[Bool] Whether to enable T2 acceleration. Default: false.
AccConfig.KEY_T2OUT	[String] Specifies the T2 segment egress. Default: empty (automatic routing).
AccConfig.KEY_T2_APP_ID_LIST	[String] Specifies the T2 acceleration applications: App ID List.
AccConfig.KEY_T2ACC_IP_PREFIX_BLACKLIST	[String] T2 acceleration IP address CIDR blocklist (Direct).
AccConfig.KEY_T2ACC_IP_PREFIX_WHITELIST	[String] T2 acceleration IP CIDR allowlist (ACC).
AccConfig.KEY_T2ACC_DOMAIN_BLACKLIST	[String] T2 acceleration domain blocklist (Direct).
AccConfig.KEY_T2ACC_DOMAIN_WHITELIST	[String] T2 acceleration domain allowlist (ACC).
AccConfig.KEY_T2ACC_DOMAIN_SUFFIX_BLACKLIST	[String] T2 acceleration domain suffix blocklist (Direct).
AccConfig.KEY_T2ACC_DOMAIN_SUFFIX_WHITELIST	[String] T2 acceleration domain suffix allowlist (ACC).
Others
AccConfig.KEY_SERVER_DOMAIN	[String] Certificate domain name
AccConfig.KEY_ALLOW_PRIVATE	[Bool] Allows private network interconnection.
AccConfig.KEY_MAX_RETRY_TIMES	[Int] The maximum number of retries. Default: 3. Avoid setting it to 0, as this may cause issues when there is no network connectivity.
AccConfig.KEY_ENABLE_OBFUSCATED	[Bool] Whether to enable origin IP address obfuscation.

Required	Description
ipList	Node IP list, empty by default.
port	Node port, with a default value of -1.

Required	Description
addr	The speed test address (for private cloud setup) is in the format "IP address:PORT". Multiple probe points are separated by semicolons, for example, "172.17.0.4:9000;172.17.0.4:9001".
t2AccProbeAddr	T2 segment speed test address
time	Sliding window measurement time (ms), default 30000
rtt	Latency threshold, default 90
loss	Packet loss rate threshold, default 5
jitter	Jitter threshold, default 15
quickTime	Quick start window time, default 10000
quickRtt	Quick start latency threshold, default 100
interval	Measurement callback frequency, default 1000
mode	Acceleration mode. Options: 1: bonding, 2: redundant, 3: RTC. Default: 2.
delayRemindTime	Delay reminder time, unit: milliseconds, default 10000
pingTimeout	ping packet timeout, unit: ms
disableQuickDetect	Disables quick detection. true: Disable false: Do not disable
additionalOptions	Fallback attachment options
disableSlaveLossDetect	Disables packet loss detection on the secondary path. true: Disable false: Do not disable
Common speed test addresses: usable as T1 and T2 segment speed test addresses.
FRANKFURT_ADDRESS	162.62.215.101:8888
SILICON_VALLEY_ADDRESS	43.130.30.222:8888
SAO_PAULO_ADDRESS	43.135.207.42:8888
TOKYO_ADDRESS	43.128.254.208:8888
BANGKOK_ADDRESS	43.128.200.25:8888
SINGAPORE_ADDRESS	101.33.46.84:8888
HONG_KONG_ADDRESS	43.159.234.5:8888

Required	Description
packetLossEscape	The acceleration link is disconnected for [packetLossCount] consecutive times.
maxRttEscape	The ping value of the acceleration link is greater than or equal to [rttThreshold] ms for [maxRttCount] consecutive times.
rttExceptionEscape	The average ping value of the acceleration link over [detectWindowTime] is greater than that of the primary link by [rttDiffThreshold]%, and the average latency of the acc link is greater than [accBenchmarkRtt] ms.
stopAccRemind	If the average latency of the acceleration link within [detectWindowTime] is greater than that of the primary link by [rttDiffRate]%, and the jitter is greater than that of the primary link by [jitterRate]%, it is recommended to disable acceleration.