Speedify

Subscribe to this delegate if you wish to be alerted when the SpeedifySDK returns the current:

• State
• AdapterData
• ConnectionStats
• Settings

Current shared Instance of Speedify.

Current Speedify State.

Current Daemon Version.

Current AdapterData. If set to nil, no data available.

Current ServerInformation. If set to nil, no server is connected.

Current Settings. If set to nil, no settings are present.

Current ConnectionStats. If set to nil, no ConnectionStats are present.

Current accountingData. If set to nil, no accountingData is present.

Current privacySettings. If set to nil, no privacySettings are present.

Current extensionState. If set to nil, the extension has not been started.

Current DisconnectReason. If set to nil, there are no current disconnect reasons.

When ‘true’ the extensions daemon is ready to receive messages.

Setting to true will tell the sdk not to send any messages to the extension until it is fully connected

Current VPN Manager NEVPNManager. This property allows a user to determine the existing profile settings

• @since 11.8

Callbacks for the SpeedifyStateDelegate

Callbacks for the SpeedifyVendorUserDataDelegate

Callbacks for the SpeedifyAdapterDelegate

Callbacks for the SpeedifyAccountingDelegate

Callbacks for the SpeedifySessionStatsPeriodDelegate

Callbacks for the SpeedifyConnectionStatsDelegate

Callbacks for the SpeedifySettingsDelegate

Callbacks for the SpeedifySettingsErrorDelegate

Callbacks for the SpeedifyVendorLocalSettingsDelegate

Callbacks for the SpeedifyVendorRemoteSettingsDelegate

Callbacks for the SpeedifyFirewallSettingsDelegate

Callbacks for the SpeedifyDomainWatchListDelegate

Callbacks for the SpeedifyStreamingStatsDelegate

Callbacks for the SpeedifyTunnelDelegate

Callbacks for the SpeedifyLocalProxySettingsDelegate

Callbacks for the SpeedifyDirectoryDomainDelegate

Callbacks for the SpeedifyConnectedServerDelegate

Callbacks for the SpeedifyLastDisconnectDelegate

Callbacks for the SpeedifyLogSettingsDelegate

Callbacks for the SpeedifyLogSettingsDelegate

Callbacks for the SpeedifySpeedTestResultsDelegate

Callbacks for the SpeedifyServerSettingsDelegate

Callbacks for the SpeedifyTrafficRulesDelegate

Callbacks for the SpeedifyDisconnectEventDelegate

Callbacks for the SpeedifyCaptivePortalDelegate

Callbacks for the SpeedifyLoginErrorDelegate

This calls update to refresh the current state, version, settings, connections and privacy settings.

The will refresh state, accounting, connections, directory, settings, privacy settings, vendor local settings, remote vendor settings, vendor user data, firewall and directory

Start the PacketTunnel app extension.

This must be called to ensure message accuracy and the ability to keep the tunnel open. This checks the app extension state for

• Invalid
• Disconnecting
• Disconnected

Upon reaching these states the function ensures the tunnel will be open. The timer fires every second to check the Tunnel State.

Sets the app name used for autoaccounts. @param name new app name @since 11.8

• @method hasVPNPermissionWithCompletionHandler:
• @discussion This function asynchronously reads all of the NETunnelProvider configurations created by the calling app that have previously been saved to disk and returns true if a configuration is found.

• @method initializeVPNPermissionWithCompletionHandler:

• @method resetVpnProfileWithCompletionHandler:

• @method profileIncludesAllRoutes: This checks the current profiles value for it’s protocol configuration’s key includesAllNetworks

This will stop the tunnel and tear down the extension

Connect to a server by an automatic selection method. If already connected, this will disconnect before reconnecting. Unless called with bysetting, which will not trigger a reconnect.

• closest: Closest public or private server to user
• closestPrivate: Closest private server to user
• last: Selects the last connected server

• p2p: Server that supports P2P/BitTorrent

Connect to a server by an automatic selection method. If already connected, this will disconnect before reconnecting.

Connect to a server with a specific city. If already connected, this will disconnect before reconnecting.

Connect to a server with a specific country. If already connected, this will disconnect before reconnecting.

Connect to a server with a specific server number i.e 5. If already connected, this will disconnect before reconnecting.

Connect to a specific server, without fallback. If already connected, this will disconnect before reconnecting. A list of valid servers can be obtained from {@link ISdkStateReceiver#OnDirectory OnDirectory}. Connect errors will be signalled in {@link ISdkStateReceiver#OnConnectError OnConnectError}. Chosen server will be signalled via {@link ISdkStateReceiver#OnConnectedServer OnConnectedServer} as connections to them are attempted.

@param country 2-char ISO country code @param city city name @param num server number @since 14.0

Set the default connection method to a specific server, without fallback. Current settings available from {@link ISdkStateReceiver#OnServerSettings OnServerSettings}.

@param country 2-char ISO country code @param city city name @param num server number @since 14.0

• Set the default connection method to an automatic selection method.
• Current settings available from SpeedifyServerSettingsDelegate.
• @since 9.4

Disconnect from the server.

Authenticate a new user.

setAppName must be called before this.

Logs out of any current account and logs in to an automatically generated account for this device. setAppName must be called before this. If setting a custom directory, call ‘changeDirectoryURL(url: String)’ before calling this. This may take several seconds as the OS is queryied for the device id Login or auto-account creation errors will be signalled in ‘ErrorType’ return in the ‘login(username: String, password: String, completionHandler:@escaping (_ message: State?, _ error: ErrorType)->Void’ closure. Automatic accounts have false email address in the form of .@autoaccount.speedify.com.

• Comcast Loopback Function setAppName must be called before this.
• @since 10.6

Logs out of any current account and logs in to an automatically generated account for this device. setAppName must be called before this. If setting a custom directory, call ‘changeDirectoryURL(url: String)’ before calling this. This may take several seconds as the OS is queryied for the device id Login or auto-account creation errors will be signalled in ‘ErrorType’ return in the ‘login(username: String, password: String, completionHandler:@escaping (_ message: State?, _ error: ErrorType)->Void’ closure. Automatic accounts have false email address in the form of .@autoaccount.speedify.com.

Logs out of any current account and logs in to an automatically generated account for this device. setAppName must be called before this. If setting a custom directory, call ‘changeDirectoryURL(url: String)’ before calling this. This may take several seconds as the OS is queryied for the device id Login or auto-account creation errors will be signalled in ‘ErrorType’ return in the ‘login(username: String, password: String, completionHandler:@escaping (_ message: State?, _ error: ErrorType)->Void’ closure. Automatic accounts have false email address in the form of .@autoaccount.speedify.com.

• Authenticate a new user using oauth access token. You are responsible for fetching updated access tokens if you use this method.
• setAppName must be called before this.
• If setting a custom directory, call changeDirectoryURL(url: String) before calling this.
• Login errors will be signalled in completionHandler error.
• An expired access token will give an error of ErrorType.token_expired, while invalid tokens will give ErrorType.credential. *

• Authenticate a new user using oauth access token. You are responsible for fetching updated access tokens if you use this method.
• setAppName must be called before this.
• If setting a custom directory, call changeDirectoryURL(url: String) before calling this.
• Login errors will be signalled in completionHandler error.
• An expired access token will give an error of ErrorType.token_expired, while invalid tokens will give ErrorType.credential. *
• @since 12.8

Refreshes the current oauth access token. The application is responsible for fetching updated access tokens if using this method. If not logged in or logged in not using oauth, this will initiate a new login. Otherwise, the new token is stored to be used for future requests. Calling this from a logged in state presumes this is a token for the same user. If setting a custom directory, call public func setDirectoryWithDomain(domain: String, completionHandler:@escaping (_ directory: DirectorySettings)->Void) before calling this. Login errors will be signalled in SpeedifyLoginErrorDelegate. An expired access token will give an error of type ErrorType.TOKEN_EXPIRED, while invalid tokens will give ErrorType.CREDENTIAL.

@param newOAuthAccessToken New access token for the user you wish to authenticate @since 12.7

This will log the current user out.

Logout the current user.

Change the basic mode of operation, between optimizing for speed or maximizing reliability.

Get a list of available servers from the directory list.

• Change directory server used for user authentication and server management.
• If using your own directory server, this must be called before login or loginAutoAccount.

• Change directory server used for user authentication and server management.

• If using your own directory server, this must be called before login or loginAutoAccount.

• Set an oauth gateway to use for directory server requests.
• If using your own directory gateway, this must be called before login or loginAutoAccount.
• Triggers SpeedifyDirectoryDomainDelegate, and (if logged in) {@link ISpeedifyHandler#OnDirectory OnDirectory} on domain change.
• @since 10.5

• Sets if credentials will not be stored. *
• This includes passwords, OAuth tokens, and Safe Browsing init config.
• Triggers SpeedifySDKDelegate privacySettingsDidUpdate
• If true, automatic login and connect at boot will not work.
• @since 10.5

Reset the directory oauth gateway to defaults. Triggers SpeedifyDirectoryDomainDelegate. @since 10.5

Reset the directory server to defaults.

Sets if ESNI is used when talking to the directory domain If using your own directory server, this must be called before login or loginAutoAccount. Triggers SpeedifyDirectoryDomainDelegate.

Set the downstream subnets available on this device. Current value available from settings delegate. @param subnets the downstream subnets available on this device @since 14.0

Get the current State.

Objective-C’s implementation to read state

Get the libspeedify version.

Gets an activation code usable to login on the website.

• If setting a custom directory, call SetDirectoryDomain() before calling this.
• @since 14.0

• Sets if settings in the local proxy domain watchlist entries are applied
• @since 13.2

Resets the local proxy domain watchlist entries to their default settings @since 13.2

Subscribe or Unsubscribe from receiving the tunnel ConnectionStats and SessionStats.

Example of some SessionStats.

• Number of Failovers
• Total Connected Minutes
• Fastest Connected Mbps

Example of some ConnectionStats.

• Time Connected
• total bytes per second

• guid

Enable periodic connection stats, adapter list updates, session stats, and streaming stats to be sent while Speedify is connected

• Set vendor user data
• Current value available from SpeedifyVendorUserDataDelegate.
• Discussion: You may send a JSON string to be saved inside of vendorUserData but be sure it is valid JSON or it will be ignored.
• vendorSettings user data string
• @since 9.8

Gets the vendor user data Triggers SpeedifyVendorUserDataDelegate. @since 9.8

Requests information about the current connected VPN server You can read the value back via serverInformation or subscribe to serverSettingsReported or serverInformationDidUpdate @since 14.0

Get configuration of the local proxy Triggers SpeedifyLocalProxySettingsDelegate. @since 9.2

Set local vendor settings @param settingsJson a json object

• Current value available from SpeedifyVendorLocalSettingsDelegate. @param merge if true, settingsJson is merged in to existing local vendor settings. if false, settingsJson replaces existing local vendor settings @since 9.2

Gets the local vendor settings @since 9.2

Refreshes streaming stats. @since 9.6

Get configuration of the firewall @since 9.2

Set the mode used by the firewall. @param mode how matches are treated @since 9.2

Set domains to firewall. @param domains domain names to deny/allow @since 9.2

Set IPv6 address to firewall. @param ipv6 ipv6 addresses to deny/allow @since 9.3

Set domain watchlist settings for the local proxy @param domainWatchlist domain watchlist items Triggers delegate localProxySettingsDidUpdate @since 9.3

Set domain watchlist settings for the local proxy If connected, this triggers a reconnect. Triggers delegate localProxySettingsDidUpdate @param domainWatchlist domain watchlist items @since 11.2

Enables or disables the local proxy.

• @param enabled enable the local proxy
• Triggers delegate localProxySettingsDidUpdate
• @since 11.2

Set the match mode used by the local proxy. @param matchMode how matches are treated Triggers delegate localProxySettingsDidUpdate @since 11.2

Set domains to proxy locally, instead of going through the VPN. @param domains domain names to redirect through the local proxy Triggers LocalProxySettingsDelegate. @since 11.2

Set IPv4 address to proxy locally, instead of going through the VPN. @param ipv4 ipv4 addresses to redirect through the local proxy Triggers delegate localProxySettingsDidUpdate @since 11.2

Set IPv4 address to firewall. @param ipv4 ipv4 addresses to deny/allow @since 9.2

Set ports to firewall. @param ports ports to be firewalled @since 9.2

Gets the remote vendor settings @since 9.2

Change the ConnectionPriority of each connection on the device.

• Call the function getConnections(completionHandler:@escaping (_ message: Dictionary<String, Any>)->Void) before calling this function to ensure adapters are present.

Possible ConnectionPriority options include

• ALWAYS = 0
• SECONDARY = 1
• BACKUP = 2

• NEVER = 100

Set if automatic priority is allowed. Current settings available from SpeedifySettings.

@param enabled if allowed @since 12.4

Change which directory servers to connect with.

• If using your own directory server, this should always be called before login() or loginAutoAccount().

Change the encryption settings per adapter.

Change the encryption settings on the tunnel.

Allow or disallow use of ChaCha for connection encryptions. Current value available from Settings.

Set reporting encryption key.

Set the overflow threshold.

Set the priority overflow threshold, which is used when there is active priority traffic (i.e. real-time streams).

Adds additional bytes to the adapter’s daily data usage limit for today. This value is not added to the base daily data usage limit.

Set the data usage, in bytes, allowed on this adapter in a single day. Setting allowedBytes to 0 will disable this limit. Cellular adapters default to 200MB/month.

Set the data usage, in bytes, allowed on this adapter in a single month. 0 for unlimited

Sets the adapter to unlimited daily data usage. Current value available on AdapterData

Sets the adapter to unlimited monthly data usage. Current value available on AdapterData

Acknowledge and clear message about a new adapter.

Set the download and upload speed rate limit on a connection.

• @deprecated as of 15.4. Use setConnectionRateLimit with download and upload separately

Set the download and upload speed rate limit on a connection.

Will return the last 5 minutes worth of ConnectionStats *Important - This will not return anything on initial connect.

This allows the extension to request supported event updates.

Will trigger SpeedifySettingsDelegate

Set domains to identified as streams. Triggers ‘SpeedifyStreamingSettingsDelegate’. @param domains domain names to be identified as streams @since 10.9

• Set IPv4 address to identified as streams.
• Triggers ‘SpeedifyStreamingSettingsDelegate’.
• @since 10.9

• Set IPv6 address to identified as streams. ** Triggers ‘SpeedifyStreamingSettingsDelegate’.
• @since 10.9

• Set ports to identified as streams. ** Triggers ‘SpeedifyStreamingSettingsDelegate’.
• @since 10.9

Set the language used for error messages

• Triggers SpeedifySettingsDelegate.
• @since 10.8

Set IP address ranges to exclude from going over the VPN tunnel This change takes effect on the next VPN connect. Current value available from delegate settingsDidUpdate.

Sets the TransportMode selection used for each connection. Current value available from delegate settingsDidUpdate.

Sets whether to allow jumbo packets over the VPN tunnel. Current value available from delegate settingsDidUpdate.

Sets whether to allow header compression on packets over the VPN tunnel. Current value available from delegate settingsDidUpdate.

Set if Speedify should autmatically connect when the daemon starts. Triggers ‘SpeedifySettingsDelegate’. @param enabled automatically connect @since 9.4

Allows other apps to bind their sockets around the VPN tunnel, directly on other network adapters. Current value available from delegate privacySettingsDidUpdate. Default Value is true. @since 11.9.2

Refresh account data. Current value available from delegate accountingDataDidUpdate.

Sets how to handle an adapter that has hit its daily or monthly data limit. Current value available on AdapterData objects returned from AdapterUsageData.

Tells the daemon to stop alerting the SDK about an adapter’s overlimit status

Copies logs created by the daemon into the shared App Group Container

• App Group Capabilities are mandatory when creating logs Please add the following key to the Container and PacketTunnel info.plist NSExtensionFileProviderDocumentGroup YOUR APP GROUP NAME

• Invalid
• Disconnected
• Disconnecting
• Connecting
• Connected
• Reasserting

• Set IP addresses of the DNS servers to use

• Current value available from PrivacySettings.

Toggles VPN On Demand.

When On Demand is on, the operating system will automatically reconnect the VPN whenever internet is available. This setting persists across reboots (so if you set it on, the device will automatically reconnect the VPN after reboot).

Check if the onDemand setting is currently enabled.

Checks connected networks for captive portals Triggers {@link ISpeedifyHandler#OnCaptivePortals OnCaptivePortals}. @since 11.3

Enable captive portal mode, sending all traffic over the specified network @param adapterID network to operate captive portal mode over @since 11.3

Enable captive portal mode, sending all traffic over the specified network @param adapterID network to operate captive portal mode over @since 11.3

Erase all log files and log zips.

Note that the current active log file is not erased. @since 10.5

Refresh privacy settings. Triggers privacySettingsDidUpdate

Get the last session disconnect event Triggers ‘SpeedifyLastDisconnectDelegate. Discussion: If the reason happens when closing the tunnel (SUPERCEDED, CONFIGURATIONDISABLED etc.) then the reason will not be updated in the database until the next extension launch. @since 10.4

• Check if there is already an account using this email address.

• @since 7.4

• @deprecated as of 15.4. Functionality removed

• Resets the tracked data usage on an adapter.

• @since 7.8.3

• Create a new account using this email address.

• @since 7.4

• @deprecated as of 15.4. Functionality removed

Request new session stats @since 9.5

Request the connected server settigns

Get configuration of streaming settings. Triggers {@link ISpeedifyHandler#OnStreamingSettings OnStreamingSettings}. @since 10.9

• Change the password on the account.
• @since 7.4
• @deprecated as of 15.4. Functionality removed

• Set ports to be forwarded to this client when connected to a dedicated server.
• Current value available from ‘SpeedifySettingsDelegate’
• @since 8.2

Set ports to proxy. Triggers LocalProxySettingsDelegate. @param ports ports to be proxied @since 9.9

This will cancel an auto connect request.

Requests that Speedify run a speed test to completion. May be cancelled with stopSpeedTest. The generated traffic is passed through the TUN device.

The daemon (Network Extension), when generating traffic, does not send that traffic through the TUN. The OS prevents us from binding directly to the TUN device. Rather, the UI process can generate traffic for us.

@param guid An optional unique adapter ID for this stream test run on, or omitted to allow traffic on all available adapters. @since 11.0

Requests that Speedify run a stream test to completion. May be cancelled with stopStreamTest. Like the speed test, generated traffic is passed through the TUN device and relies on the UI process to produce the traffic.

@param guid An optional unique adapter ID for this stream test run on, or omitted to allow traffic on all available adapters. @since 11.0

Requests the daemon to stop the current speed test. Note that this applies to both speed and stream tests. @since 11.0

Requests the current speed test results. @since 11.0

macOS Only. Clear settings from the daemon. This will restart the service if successful.

@method getExtensionVerisonWithCompletionHandler @discussion This returns the current network extensions CFBundleShortVersionString.

• @since 10.9

Tells the delegate the current ‘State’.

Tells the delegate the current ‘AdapterData’.

Tells the delegate the current ‘ConnectionStats’.

Tells the delegate the current ‘Settings’.

Requests that browsers do not use DNS over HTTPS. DoH can interfere with domain-based local proxy, firewall, and streaming settings. @param disable If DoH is requested to be disabled @since 12.2

Sets the ULP reporting inverval in seconds. @param interval: The interval in seconds. @since 12.8

Speedify follows a backoff pattern for repeated errors when logging in or connecting to VPN servers. With each subsequent failure, the wait time increases before attempting to login or connect again. The backoff’s timeout limit can be set with this call. @param timeout Timeout in seconds @since 14.6

When Speedify fails to establish VPN transport connections over an Internet connection, it will use a backoff pattern to wait before attempting to establish a transport over that connection again. This call is used to set that backoff timeout limit. @param timeout Timeout in seconds @since 14.6

Sets if advanced ISP stats should be enabled

@param enabled If advanced ISP stats should be enabled Triggers PrivacySettingsDelegate. @since 15.6

Generates new ulp data report with feedback message attached @param feedback feedback message @since 14.7

Sets the target delay that is applied to packets in each direction for selected flows. The SDK attempts to deliver packets with a consistent latency (jitter buffer).

• Current value available from SpeedifySettingsDelegate.
• @param delay number of ms to delay / buffer packets, 0 (no delay) disables the feature
• @since 16.0

Get Traffic Rules settings.

• Triggers SpeedifyTrafficRulesDelegate. *
• @since 16.0

Set Traffic Rules

• Triggers SpeedifyTrafficRulesDelegate. *
• @param rulesJson traffic rules as a JSON array
• @since 16.0

Set domains to have a fixed delay applied

• Triggers SpeedifyTrafficRulesDelegate. *
• @param domains domain names to have a fixed delay applied
• @param method method to use for the traffic rule change
• @since 16.0

Set IP addresses to have a fixed delay applied.

• Triggers SpeedifyTrafficRulesDelegate. *
• @param ips ip address strings to have a fixed delay applied
• @param method method to use for the traffic rule change
• @since 16.0

Set ports to have a fixed delay applied

• Ports should be in host byte order.
• Triggers SpeedifyTrafficRulesDelegate. *
• @param ports ports to have a fixed delay applied
• @param method method to use for the traffic rule change
• @since 16.0