Detailed Description

Main Speedify SDK calls.

The main interface to the Speedify SDK for Desktop
For all methods that take a callback, specifying a callback of NULL will perform synchronous calls. If your specify a callback, this method will not block and your callback will be called from another thread.
Methods marked 'Supports Subscription' support subscribing to updates for that result. Return true from the callback to continue receiving updates. Return false to stop. The result object returned from these methods includes an eventId that can be used to disable further updates;
Methods marked 'Subscription Only' must be given a callback.

Functions
CSpeedifySDK	SpeedifySDK_Create (uint16_t port)
	Create a new SDK object. More...

CSpeedifySDK	SpeedifySDK_CreateWithSettings (SpeedifySDK_CreateSettings settings)
	Create a new SDK object. More...

void	SpeedifySDK_Destroy (CSpeedifySDK sdk)
	Destroys an SDK object. More...

SpeedifySDK_StateResult	SpeedifySDK_GetState (CSpeedifySDK sdk, SpeedifySDK_StateCallback cb, void *userData)
	Get the current state of Speedify. More...

SpeedifySDK_VersionResult	SpeedifySDK_GetVersion (CSpeedifySDK sdk, SpeedifySDK_VersionCallback cb, void *userData)
	Get the version of the connected Speedify daemon. More...

SpeedifySDK_ConnectResult	SpeedifySDK_ConnectAuto (CSpeedifySDK sdk, SpeedifySDK_AutoConnectMethod method, SpeedifySDK_ConnectCallback cb, void *userData)
	Connect to a server by an automatic selection method. More...

SpeedifySDK_ConnectResult	SpeedifySDK_ConnectCountry (CSpeedifySDK sdk, const char country, SpeedifySDK_ConnectCallback cb, void userData)
	Connect to a server by server country. More...

SpeedifySDK_ConnectResult	SpeedifySDK_ConnectCity (CSpeedifySDK sdk, const char country, const char city, SpeedifySDK_ConnectCallback cb, void *userData)
	Connect to a server by server city. More...

SpeedifySDK_ConnectResult	SpeedifySDK_ConnectServer (CSpeedifySDK sdk, const char country, const char city, int32_t num, SpeedifySDK_ConnectCallback cb, void *userData)
	Connect to a specific server. More...

SpeedifySDK_ConnectResult	SpeedifySDK_ConnectProxy (CSpeedifySDK sdk, SpeedifySDK_ConnectCallback cb, void *userData)
	Runs the Speedify VPN as a local proxy, without a connection to a remote server. More...

SpeedifySDK_StateResult	SpeedifySDK_Disconnect (CSpeedifySDK sdk, SpeedifySDK_StateCallback cb, void *userData)
	Disconnect from the server if connected, or cancel a connection attempt if currenty connecting. More...

SpeedifySDK_StateResult	SpeedifySDK_Login (CSpeedifySDK sdk, const char username, const char password, SpeedifySDK_StateCallback cb, void *userData)
	Authenticate a new user. More...

SpeedifySDK_StateResult	SpeedifySDK_LoginOAuth (CSpeedifySDK sdk, const char oauthAccessToken, SpeedifySDK_StateCallback cb, void userData)
	Authenticate a new user using an oauth access token. More...

SpeedifySDK_StateResult	SpeedifySDK_LoginAutoAccount (CSpeedifySDK sdk, SpeedifySDK_StateCallback cb, void *userData)
	Logs out of any current account and logs in to an automatically generated account for this device. More...

SpeedifySDK_StateResult	SpeedifySDK_LoginLocalLoopbackOnly (CSpeedifySDK sdk, SpeedifySDK_StateCallback cb, void *userData)
	Comcast Loopback Function. More...

SpeedifySDK_StateResult	SpeedifySDK_Logout (CSpeedifySDK sdk, SpeedifySDK_StateCallback cb, void *userData)
	Logout the current user. More...

SpeedifySDK_AccountCheckResult	SpeedifySDK_AccountCheck (CSpeedifySDK sdk, const char email, SpeedifySDK_AccountCheckCallback cb, void userData)
	Check if there is already an account using this email address. More...

SpeedifySDK_AccountCreateResult	SpeedifySDK_AccountCreate (CSpeedifySDK sdk, const char email, const char password, SpeedifySDK_AccountCreateCallback cb, void *userData)
	Create a new account using this email address. More...

SpeedifySDK_AccountPasswordChangeResult	SpeedifySDK_AccountPasswordChange (CSpeedifySDK sdk, const char email, const char originalPassword, const char newPassword, SpeedifySDK_AccountPasswordChangeCallback cb, void userData)
	Change the password on the account. More...

SpeedifySDK_DirectoryResult	SpeedifySDK_GetDirectory (CSpeedifySDK sdk, SpeedifySDK_DirectoryCallback cb, void *userData)
	Get a list of available servers from the directory list. More...

SpeedifySDK_ConnectResult	SpeedifySDK_GetConnectedServer (CSpeedifySDK sdk, SpeedifySDK_ConnectCallback cb, void *userData)
	Get the currently or last connected server. More...

SpeedifySDK_DirectorySettingsResult	SpeedifySDK_SetESNIEnabled (CSpeedifySDK sdk, bool enableEsni, SpeedifySDK_DirectorySettingsCallback cb, void *userData)
	Sets if ESNI is used when talking to the directory domain. More...

SpeedifySDK_DirectorySettingsResult	SpeedifySDK_SetDirectoryDomain (CSpeedifySDK sdk, const char domain, SpeedifySDK_DirectorySettingsCallback cb, void userData)
	Change directory server used for user authentication and server management. More...

SpeedifySDK_DirectorySettingsResult	SpeedifySDK_ResetDirectoryDomain (CSpeedifySDK sdk, SpeedifySDK_DirectorySettingsCallback cb, void *userData)
	Reset the directory server to defaults. More...

SpeedifySDK_DirectorySettingsResult	SpeedifySDK_SetDirectoryGatewayURI (CSpeedifySDK sdk, const char gatewayUri, SpeedifySDK_DirectorySettingsCallback cb, void userData)
	Set an oauth gateway to use for directory server requests. More...

SpeedifySDK_DirectorySettingsResult	SpeedifySDK_ResetDirectoryGatewayURI (CSpeedifySDK sdk, SpeedifySDK_DirectorySettingsCallback cb, void *userData)
	Reset the directory oauth gateway to defaults. More...

SpeedifySDK_DirectorySettingsResult	SpeedifySDK_GetDirectoryDomain (CSpeedifySDK sdk, SpeedifySDK_DirectorySettingsCallback cb, void *userData)
	Get the directory server being used. More...

SpeedifySDK_DirectorySettingsResult	SpeedifySDK_GetDirectorySettings (CSpeedifySDK sdk, SpeedifySDK_DirectorySettingsCallback cb, void *userData)
	Get the directory settings. More...

SpeedifySDK_AccountingResult	SpeedifySDK_GetAccountingData (CSpeedifySDK sdk, SpeedifySDK_AccountingCallback cb, void *userData)
	Gets information on the currently used account. More...

SpeedifySDK_ServerSettingsResult	SpeedifySDK_GetServerSettings (CSpeedifySDK sdk, SpeedifySDK_ServerSettingsCallback cb, void *userData)
	Get the default connection method. More...

SpeedifySDK_ServerSettingsResult	SpeedifySDK_SetConnectMethodAuto (CSpeedifySDK sdk, SpeedifySDK_AutoConnectMethod method, SpeedifySDK_ServerSettingsCallback cb, void *userData)
	Set the default connection method to an automatic selection method. More...

SpeedifySDK_ServerSettingsResult	SpeedifySDK_SetConnectMethodCountry (CSpeedifySDK sdk, const char country, SpeedifySDK_ServerSettingsCallback cb, void userData)
	Set the default connection method to a specific country. More...

SpeedifySDK_ServerSettingsResult	SpeedifySDK_SetConnectMethodCity (CSpeedifySDK sdk, const char country, const char city, SpeedifySDK_ServerSettingsCallback cb, void *userData)
	Set the default connection method to a specific city. More...

SpeedifySDK_ServerSettingsResult	SpeedifySDK_SetConnectMethodServer (CSpeedifySDK sdk, const char country, const char city, int32_t num, SpeedifySDK_ServerSettingsCallback cb, void *userData)
	Set the default connection method to a specific server. More...

SpeedifySDK_SettingsResult	SpeedifySDK_GetSettings (CSpeedifySDK sdk, SpeedifySDK_SettingsCallback cb, void *userData)
	Get general connecttion settings. More...

SpeedifySDK_SettingsResult	SpeedifySDK_SetEnableDefaultRoute (CSpeedifySDK sdk, bool enabled, SpeedifySDK_SettingsCallback cb, void *userData)
	Set whether the default route (0.0.0.0/0) goes over the VPN tunnel. More...

SpeedifySDK_SettingsResult	SpeedifySDK_SetJumboPackets (CSpeedifySDK sdk, bool enabled, SpeedifySDK_SettingsCallback cb, void *userData)
	Sets whether to allow jumbo packets over the VPN tunnel. More...

SpeedifySDK_SettingsResult	SpeedifySDK_SetAllowChaChaEncryption (CSpeedifySDK sdk, bool enabled, SpeedifySDK_SettingsCallback cb, void *userData)
	Allow or disallow use of ChaCha for connection encryptions. More...

SpeedifySDK_SettingsResult	SpeedifySDK_SetTunnelEncrypted (CSpeedifySDK sdk, bool enabled, SpeedifySDK_SettingsCallback cb, void *userData)
	Sets encryption status on all connections forming the tunnels. More...

SpeedifySDK_SettingsResult	SpeedifySDK_SetMode (CSpeedifySDK sdk, SpeedifySDK_BondingMode mode, SpeedifySDK_SettingsCallback cb, void *userData)
	Change the basic mode of operation, between optimizing for speed or maximizing reliability. More...

SpeedifySDK_SettingsResult	SpeedifySDK_SetStartupConnect (CSpeedifySDK sdk, bool enabled, SpeedifySDK_SettingsCallback cb, void *userData)
	Set if Speedify should autmatically connect when the daemon starts. More...

SpeedifySDK_SettingsResult	SpeedifySDK_SetConnectionTransportMode (CSpeedifySDK sdk, SpeedifySDK_TransportMode mode, SpeedifySDK_SettingsCallback cb, void *userData)
	Sets the transport mode selection used for each connection. More...

SpeedifySDK_SettingsResult	SpeedifySDK_SetForwardPorts (CSpeedifySDK sdk, uint16_t count, SpeedifySDK_ForwardedPort ports, SpeedifySDK_SettingsCallback cb, void userData)
	Set ports to be forwarded to this client when connected to a dedicated server. More...

SpeedifySDK_SettingsResult	SpeedifySDK_SetOverflowThreshold (CSpeedifySDK sdk, double mbpsOverflow, SpeedifySDK_SettingsCallback cb, void *userData)
	Set the overflow threshold. More...

SpeedifySDK_SettingsResult	SpeedifySDK_SetPacketAggregation (CSpeedifySDK sdk, bool enabled, SpeedifySDK_SettingsCallback cb, void *userData)
	Sets whether to allow aggregating smaller packets sent over the VPN. More...

SpeedifySDK_PrivacySettingsResult	SpeedifySDK_GetPrivacySettings (CSpeedifySDK sdk, SpeedifySDK_PrivacySettingsCallback cb, void *userData)
	Gets privacy settings. More...

SpeedifySDK_PrivacySettingsResult	SpeedifySDK_SetCrashReports (CSpeedifySDK sdk, bool enabled, SpeedifySDK_PrivacySettingsCallback cb, void *userData)
	Sets if crash reporting should be enabled. More...

SpeedifySDK_PrivacySettingsResult	SpeedifySDK_SetDoNotStoreCredentials (CSpeedifySDK sdk, bool doNotStore, SpeedifySDK_PrivacySettingsCallback cb, void *userData)
	Sets if credentials will not be stored. More...

SpeedifySDK_PrivacySettingsResult	SpeedifySDK_SetKillswitch (CSpeedifySDK sdk, bool enabled, SpeedifySDK_PrivacySettingsCallback cb, void *userData)
	Sets if Internet Killswitch should be enabled. More...

SpeedifySDK_PrivacySettingsResult	SpeedifySDK_SetDnsLeak (CSpeedifySDK sdk, bool enabled, SpeedifySDK_PrivacySettingsCallback cb, void *userData)
	Sets if DNS Leak protection is enabled. More...

SpeedifySDK_PrivacySettingsResult	SpeedifySDK_SetIpLeak (CSpeedifySDK sdk, bool enabled, SpeedifySDK_PrivacySettingsCallback cb, void *userData)
	Sets if IP Leak protection is enabled. More...

SpeedifySDK_PrivacySettingsResult	SpeedifySDK_SetDNSServers (CSpeedifySDK sdk, uint16_t count, SpeedifySDK_IPAddressString dnsAddrs, SpeedifySDK_PrivacySettingsCallback cb, void userData)
	Sets DNS servers to use. More...

SpeedifySDK_AdaptersResult	SpeedifySDK_GetAdapters (CSpeedifySDK sdk, SpeedifySDK_AdaptersCallback cb, void *userData)
	Gets a list of current adapters. More...

SpeedifySDK_AdaptersResult	SpeedifySDK_SetConnectionPriorities (CSpeedifySDK sdk, const char adapterID, SpeedifySDK_ConnectionPriority priority, SpeedifySDK_AdaptersCallback cb, void userData)
	Change priorities of a connection. More...

SpeedifySDK_AdaptersResult	SpeedifySDK_ResetConnectionRateLimit (CSpeedifySDK sdk, const char adapterID, SpeedifySDK_AdaptersCallback cb, void userData)
	Reset the speed rate limit on a connection to unlimited. More...

SpeedifySDK_AdaptersResult	SpeedifySDK_SetConnectionRateLimit (CSpeedifySDK sdk, const char adapterID, int64_t bps, SpeedifySDK_AdaptersCallback cb, void userData)
	Set the speed rate limit on a connection. More...

SpeedifySDK_AdaptersResult	SpeedifySDK_DisableAdapterMonthlyDataLimit (CSpeedifySDK sdk, const char adapterID, SpeedifySDK_AdaptersCallback cb, void userData)
	Sets the adapter to unlimited daily data usage. More...

SpeedifySDK_AdaptersResult	SpeedifySDK_SetAdapterMonthlyDataLimit (CSpeedifySDK sdk, const char adapterID, int64_t allowedBytes, int64_t resetDay, SpeedifySDK_AdaptersCallback cb, void userData)
	Set the data usage, in bytes, allowed on this adapter in a single month. More...

SpeedifySDK_AdaptersResult	SpeedifySDK_DisableAdapterDailyDataLimit (CSpeedifySDK sdk, const char adapterID, SpeedifySDK_AdaptersCallback cb, void userData)
	Sets the adapter to unlimited daily data usage. More...

SpeedifySDK_AdaptersResult	SpeedifySDK_SetAdapterDailyDataLimit (CSpeedifySDK sdk, const char adapterID, int64_t allowedBytes, SpeedifySDK_AdaptersCallback cb, void userData)
	Set the data usage, in bytes, allowed on this adapter in a single day. More...

SpeedifySDK_AdaptersResult	SpeedifySDK_AddAdapterDailyDataLimitBoost (CSpeedifySDK sdk, const char adapterID, int64_t additionalBytes, SpeedifySDK_AdaptersCallback cb, void userData)
	Adds additional bytes to the adapter's daily data usage limit for today. More...

SpeedifySDK_AdaptersResult	SpeedifySDK_SetAdapterOverlimitRateLimit (CSpeedifySDK sdk, const char adapterID, int64_t bps, SpeedifySDK_AdaptersCallback cb, void userData)
	Sets how to handle an adapter that has hit its daily or monthly data limit. More...

SpeedifySDK_AdaptersResult	SpeedifySDK_ResetAdapterUsage (CSpeedifySDK sdk, const char adapterID, SpeedifySDK_AdaptersCallback cb, void userData)
	Resets the tracked data usage on an adapter. More...

SpeedifySDK_SettingsResult	SpeedifySDK_SetConnectionEncryption (CSpeedifySDK sdk, const char adapterID, bool encrypted, SpeedifySDK_SettingsCallback cb, void userData)
	Change encryption settings per connection. More...

SpeedifySDK_BaseResult	SpeedifySDK_EnableConnectionStatUpdates (CSpeedifySDK sdk, bool enabled)
	Enable periodic connection stats, adapter list updates, session stats, and streaming stats to be sent while Speedify is connected. More...

SpeedifySDK_BaseResult	SpeedifySDK_EnableStatUpdates (CSpeedifySDK sdk, bool enabled, uint8_t periodCount, uint32_t *periods)
	Enable periodic connection stats, adapter list updates, session stats, and streaming stats to be sent while Speedify is connected. More...

SpeedifySDK_ConnectionStatsResult	SpeedifySDK_GetConnectionStats (CSpeedifySDK sdk, SpeedifySDK_ConnectionStatsCallback cb, void *userData)
	Get stats on current connections to the Speedify server. More...

SpeedifySDK_ConnectionStatsResult	SpeedifySDK_GetHistoricConnectionStats (CSpeedifySDK sdk, SpeedifySDK_ConnectionStatsCallback cb, void *userData)
	Gets historic tunnel stats for last 5 minutes. More...

SpeedifySDK_SessionStatsResult	SpeedifySDK_GetSessionStats (CSpeedifySDK sdk, SpeedifySDK_SessionStatsCallback cb, void *userData)
	Get session stats. Supports Subscription. More...

SpeedifySDK_StreamingStatsResult	SpeedifySDK_GetStreamingStats (CSpeedifySDK sdk, SpeedifySDK_StreamingStatsCallback cb, void *userData)
	Get streaming stats. Supports Subscription. More...

SpeedifySDK_NewAdapterResult	SpeedifySDK_ListenForNewAdapter (CSpeedifySDK sdk, SpeedifySDK_NewAdapterCallback cb, void *userData)
	Receive messages when a new adapter is connected. More...

SpeedifySDK_BaseResult	SpeedifySDK_HandleNewAdapter (CSpeedifySDK sdk, const char *adapterID)
	Clear a new adapter message. More...

SpeedifySDK_AdapterOverlimitResult	SpeedifySDK_ListenForAdapterOverlimit (CSpeedifySDK sdk, SpeedifySDK_AdapterOverlimitCallback cb, void *userData)
	Receive messages when an adapter reaches its daily or monthly limit. More...

SpeedifySDK_BaseResult	SpeedifySDK_HandleAdapterOverlimit (CSpeedifySDK sdk, const char *adapterID)
	Clear an overlimit message. More...

SpeedifySDK_SpeedtestResult	SpeedifySDK_StartSpeedtest (CSpeedifySDK sdk, bool reportProgress, SpeedifySDK_SpeedtestCallback cb, void *userData)
	Starts a test of speeds through Speedify. More...

SpeedifySDK_BaseResult	SpeedifySDK_StopSpeedtest (CSpeedifySDK sdk)
	Stops an in-progress speed test. More...

SpeedifySDK_BaseResult	SpeedifySDK_SetReportingEncryptionKey (CSpeedifySDK sdk, const char *key128bit)
	Set reporting encryption key. More...

SpeedifySDK_TorrentResult	SpeedifySDK_ListenForTorrentDetection (CSpeedifySDK sdk, SpeedifySDK_TorrentCallback cb, void *userData)
	Receive messages when a torrent is detected. Subscription Only. More...

SpeedifySDK_CaptivePortalCheckResult	SpeedifySDK_CheckForCaptivePortals (CSpeedifySDK sdk, SpeedifySDK_CaptivePortalCheckCallback cb, void *userData)
	Check for captive portals. More...

SpeedifySDK_CaptivePortalCheckResult	SpeedifySDK_ListenForCaptivePortals (CSpeedifySDK sdk, SpeedifySDK_CaptivePortalCheckCallback cb, void *userData)
	Receive messages when a captive protal is detected. Subscription Only. More...

SpeedifySDK_CaptivePortalLoginResult	SpeedifySDK_SetCaptivePortalLoginMode (CSpeedifySDK sdk, bool enabled, const char adapterID, SpeedifySDK_CaptivePortalLoginCallback cb, void userData)
	Controls the captive portal login mode. If enabled, new port 80, 443, and 53 sockets will be directed through the chosen adapter instead of over the VPN tunnel. Can only be started while the VPN tunnel is connected. If enabling, an adapterID must be provided. More...

SpeedifySDK_CaptivePortalLoginResult	SpeedifySDK_GetCaptivePortalLoginMode (CSpeedifySDK sdk, SpeedifySDK_CaptivePortalLoginCallback cb, void *userData)
	Get status of the captive portal login mode. More...

SpeedifySDK_LocalProxySettingsResult	SpeedifySDK_GetLocalProxySettings (CSpeedifySDK sdk, SpeedifySDK_LocalProxySettingsCallback cb, void *userData)
	Get configuration of the local proxy. More...

SpeedifySDK_LocalProxySettingsResult	SpeedifySDK_SetLocalProxyEnabled (CSpeedifySDK sdk, bool enabled, SpeedifySDK_LocalProxySettingsCallback cb, void *userData)
	Enables or disables the local proxy. More...

SpeedifySDK_LocalProxySettingsResult	SpeedifySDK_SetLocalProxyMatchMode (CSpeedifySDK sdk, SpeedifySDK_ProxyMatchMode matchMode, SpeedifySDK_LocalProxySettingsCallback cb, void *userData)
	Set the match mode used by the local proxy. More...

SpeedifySDK_LocalProxySettingsResult	SpeedifySDK_SetLocalProxyDomains (CSpeedifySDK sdk, uint16_t count, SpeedifySDK_DomainString domains, SpeedifySDK_LocalProxySettingsCallback cb, void userData)
	Set domains to proxy locally, instead of going through the VPN. More...

SpeedifySDK_LocalProxySettingsResult	SpeedifySDK_SetLocalProxyIPv4 (CSpeedifySDK sdk, uint16_t count, struct in_addr ipv4, SpeedifySDK_LocalProxySettingsCallback cb, void userData)
	Set IPv4 address to proxy locally, instead of going through the VPN. IP addresses should be in network byte order. More...

SpeedifySDK_LocalProxySettingsResult	SpeedifySDK_SetLocalProxyPorts (CSpeedifySDK sdk, uint16_t count, SpeedifySDK_LocalProxyPort ports, SpeedifySDK_LocalProxySettingsCallback cb, void userData)
	Set ports to proxy locally, instead of going through the VPN. Ports should be in host byte order. More...

SpeedifySDK_LocalProxySettingsResult	SpeedifySDK_SetLocalProxyDomainWatchlist (CSpeedifySDK sdk, uint16_t count, SpeedifySDK_LocalProxyDomainWatchlistItem domainWatchlist, SpeedifySDK_LocalProxySettingsCallback cb, void userData)
	Set domain watchlist settings for the local proxy. More...

SpeedifySDK_LocalProxySettingsResult	SpeedifySDK_SetLocalProxyDomainWatchlistEnable (CSpeedifySDK sdk, const char title, bool enabled, SpeedifySDK_LocalProxySettingsCallback cb, void userData)
	Toggle a single domain watchlist item from being enabled over the local proxy. More...

SpeedifySDK_LocalProxyDomainWatchlistHitResult	SpeedifySDK_ListenForLocalProxyDomainWatchlistHit (CSpeedifySDK sdk, SpeedifySDK_LocalProxyDomainWatchlistHitCallback cb, void *userData)
	Receive messages when a domain watchlist domain is detected. More...

SpeedifySDK_VendorSettingsResult	SpeedifySDK_SetLocalVendorSettings (CSpeedifySDK sdk, const char settingsJson, bool merge, SpeedifySDK_VendorSettingsCallback cb, void userData)
	Set local vendor settings. More...

SpeedifySDK_VendorSettingsResult	SpeedifySDK_GetLocalVendorSettings (CSpeedifySDK sdk, SpeedifySDK_VendorSettingsCallback cb, void *userData)
	Get local vendor settings. More...

SpeedifySDK_VendorSettingsResult	SpeedifySDK_GetRemoteVendorSettings (CSpeedifySDK sdk, SpeedifySDK_VendorSettingsCallback cb, void *userData)
	Get remote vendor settings. More...

SpeedifySDK_VendorUserDataResult	SpeedifySDK_SetVendorUserData (CSpeedifySDK sdk, const char vendorUserData, SpeedifySDK_VendorUserDataCallback cb, void userData)
	Set vendor user data. More...

SpeedifySDK_VendorUserDataResult	SpeedifySDK_GetVendorUserData (CSpeedifySDK sdk, SpeedifySDK_VendorUserDataCallback cb, void *userData)
	Get vendor user data. More...

SpeedifySDK_FirewallSettingsResult	SpeedifySDK_GetFirewallSettings (CSpeedifySDK sdk, SpeedifySDK_FirewallSettingsCallback cb, void *userData)
	Get configuration of the firewall. More...

SpeedifySDK_FirewallSettingsResult	SpeedifySDK_SetFirewallMode (CSpeedifySDK sdk, SpeedifySDK_FirewallMode mode, SpeedifySDK_FirewallSettingsCallback cb, void *userData)
	Set the mode used by the firewall. More...

SpeedifySDK_FirewallSettingsResult	SpeedifySDK_SetFirewallDomains (CSpeedifySDK sdk, uint16_t count, SpeedifySDK_DomainString domains, SpeedifySDK_FirewallSettingsCallback cb, void userData)
	Set domains to firewall. More...

SpeedifySDK_FirewallSettingsResult	SpeedifySDK_SetFirewallIPv4 (CSpeedifySDK sdk, uint16_t count, struct in_addr ipv4, SpeedifySDK_FirewallSettingsCallback cb, void userData)
	Set IPv4 address to firewall. IP addresses should be in network byte order. More...

SpeedifySDK_FirewallSettingsResult	SpeedifySDK_SetFirewallIPv6 (CSpeedifySDK sdk, uint16_t count, struct in6_addr ipv6, SpeedifySDK_FirewallSettingsCallback cb, void userData)
	Set IPv6 address to firewall. IP addresses should be in network byte order. More...

SpeedifySDK_FirewallSettingsResult	SpeedifySDK_SetFirewallPorts (CSpeedifySDK sdk, uint16_t count, SpeedifySDK_FirewallPort ports, SpeedifySDK_FirewallSettingsCallback cb, void userData)
	Set ports to firewall Ports should be in host byte order. More...

SpeedifySDK_SafeBrowsingResult	SpeedifySDK_InitSafeBrowsing (CSpeedifySDK sdk, const char initConfig, SpeedifySDK_SafeBrowsingCallback cb, void userData)
	Initialize Safe Browsing library. More...

SpeedifySDK_SafeBrowsingResult	SpeedifySDK_SetSafeBrowsingConfig (CSpeedifySDK sdk, const char safeBrowsingConfig, SpeedifySDK_SafeBrowsingCallback cb, void userData)
	Sets an optional config, used to bypass certain initialization steps. Applied to subsequent init calls. More...

SpeedifySDK_SafeBrowsingResult	SpeedifySDK_SetSafeBrowsingEnabled (CSpeedifySDK sdk, bool enabled, SpeedifySDK_SafeBrowsingCallback cb, void *userData)
	Sets if Safe Browsing is enabled. More...

SpeedifySDK_DisconnectEventResult	SpeedifySDK_GetLastDisconnectEvent (CSpeedifySDK sdk, SpeedifySDK_DisconnectEventCallback cb, void *userData)
	Get the last session disconnect event. More...

SpeedifySDK_SafeBrowsingResult	SpeedifySDK_GetSafeBrowsing (CSpeedifySDK sdk, SpeedifySDK_SafeBrowsingCallback cb, void *userData)
	Get log file settings. More...

SpeedifySDK_SafeBrowsingStatsResult	SpeedifySDK_GetSafeBrowsingStats (CSpeedifySDK sdk, SpeedifySDK_SafeBrowsingStatsCallback cb, void *userData)
	Get Safe Browsing lookup stats. More...

SpeedifySDK_SafeBrowsingErrorResult	SpeedifySDK_ListenForSafeBrowsingError (CSpeedifySDK sdk, SpeedifySDK_SafeBrowsingErrorCallback cb, void *userData)
	Receive messages when a Safe Browsing lookup fails. More...

SpeedifySDK_SafeBrowsingBlockResult	SpeedifySDK_ListenForSafeBrowsingBlock (CSpeedifySDK sdk, SpeedifySDK_SafeBrowsingBlockCallback cb, void *userData)
	Receive messages when a host is blocked. More...

SpeedifySDK_LogSettingsResult	SpeedifySDK_GetLogSettings (CSpeedifySDK sdk, SpeedifySDK_LogSettingsCallback cb, void *userData)
	Get Safe Browsing mode settings. More...

SpeedifySDK_LogSettingsResult	SpeedifySDK_SetDaemonLogSettings (CSpeedifySDK sdk, SpeedifySDK_DaemonLogSettings daemon, SpeedifySDK_LogSettingsCallback cb, void *userData)
	Set daemon log file settings. More...

SpeedifySDK_BaseResult	SpeedifySDK_EraseAllLogFiles (CSpeedifySDK sdk)
	Erase all log files. More...

void	SpeedifySDK_UnregisterCallback (CSpeedifySDK sdk, SpeedifySDK_EventID eventId)
	Unregister an asynchronous callback registered via other calls. More...

bool	SpeedifySDK_WaitOnCallback (CSpeedifySDK sdk, SpeedifySDK_EventID eventId, uint64_t timeoutMs)
	Wait for an asynchronous result. More...

SpeedifySDK_BaseResult	SpeedifySDK_DaemonExit (CSpeedifySDK sdk)
	Tells the Speedify daemon to exit cleanly. More...

void	SpeedifySDK_Free (void *object)
	Free memory allocated by SpeedifySDK. More...

SpeedifySDK_SettingsResult	SpeedifySDK_SetHeaderCompression (CSpeedifySDK sdk, bool enabled, SpeedifySDK_SettingsCallback cb, void *userData)
	Sets whether to allow header compression of packets sent over the VPN. More...

Function Documentation

◆ SpeedifySDK_AccountCheck()

SpeedifySDK_AccountCheckResult SpeedifySDK_AccountCheck	(	CSpeedifySDK	sdk,
		const char *	email,
		SpeedifySDK_AccountCheckCallback	cb,
		void *	userData
	)

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

Parameters

sdk	SpeedifySDK object
email	account to check for
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: account check result object

Since: 7.5

◆ SpeedifySDK_AccountCreate()

SpeedifySDK_AccountCreateResult SpeedifySDK_AccountCreate	(	CSpeedifySDK	sdk,
		const char *	email,
		const char *	password,
		SpeedifySDK_AccountCreateCallback	cb,
		void *	userData
	)

Create a new account using this email address.

Parameters

sdk	SpeedifySDK object
email	account to create
password	password of the new account
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: account create result object

Since: 7.5

◆ SpeedifySDK_AccountPasswordChange()

SpeedifySDK_AccountPasswordChangeResult SpeedifySDK_AccountPasswordChange	(	CSpeedifySDK	sdk,
		const char *	email,
		const char *	originalPassword,
		const char *	newPassword,
		SpeedifySDK_AccountPasswordChangeCallback	cb,
		void *	userData
	)

Change the password on the account.

Parameters

sdk	SpeedifySDK object
email	account to change
originalPassword	original password of the account
newPassword	new password of the account
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: account password change result object

Since: 7.5

◆ SpeedifySDK_AddAdapterDailyDataLimitBoost()

SpeedifySDK_AdaptersResult SpeedifySDK_AddAdapterDailyDataLimitBoost	(	CSpeedifySDK	sdk,
		const char *	adapterID,
		int64_t	additionalBytes,
		SpeedifySDK_AdaptersCallback	cb,
		void *	userData
	)

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.

Parameters

sdk	SpeedifySDK object
adapterID	ID of the adapterID
additionalBytes	additional bytes that may be used today
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: adapters result object

Since: 7.5

◆ SpeedifySDK_CheckForCaptivePortals()

SpeedifySDK_CaptivePortalCheckResult SpeedifySDK_CheckForCaptivePortals	(	CSpeedifySDK	sdk,
		SpeedifySDK_CaptivePortalCheckCallback	cb,
		void *	userData
	)

Check for captive portals.

Parameters

sdk	SpeedifySDK object
cb	required callback
userData	optional user data pointer returned in the callback

Returns: captive portal result object

Since: 9.0

◆ SpeedifySDK_ConnectAuto()

SpeedifySDK_ConnectResult SpeedifySDK_ConnectAuto	(	CSpeedifySDK	sdk,
		SpeedifySDK_AutoConnectMethod	method,
		SpeedifySDK_ConnectCallback	cb,
		void *	userData
	)

Connect to a server by an automatic selection method.

If already connected, this will disconnect before reconnecting.

Parameters

sdk	SpeedifySDK object
method	automatic server selection method to use
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: connect result object

Since: 7.5

◆ SpeedifySDK_ConnectCity()

SpeedifySDK_ConnectResult SpeedifySDK_ConnectCity	(	CSpeedifySDK	sdk,
		const char *	country,
		const char *	city,
		SpeedifySDK_ConnectCallback	cb,
		void *	userData
	)

Connect to a server by server city.

If already connected, this will disconnect before reconnecting.

Parameters

sdk	SpeedifySDK object
country	2-char ISO country code
city	city name
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: connect result object

Since: 7.5

◆ SpeedifySDK_ConnectCountry()

SpeedifySDK_ConnectResult SpeedifySDK_ConnectCountry	(	CSpeedifySDK	sdk,
		const char *	country,
		SpeedifySDK_ConnectCallback	cb,
		void *	userData
	)

Connect to a server by server country.

If already connected, this will disconnect before reconnecting.

Parameters

sdk	SpeedifySDK object
country	2-char ISO country code
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: connect result object

Since: 7.5

◆ SpeedifySDK_ConnectProxy()

SpeedifySDK_ConnectResult SpeedifySDK_ConnectProxy	(	CSpeedifySDK	sdk,
		SpeedifySDK_ConnectCallback	cb,
		void *	userData
	)

Runs the Speedify VPN as a local proxy, without a connection to a remote server.

If already connected, this will disconnect before reconnecting.

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: connect result object

Since: 10.4

◆ SpeedifySDK_ConnectServer()

SpeedifySDK_ConnectResult SpeedifySDK_ConnectServer	(	CSpeedifySDK	sdk,
		const char *	country,
		const char *	city,
		int32_t	num,
		SpeedifySDK_ConnectCallback	cb,
		void *	userData
	)

Connect to a specific server.

If already connected, this will disconnect before reconnecting.

Parameters

sdk	SpeedifySDK object
country	2-char ISO country code
city	city name
num	server number
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: connect result object

Since: 7.5

◆ SpeedifySDK_Create()

CSpeedifySDK SpeedifySDK_Create ( uint16_t port )

Create a new SDK object.

Parameters

port	Port number of the daemon to talk to

Returns: sdk object to pass to other methods

Since: 7.5

◆ SpeedifySDK_CreateWithSettings()

CSpeedifySDK SpeedifySDK_CreateWithSettings ( SpeedifySDK_CreateSettings settings )

Create a new SDK object.

Parameters

settings settings used to create this CSpeedifySDK instance

Returns: sdk object to pass to other methods

Since: 10.6

◆ SpeedifySDK_DaemonExit()

SpeedifySDK_BaseResult SpeedifySDK_DaemonExit ( CSpeedifySDK sdk )

Tells the Speedify daemon to exit cleanly.

Parameters

sdk	SpeedifySDK object

Returns: result object

Since: 7.5

◆ SpeedifySDK_Destroy()

void SpeedifySDK_Destroy ( CSpeedifySDK sdk )

Destroys an SDK object.

Parameters

sdk	SpeedifySDK object

Since: 7.5

◆ SpeedifySDK_DisableAdapterDailyDataLimit()

SpeedifySDK_AdaptersResult SpeedifySDK_DisableAdapterDailyDataLimit	(	CSpeedifySDK	sdk,
		const char *	adapterID,
		SpeedifySDK_AdaptersCallback	cb,
		void *	userData
	)

Sets the adapter to unlimited daily data usage.

Parameters

sdk	SpeedifySDK object
adapterID	ID of the adapterID
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: adapters result object

Since: 7.5

◆ SpeedifySDK_DisableAdapterMonthlyDataLimit()

SpeedifySDK_AdaptersResult SpeedifySDK_DisableAdapterMonthlyDataLimit	(	CSpeedifySDK	sdk,
		const char *	adapterID,
		SpeedifySDK_AdaptersCallback	cb,
		void *	userData
	)

Sets the adapter to unlimited daily data usage.

Parameters

sdk	SpeedifySDK object
adapterID	ID of the adapterID
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: adapters result object

Since: 7.5

◆ SpeedifySDK_Disconnect()

SpeedifySDK_StateResult SpeedifySDK_Disconnect	(	CSpeedifySDK	sdk,
		SpeedifySDK_StateCallback	cb,
		void *	userData
	)

Disconnect from the server if connected, or cancel a connection attempt if currenty connecting.

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: state result object

Since: 7.5

◆ SpeedifySDK_EnableConnectionStatUpdates()

SpeedifySDK_BaseResult SpeedifySDK_EnableConnectionStatUpdates	(	CSpeedifySDK	sdk,
		bool	enabled
	)

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

This is equivalent to SpeedifySDK_EnableStatUpdates(sdk,enabled,1,(uint32_t[]){SPEEDIFYSDK_STAT_PERIOD_TOTAL});

Deprecated:: As of 10.0. Use SpeedifySDK_EnableStatUpdates

Parameters

sdk	SpeedifySDK object
enabled	if connection stat updates should be continuously received

Returns: result object

Since: 7.5

◆ SpeedifySDK_EnableStatUpdates()

SpeedifySDK_BaseResult SpeedifySDK_EnableStatUpdates	(	CSpeedifySDK	sdk,
		bool	enabled,
		uint8_t	periodCount,
		uint32_t *	periods
	)

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

Parameters

sdk	SpeedifySDK object
enabled	if connection stat updates should be continuously received
periodCount	number of periods specified, or 0 to use previously configured periods
periods	timeframes of requested session stats, values in hours, SPEEDIFYSDK_STAT_PERIOD_CURRENT for current, SPEEDIFYSDK_STAT_PERIOD_TOTAL for total, or NULL for previously configured periods

Returns: result object

Since: 10.0

◆ SpeedifySDK_EraseAllLogFiles()

SpeedifySDK_BaseResult SpeedifySDK_EraseAllLogFiles ( CSpeedifySDK sdk )

Erase all log files.

Note that the current active log file is not erased.

Parameters

sdk	SpeedifySDK object

Returns: result object

Since: 10.5

◆ SpeedifySDK_Free()

void SpeedifySDK_Free ( void * object )

Free memory allocated by SpeedifySDK.

Parameters

object object to be freed

Since: 9.2

◆ SpeedifySDK_GetAccountingData()

SpeedifySDK_AccountingResult SpeedifySDK_GetAccountingData	(	CSpeedifySDK	sdk,
		SpeedifySDK_AccountingCallback	cb,
		void *	userData
	)

Gets information on the currently used account.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: accountind data result object

Since: 7.5

◆ SpeedifySDK_GetAdapters()

SpeedifySDK_AdaptersResult SpeedifySDK_GetAdapters	(	CSpeedifySDK	sdk,
		SpeedifySDK_AdaptersCallback	cb,
		void *	userData
	)

Gets a list of current adapters.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: adapters result object

Since: 7.5

◆ SpeedifySDK_GetCaptivePortalLoginMode()

SpeedifySDK_CaptivePortalLoginResult SpeedifySDK_GetCaptivePortalLoginMode	(	CSpeedifySDK	sdk,
		SpeedifySDK_CaptivePortalLoginCallback	cb,
		void *	userData
	)

Get status of the captive portal login mode.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: captive portal login mode result object

Since: 9.0

◆ SpeedifySDK_GetConnectedServer()

SpeedifySDK_ConnectResult SpeedifySDK_GetConnectedServer	(	CSpeedifySDK	sdk,
		SpeedifySDK_ConnectCallback	cb,
		void *	userData
	)

Get the currently or last connected server.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: connect result object

Since: 7.5

◆ SpeedifySDK_GetConnectionStats()

SpeedifySDK_ConnectionStatsResult SpeedifySDK_GetConnectionStats	(	CSpeedifySDK	sdk,
		SpeedifySDK_ConnectionStatsCallback	cb,
		void *	userData
	)

Get stats on current connections to the Speedify server.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: connection stats result object

Since: 7.5

◆ SpeedifySDK_GetDirectory()

SpeedifySDK_DirectoryResult SpeedifySDK_GetDirectory	(	CSpeedifySDK	sdk,
		SpeedifySDK_DirectoryCallback	cb,
		void *	userData
	)

Get a list of available servers from the directory list.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: directory result object

Since: 7.5

◆ SpeedifySDK_GetDirectoryDomain()

SpeedifySDK_DirectorySettingsResult SpeedifySDK_GetDirectoryDomain	(	CSpeedifySDK	sdk,
		SpeedifySDK_DirectorySettingsCallback	cb,
		void *	userData
	)

Get the directory server being used.

Supports Subscription

Deprecated:: As of 10.5. Use SpeedifySDK_GetDirectorySettings

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: directory domain result object

Since: 7.5

◆ SpeedifySDK_GetDirectorySettings()

SpeedifySDK_DirectorySettingsResult SpeedifySDK_GetDirectorySettings	(	CSpeedifySDK	sdk,
		SpeedifySDK_DirectorySettingsCallback	cb,
		void *	userData
	)

Get the directory settings.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: directory settings result object

Since: 10.5

◆ SpeedifySDK_GetFirewallSettings()

SpeedifySDK_FirewallSettingsResult SpeedifySDK_GetFirewallSettings	(	CSpeedifySDK	sdk,
		SpeedifySDK_FirewallSettingsCallback	cb,
		void *	userData
	)

Get configuration of the firewall.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: firewall result object

Since: 9.2

◆ SpeedifySDK_GetHistoricConnectionStats()

SpeedifySDK_ConnectionStatsResult SpeedifySDK_GetHistoricConnectionStats	(	CSpeedifySDK	sdk,
		SpeedifySDK_ConnectionStatsCallback	cb,
		void *	userData
	)

Gets historic tunnel stats for last 5 minutes.

Asynchronous Only

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: connection stats result object

Since: 7.5

◆ SpeedifySDK_GetLastDisconnectEvent()

SpeedifySDK_DisconnectEventResult SpeedifySDK_GetLastDisconnectEvent	(	CSpeedifySDK	sdk,
		SpeedifySDK_DisconnectEventCallback	cb,
		void *	userData
	)

Get the last session disconnect event.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: disconnect event object

Since: 10.4

◆ SpeedifySDK_GetLocalProxySettings()

SpeedifySDK_LocalProxySettingsResult SpeedifySDK_GetLocalProxySettings	(	CSpeedifySDK	sdk,
		SpeedifySDK_LocalProxySettingsCallback	cb,
		void *	userData
	)

Get configuration of the local proxy.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: local proxy result object

Since: 9.2

◆ SpeedifySDK_GetLocalVendorSettings()

SpeedifySDK_VendorSettingsResult SpeedifySDK_GetLocalVendorSettings	(	CSpeedifySDK	sdk,
		SpeedifySDK_VendorSettingsCallback	cb,
		void *	userData
	)

Get local vendor settings.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: vendor settings result object

Since: 9.2

◆ SpeedifySDK_GetLogSettings()

SpeedifySDK_LogSettingsResult SpeedifySDK_GetLogSettings	(	CSpeedifySDK	sdk,
		SpeedifySDK_LogSettingsCallback	cb,
		void *	userData
	)

Get Safe Browsing mode settings.

Returns: log settings object

Since: 10.5

◆ SpeedifySDK_GetPrivacySettings()

SpeedifySDK_PrivacySettingsResult SpeedifySDK_GetPrivacySettings	(	CSpeedifySDK	sdk,
		SpeedifySDK_PrivacySettingsCallback	cb,
		void *	userData
	)

Gets privacy settings.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: privacy settings result object

Since: 7.5

◆ SpeedifySDK_GetRemoteVendorSettings()

SpeedifySDK_VendorSettingsResult SpeedifySDK_GetRemoteVendorSettings	(	CSpeedifySDK	sdk,
		SpeedifySDK_VendorSettingsCallback	cb,
		void *	userData
	)

Get remote vendor settings.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: vendor settings result object

Since: 9.2

◆ SpeedifySDK_GetSafeBrowsing()

SpeedifySDK_SafeBrowsingResult SpeedifySDK_GetSafeBrowsing	(	CSpeedifySDK	sdk,
		SpeedifySDK_SafeBrowsingCallback	cb,
		void *	userData
	)

Get log file settings.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: safe browsing result object

Since: 10.6

◆ SpeedifySDK_GetSafeBrowsingStats()

SpeedifySDK_SafeBrowsingStatsResult SpeedifySDK_GetSafeBrowsingStats	(	CSpeedifySDK	sdk,
		SpeedifySDK_SafeBrowsingStatsCallback	cb,
		void *	userData
	)

Get Safe Browsing lookup stats.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: safe browsing result object

Since: 10.6

◆ SpeedifySDK_GetServerSettings()

SpeedifySDK_ServerSettingsResult SpeedifySDK_GetServerSettings	(	CSpeedifySDK	sdk,
		SpeedifySDK_ServerSettingsCallback	cb,
		void *	userData
	)

Get the default connection method.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: server settings result object

Since: 7.5

◆ SpeedifySDK_GetSessionStats()

SpeedifySDK_SessionStatsResult SpeedifySDK_GetSessionStats	(	CSpeedifySDK	sdk,
		SpeedifySDK_SessionStatsCallback	cb,
		void *	userData
	)

Get session stats.
Supports Subscription.

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: session stats result object

Since: 7.5

◆ SpeedifySDK_GetSettings()

SpeedifySDK_SettingsResult SpeedifySDK_GetSettings	(	CSpeedifySDK	sdk,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

Get general connecttion settings.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 7.5

◆ SpeedifySDK_GetState()

SpeedifySDK_StateResult SpeedifySDK_GetState	(	CSpeedifySDK	sdk,
		SpeedifySDK_StateCallback	cb,
		void *	userData
	)

Get the current state of Speedify.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: state result object

Since: 7.5

◆ SpeedifySDK_GetStreamingStats()

SpeedifySDK_StreamingStatsResult SpeedifySDK_GetStreamingStats	(	CSpeedifySDK	sdk,
		SpeedifySDK_StreamingStatsCallback	cb,
		void *	userData
	)

Get streaming stats.
Supports Subscription.

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: streaming stats result object

Since: 9.6

◆ SpeedifySDK_GetVendorUserData()

SpeedifySDK_VendorUserDataResult SpeedifySDK_GetVendorUserData	(	CSpeedifySDK	sdk,
		SpeedifySDK_VendorUserDataCallback	cb,
		void *	userData
	)

Get vendor user data.

Supports Subscription

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: vendor user data result object

Since: 9.8

◆ SpeedifySDK_GetVersion()

SpeedifySDK_VersionResult SpeedifySDK_GetVersion	(	CSpeedifySDK	sdk,
		SpeedifySDK_VersionCallback	cb,
		void *	userData
	)

Get the version of the connected Speedify daemon.

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: version result object

Since: 7.5

◆ SpeedifySDK_HandleAdapterOverlimit()

SpeedifySDK_BaseResult SpeedifySDK_HandleAdapterOverlimit	(	CSpeedifySDK	sdk,
		const char *	adapterID
	)

Clear an overlimit message.

Parameters

sdk	SpeedifySDK object
adapterID	ID of the adapterID

Returns: result object

Since: 7.5

◆ SpeedifySDK_HandleNewAdapter()

SpeedifySDK_BaseResult SpeedifySDK_HandleNewAdapter	(	CSpeedifySDK	sdk,
		const char *	adapterID
	)

Clear a new adapter message.

Parameters

sdk	SpeedifySDK object
adapterID	ID of the adapterID

Returns: result object

Since: 7.5

◆ SpeedifySDK_InitSafeBrowsing()

SpeedifySDK_SafeBrowsingResult SpeedifySDK_InitSafeBrowsing	(	CSpeedifySDK	sdk,
		const char *	initConfig,
		SpeedifySDK_SafeBrowsingCallback	cb,
		void *	userData
	)

Initialize Safe Browsing library.

Parameters

sdk	SpeedifySDK object
initConfig	a configuration string for the safe browsing service
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: safe browsing result object

Since: 10.6

◆ SpeedifySDK_ListenForAdapterOverlimit()

SpeedifySDK_AdapterOverlimitResult SpeedifySDK_ListenForAdapterOverlimit	(	CSpeedifySDK	sdk,
		SpeedifySDK_AdapterOverlimitCallback	cb,
		void *	userData
	)

Receive messages when an adapter reaches its daily or monthly limit.

Call SpeedifySDK_HandleAdapterOverlimit to clear this message.
Subscription Only

Parameters

sdk	SpeedifySDK object
cb	required callback
userData	optional user data pointer returned in the callback

Returns: adapter overlimit result object

Since: 7.5

◆ SpeedifySDK_ListenForCaptivePortals()

SpeedifySDK_CaptivePortalCheckResult SpeedifySDK_ListenForCaptivePortals	(	CSpeedifySDK	sdk,
		SpeedifySDK_CaptivePortalCheckCallback	cb,
		void *	userData
	)

Receive messages when a captive protal is detected. Subscription Only.

Parameters

sdk	SpeedifySDK object
cb	required callback
userData	optional user data pointer returned in the callback

Returns: captive portal result object

Since: 9.0

◆ SpeedifySDK_ListenForLocalProxyDomainWatchlistHit()

SpeedifySDK_LocalProxyDomainWatchlistHitResult SpeedifySDK_ListenForLocalProxyDomainWatchlistHit	(	CSpeedifySDK	sdk,
		SpeedifySDK_LocalProxyDomainWatchlistHitCallback	cb,
		void *	userData
	)

Receive messages when a domain watchlist domain is detected.

Call SpeedifySDK_HandleNewAdapter to clear this message.
Subscription Only

Parameters

sdk	SpeedifySDK object
cb	required callback
userData	optional user data pointer returned in the callback

Returns: local proxy domain watchlist hit result object

Since: 9.3

◆ SpeedifySDK_ListenForNewAdapter()

SpeedifySDK_NewAdapterResult SpeedifySDK_ListenForNewAdapter	(	CSpeedifySDK	sdk,
		SpeedifySDK_NewAdapterCallback	cb,
		void *	userData
	)

Receive messages when a new adapter is connected.

Call SpeedifySDK_HandleNewAdapter to clear this message.
Subscription Only

Parameters

sdk	SpeedifySDK object
cb	required callback
userData	optional user data pointer returned in the callback

Returns: new adapter result object

Since: 7.5

◆ SpeedifySDK_ListenForSafeBrowsingBlock()

SpeedifySDK_SafeBrowsingBlockResult SpeedifySDK_ListenForSafeBrowsingBlock	(	CSpeedifySDK	sdk,
		SpeedifySDK_SafeBrowsingBlockCallback	cb,
		void *	userData
	)

Receive messages when a host is blocked.

Subscription Only

Parameters

sdk	SpeedifySDK object
cb	required callback
userData	optional user data pointer returned in the callback

Returns: new block result object

Since: 10.6

◆ SpeedifySDK_ListenForSafeBrowsingError()

SpeedifySDK_SafeBrowsingErrorResult SpeedifySDK_ListenForSafeBrowsingError	(	CSpeedifySDK	sdk,
		SpeedifySDK_SafeBrowsingErrorCallback	cb,
		void *	userData
	)

Receive messages when a Safe Browsing lookup fails.

Subscription Only

Parameters

sdk	SpeedifySDK object
cb	required callback
userData	optional user data pointer returned in the callback

Returns: new error result object

Since: 10.6

◆ SpeedifySDK_ListenForTorrentDetection()

SpeedifySDK_TorrentResult SpeedifySDK_ListenForTorrentDetection	(	CSpeedifySDK	sdk,
		SpeedifySDK_TorrentCallback	cb,
		void *	userData
	)

Receive messages when a torrent is detected. Subscription Only.

Parameters

sdk	SpeedifySDK object
cb	required callback
userData	optional user data pointer returned in the callback

Returns: torrent result object

Since: 7.5

◆ SpeedifySDK_Login()

SpeedifySDK_StateResult SpeedifySDK_Login	(	CSpeedifySDK	sdk,
		const char *	username,
		const char *	password,
		SpeedifySDK_StateCallback	cb,
		void *	userData
	)

Authenticate a new user.

If setting a custom directory, call SpeedifySDK_SetDirectoryDomain() before calling this.

Parameters

sdk	SpeedifySDK object
username	Username of the user you wish to authenticate
password	Password of the user you wish to authenticate
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: state result object

Since: 7.5

◆ SpeedifySDK_LoginAutoAccount()

SpeedifySDK_StateResult SpeedifySDK_LoginAutoAccount	(	CSpeedifySDK	sdk,
		SpeedifySDK_StateCallback	cb,
		void *	userData
	)

Logs out of any current account and logs in to an automatically generated account for this device.

Automatic accounts have an email address in the form of <platform>.<deviceID>@autoaccount.speedify.com. If setting a custom directory, call SpeedifySDK_SetDirectoryDomain() before calling this.

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: state result object

Since: 7.5

◆ SpeedifySDK_LoginLocalLoopbackOnly()

SpeedifySDK_StateResult SpeedifySDK_LoginLocalLoopbackOnly	(	CSpeedifySDK	sdk,
		SpeedifySDK_StateCallback	cb,
		void *	userData
	)

Comcast Loopback Function.

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: state result object

Since: 10.6

◆ SpeedifySDK_LoginOAuth()

SpeedifySDK_StateResult SpeedifySDK_LoginOAuth	(	CSpeedifySDK	sdk,
		const char *	oauthAccessToken,
		SpeedifySDK_StateCallback	cb,
		void *	userData
	)

Authenticate a new user using an oauth access token.

The application is responsible for fetching updated access tokens if using this method.
If setting a custom directory, call SpeedifySDK_SetDirectoryDomain() before calling this.
An expired access token will give an error of type ET_TOKEN_EXPIRED, while invalid tokens will give ET_CREDENTIAL.

Parameters

sdk	SpeedifySDK object
oauthAccessToken	Access token for the user you wish to authenticate
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: state result object

Since: 7.5

◆ SpeedifySDK_Logout()

SpeedifySDK_StateResult SpeedifySDK_Logout	(	CSpeedifySDK	sdk,
		SpeedifySDK_StateCallback	cb,
		void *	userData
	)

Logout the current user.

This will reset your connect method to ACM_CLOSEST.

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: state result object

Since: 7.5

◆ SpeedifySDK_ResetAdapterUsage()

SpeedifySDK_AdaptersResult SpeedifySDK_ResetAdapterUsage	(	CSpeedifySDK	sdk,
		const char *	adapterID,
		SpeedifySDK_AdaptersCallback	cb,
		void *	userData
	)

Resets the tracked data usage on an adapter.

Parameters

sdk	SpeedifySDK object
adapterID	ID of the adapterID to reset
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: adapters result object

Since: 7.8.3

◆ SpeedifySDK_ResetConnectionRateLimit()

SpeedifySDK_AdaptersResult SpeedifySDK_ResetConnectionRateLimit	(	CSpeedifySDK	sdk,
		const char *	adapterID,
		SpeedifySDK_AdaptersCallback	cb,
		void *	userData
	)

Reset the speed rate limit on a connection to unlimited.

Parameters

sdk	SpeedifySDK object
adapterID	guid of adapter, from adapters list
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: adapters result object

Since: 7.5

◆ SpeedifySDK_ResetDirectoryDomain()

SpeedifySDK_DirectorySettingsResult SpeedifySDK_ResetDirectoryDomain	(	CSpeedifySDK	sdk,
		SpeedifySDK_DirectorySettingsCallback	cb,
		void *	userData
	)

Reset the directory server to defaults.

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: directory domain result object

Since: 7.5

◆ SpeedifySDK_ResetDirectoryGatewayURI()

SpeedifySDK_DirectorySettingsResult SpeedifySDK_ResetDirectoryGatewayURI	(	CSpeedifySDK	sdk,
		SpeedifySDK_DirectorySettingsCallback	cb,
		void *	userData
	)

Reset the directory oauth gateway to defaults.

Parameters

sdk	SpeedifySDK object
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: directory domain result object

Since: 10.5

◆ SpeedifySDK_SetAdapterDailyDataLimit()

SpeedifySDK_AdaptersResult SpeedifySDK_SetAdapterDailyDataLimit	(	CSpeedifySDK	sdk,
		const char *	adapterID,
		int64_t	allowedBytes,
		SpeedifySDK_AdaptersCallback	cb,
		void *	userData
	)

Set the data usage, in bytes, allowed on this adapter in a single day.

Setting allowedBytes to 0 will disable this limit.

Parameters

sdk	SpeedifySDK object
adapterID	ID of the adapterID
allowedBytes	bytes that may be used in a single day. 0 for unlimited
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: adapters result object

Since: 7.5

◆ SpeedifySDK_SetAdapterMonthlyDataLimit()

SpeedifySDK_AdaptersResult SpeedifySDK_SetAdapterMonthlyDataLimit	(	CSpeedifySDK	sdk,
		const char *	adapterID,
		int64_t	allowedBytes,
		int64_t	resetDay,
		SpeedifySDK_AdaptersCallback	cb,
		void *	userData
	)

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

Setting allowedBytes to 0 will disable this limit.

Parameters

sdk	SpeedifySDK object
adapterID	ID of the adapterID
allowedBytes	bytes that may be used in a single month. 0 for unlimited
resetDay	day of the month that monthly usage is tracked from. 0 for last 30 days. unused if allowedBytes is 0
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: adapters result object

Since: 7.5

◆ SpeedifySDK_SetAdapterOverlimitRateLimit()

SpeedifySDK_AdaptersResult SpeedifySDK_SetAdapterOverlimitRateLimit	(	CSpeedifySDK	sdk,
		const char *	adapterID,
		int64_t	bps,
		SpeedifySDK_AdaptersCallback	cb,
		void *	userData
	)

Sets how to handle an adapter that has hit its daily or monthly data limit.

Parameters

sdk	SpeedifySDK object
adapterID	ID of the adapterID
bps	rate limit, in bits per second. 0 to not use the adapter
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: adapters result object

Since: 7.5

◆ SpeedifySDK_SetAllowChaChaEncryption()

SpeedifySDK_SettingsResult SpeedifySDK_SetAllowChaChaEncryption	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

Allow or disallow use of ChaCha for connection encryptions.

Parameters

sdk	SpeedifySDK object
enabled	allow use of ChaCha
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 7.5

◆ SpeedifySDK_SetCaptivePortalLoginMode()

SpeedifySDK_CaptivePortalLoginResult SpeedifySDK_SetCaptivePortalLoginMode	(	CSpeedifySDK	sdk,
		bool	enabled,
		const char *	adapterID,
		SpeedifySDK_CaptivePortalLoginCallback	cb,
		void *	userData
	)

Controls the captive portal login mode. If enabled, new port 80, 443, and 53 sockets will be directed through the chosen adapter instead of over the VPN tunnel. Can only be started while the VPN tunnel is connected. If enabling, an adapterID must be provided.

Parameters

sdk	SpeedifySDK object
enabled	if captive portal login mode is enabled
adapterID	guid of adapter, from adapters list
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: captive portal login mode result object

Since: 9.0

◆ SpeedifySDK_SetConnectionEncryption()

SpeedifySDK_SettingsResult SpeedifySDK_SetConnectionEncryption	(	CSpeedifySDK	sdk,
		const char *	adapterID,
		bool	encrypted,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

Change encryption settings per connection.

Parameters

sdk	SpeedifySDK object
adapterID	ID of the adapterID
encrypted	whether to encrypt
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 7.5

◆ SpeedifySDK_SetConnectionPriorities()

SpeedifySDK_AdaptersResult SpeedifySDK_SetConnectionPriorities	(	CSpeedifySDK	sdk,
		const char *	adapterID,
		SpeedifySDK_ConnectionPriority	priority,
		SpeedifySDK_AdaptersCallback	cb,
		void *	userData
	)

Change priorities of a connection.

Parameters

sdk	SpeedifySDK object
adapterID	guid of adapter, from adapters list.
priority	priority level
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: adapters result object

Since: 7.5

◆ SpeedifySDK_SetConnectionRateLimit()

SpeedifySDK_AdaptersResult SpeedifySDK_SetConnectionRateLimit	(	CSpeedifySDK	sdk,
		const char *	adapterID,
		int64_t	bps,
		SpeedifySDK_AdaptersCallback	cb,
		void *	userData
	)

Set the speed rate limit on a connection.

Parameters

sdk	SpeedifySDK object
adapterID	guid of adapter, from adapters list
bps	rate limit, in bits per second
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: adapters result object

Since: 7.5

◆ SpeedifySDK_SetConnectionTransportMode()

SpeedifySDK_SettingsResult SpeedifySDK_SetConnectionTransportMode	(	CSpeedifySDK	sdk,
		SpeedifySDK_TransportMode	mode,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

Sets the transport mode selection used for each connection.

Parameters

sdk	SpeedifySDK object
mode	selection mode to use
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 7.5

◆ SpeedifySDK_SetConnectMethodAuto()

SpeedifySDK_ServerSettingsResult SpeedifySDK_SetConnectMethodAuto	(	CSpeedifySDK	sdk,
		SpeedifySDK_AutoConnectMethod	method,
		SpeedifySDK_ServerSettingsCallback	cb,
		void *	userData
	)

Set the default connection method to an automatic selection method.

Parameters

sdk	SpeedifySDK object
method	automatic server selection method to use
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: server settings result object

Since: 7.5

◆ SpeedifySDK_SetConnectMethodCity()

SpeedifySDK_ServerSettingsResult SpeedifySDK_SetConnectMethodCity	(	CSpeedifySDK	sdk,
		const char *	country,
		const char *	city,
		SpeedifySDK_ServerSettingsCallback	cb,
		void *	userData
	)

Set the default connection method to a specific city.

Parameters

sdk	SpeedifySDK object
country	2-char ISO country code
city	city name
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: server settings result object

Since: 7.5

◆ SpeedifySDK_SetConnectMethodCountry()

SpeedifySDK_ServerSettingsResult SpeedifySDK_SetConnectMethodCountry	(	CSpeedifySDK	sdk,
		const char *	country,
		SpeedifySDK_ServerSettingsCallback	cb,
		void *	userData
	)

Set the default connection method to a specific country.

Parameters

sdk	SpeedifySDK object
country	2-char ISO country code
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: server settings result object

Since: 7.5

◆ SpeedifySDK_SetConnectMethodServer()

SpeedifySDK_ServerSettingsResult SpeedifySDK_SetConnectMethodServer	(	CSpeedifySDK	sdk,
		const char *	country,
		const char *	city,
		int32_t	num,
		SpeedifySDK_ServerSettingsCallback	cb,
		void *	userData
	)

Set the default connection method to a specific server.

Parameters

sdk	SpeedifySDK object
country	2-char ISO country code
city	city name
num	server number
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: server settings result object

Since: 7.5

◆ SpeedifySDK_SetCrashReports()

SpeedifySDK_PrivacySettingsResult SpeedifySDK_SetCrashReports	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_PrivacySettingsCallback	cb,
		void *	userData
	)

Sets if crash reporting should be enabled.

Parameters

sdk	SpeedifySDK object
enabled	If reporting is enabled
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: privacy settings result object

Since: 7.5

Deprecated:: As of 10.5. Functionality removed.

◆ SpeedifySDK_SetDaemonLogSettings()

SpeedifySDK_LogSettingsResult SpeedifySDK_SetDaemonLogSettings	(	CSpeedifySDK	sdk,
		SpeedifySDK_DaemonLogSettings	daemon,
		SpeedifySDK_LogSettingsCallback	cb,
		void *	userData
	)

Set daemon log file settings.

Requires daemon restart to take effect.

Parameters

sdk	SpeedifySDK object
daemon	daemon log settings
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: log settings object

Since: 10.5

◆ SpeedifySDK_SetDirectoryDomain()

SpeedifySDK_DirectorySettingsResult SpeedifySDK_SetDirectoryDomain	(	CSpeedifySDK	sdk,
		const char *	domain,
		SpeedifySDK_DirectorySettingsCallback	cb,
		void *	userData
	)

Change directory server used for user authentication and server management.

If using your own directory server, this should be called before SpeedifySDK_Login(), SpeedifySDK_LoginOAuth(), or SpeedifySDK_LoginAutoAccount().

Parameters

sdk	SpeedifySDK object
domain	directory server domain
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: directory domain result object

Since: 7.5

◆ SpeedifySDK_SetDirectoryGatewayURI()

SpeedifySDK_DirectorySettingsResult SpeedifySDK_SetDirectoryGatewayURI	(	CSpeedifySDK	sdk,
		const char *	gatewayUri,
		SpeedifySDK_DirectorySettingsCallback	cb,
		void *	userData
	)

Set an oauth gateway to use for directory server requests.

If using your own directory gateway, this should be called before SpeedifySDK_LoginOAuth().

Parameters

sdk	SpeedifySDK object
gatewayUri	directory gateway uri
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: directory domain result object

Since: 10.5

◆ SpeedifySDK_SetDnsLeak()

SpeedifySDK_PrivacySettingsResult SpeedifySDK_SetDnsLeak	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_PrivacySettingsCallback	cb,
		void *	userData
	)

Sets if DNS Leak protection is enabled.

Windows Only

Parameters

sdk	SpeedifySDK object
enabled	If dns leak protection is enabled
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: privacy settings result object

Since: 7.5

◆ SpeedifySDK_SetDNSServers()

SpeedifySDK_PrivacySettingsResult SpeedifySDK_SetDNSServers	(	CSpeedifySDK	sdk,
		uint16_t	count,
		SpeedifySDK_IPAddressString *	dnsAddrs,
		SpeedifySDK_PrivacySettingsCallback	cb,
		void *	userData
	)

Sets DNS servers to use.

Pass 0 addresses to restore defaults.
Windows & Mac Only

Parameters

sdk	SpeedifySDK object
count	number of addresses specified
dnsAddrs	addresses of dns servers
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: privacy settings result object

Since: 7.5

◆ SpeedifySDK_SetDoNotStoreCredentials()

SpeedifySDK_PrivacySettingsResult SpeedifySDK_SetDoNotStoreCredentials	(	CSpeedifySDK	sdk,
		bool	doNotStore,
		SpeedifySDK_PrivacySettingsCallback	cb,
		void *	userData
	)

Sets if credentials will not be stored.

This includes passwords, OAuth tokens, and Safe Browsing init config.

Parameters

sdk	SpeedifySDK object
doNotStore	If credentials will not be stored
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: privacy settings result object

Since: 10.5

◆ SpeedifySDK_SetEnableDefaultRoute()

SpeedifySDK_SettingsResult SpeedifySDK_SetEnableDefaultRoute	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

Set whether the default route (0.0.0.0/0) goes over the VPN tunnel.

Parameters

sdk	SpeedifySDK object
enabled	if default route is added to the interface
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 7.5

◆ SpeedifySDK_SetESNIEnabled()

SpeedifySDK_DirectorySettingsResult SpeedifySDK_SetESNIEnabled	(	CSpeedifySDK	sdk,
		bool	enableEsni,
		SpeedifySDK_DirectorySettingsCallback	cb,
		void *	userData
	)

Sets if ESNI is used when talking to the directory domain.

If using your own directory server, this should be called before SpeedifySDK_Login(), SpeedifySDK_LoginOAuth(), or SpeedifySDK_LoginAutoAccount().

Parameters

sdk	SpeedifySDK object
enableEsni	is ESNI is used to talk to the directory
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: directory domain result object

Since: 10.4

◆ SpeedifySDK_SetFirewallDomains()

SpeedifySDK_FirewallSettingsResult SpeedifySDK_SetFirewallDomains	(	CSpeedifySDK	sdk,
		uint16_t	count,
		SpeedifySDK_DomainString *	domains,
		SpeedifySDK_FirewallSettingsCallback	cb,
		void *	userData
	)

Set domains to firewall.

Parameters

sdk	SpeedifySDK object
count	number of domain objects
domains	domain names to deny/allow
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: firewall result object

Since: 9.2

◆ SpeedifySDK_SetFirewallIPv4()

SpeedifySDK_FirewallSettingsResult SpeedifySDK_SetFirewallIPv4	(	CSpeedifySDK	sdk,
		uint16_t	count,
		struct in_addr *	ipv4,
		SpeedifySDK_FirewallSettingsCallback	cb,
		void *	userData
	)

Set IPv4 address to firewall. IP addresses should be in network byte order.

Parameters

sdk	SpeedifySDK object
count	number of domain objects
ipv4	ipv4 addresses to deny/allow
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: firewall result object

Since: 9.2

◆ SpeedifySDK_SetFirewallIPv6()

SpeedifySDK_FirewallSettingsResult SpeedifySDK_SetFirewallIPv6	(	CSpeedifySDK	sdk,
		uint16_t	count,
		struct in6_addr *	ipv6,
		SpeedifySDK_FirewallSettingsCallback	cb,
		void *	userData
	)

Set IPv6 address to firewall. IP addresses should be in network byte order.

Parameters

sdk	SpeedifySDK object
count	number of domain objects
ipv6	ipv6 addresses to deny/allow
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: firewall result object

Since: 9.3

◆ SpeedifySDK_SetFirewallMode()

SpeedifySDK_FirewallSettingsResult SpeedifySDK_SetFirewallMode	(	CSpeedifySDK	sdk,
		SpeedifySDK_FirewallMode	mode,
		SpeedifySDK_FirewallSettingsCallback	cb,
		void *	userData
	)

Set the mode used by the firewall.

Parameters

sdk	SpeedifySDK object
mode	how matches are treated
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: firewall result object

Since: 9.2

◆ SpeedifySDK_SetFirewallPorts()

SpeedifySDK_FirewallSettingsResult SpeedifySDK_SetFirewallPorts	(	CSpeedifySDK	sdk,
		uint16_t	count,
		SpeedifySDK_FirewallPort *	ports,
		SpeedifySDK_FirewallSettingsCallback	cb,
		void *	userData
	)

Set ports to firewall Ports should be in host byte order.

Parameters

sdk	SpeedifySDK object
count	number of domain objects
ports	ports to deny/allow
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: firewall result object

Since: 9.2

◆ SpeedifySDK_SetForwardPorts()

SpeedifySDK_SettingsResult SpeedifySDK_SetForwardPorts	(	CSpeedifySDK	sdk,
		uint16_t	count,
		SpeedifySDK_ForwardedPort *	ports,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

Set ports to be forwarded to this client when connected to a dedicated server.

Parameters

sdk	SpeedifySDK object
count	number of ports specified
ports	ports to be forwarded
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 7.5

◆ SpeedifySDK_SetHeaderCompression()

SpeedifySDK_SettingsResult SpeedifySDK_SetHeaderCompression	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

Sets whether to allow header compression of packets sent over the VPN.

Parameters

sdk	SpeedifySDK object
enabled	allow header compression
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 10.6

◆ SpeedifySDK_SetIpLeak()

SpeedifySDK_PrivacySettingsResult SpeedifySDK_SetIpLeak	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_PrivacySettingsCallback	cb,
		void *	userData
	)

Sets if IP Leak protection is enabled.

Windows Only

Parameters

sdk	SpeedifySDK object
enabled	If ip leak protection is enabled
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: privacy settings result object

Since: 10.3

◆ SpeedifySDK_SetJumboPackets()

SpeedifySDK_SettingsResult SpeedifySDK_SetJumboPackets	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

Sets whether to allow jumbo packets over the VPN tunnel.

Parameters

sdk	SpeedifySDK object
enabled	allow jumbo packets
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 7.5

◆ SpeedifySDK_SetKillswitch()

SpeedifySDK_PrivacySettingsResult SpeedifySDK_SetKillswitch	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_PrivacySettingsCallback	cb,
		void *	userData
	)

Sets if Internet Killswitch should be enabled.

When enabled, Internet connectivity is disabled if Speedify is not connected.
Windows Only

Parameters

sdk	SpeedifySDK object
enabled	If killswitch is enabled
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: privacy settings result object

Since: 7.5

◆ SpeedifySDK_SetLocalProxyDomains()

SpeedifySDK_LocalProxySettingsResult SpeedifySDK_SetLocalProxyDomains	(	CSpeedifySDK	sdk,
		uint16_t	count,
		SpeedifySDK_DomainString *	domains,
		SpeedifySDK_LocalProxySettingsCallback	cb,
		void *	userData
	)

Set domains to proxy locally, instead of going through the VPN.

Parameters

sdk	SpeedifySDK object
count	number of domain objects
domains	domain names to redirect through the local proxy
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: local proxy result object

Since: 9.2

◆ SpeedifySDK_SetLocalProxyDomainWatchlist()

SpeedifySDK_LocalProxySettingsResult SpeedifySDK_SetLocalProxyDomainWatchlist	(	CSpeedifySDK	sdk,
		uint16_t	count,
		SpeedifySDK_LocalProxyDomainWatchlistItem *	domainWatchlist,
		SpeedifySDK_LocalProxySettingsCallback	cb,
		void *	userData
	)

Set domain watchlist settings for the local proxy.

Parameters

sdk	SpeedifySDK object
count	number of domain watchlist items
domainWatchlist	domain watchlist items
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: local proxy result object

Since: 9.3

◆ SpeedifySDK_SetLocalProxyDomainWatchlistEnable()

SpeedifySDK_LocalProxySettingsResult SpeedifySDK_SetLocalProxyDomainWatchlistEnable	(	CSpeedifySDK	sdk,
		const char *	title,
		bool	enabled,
		SpeedifySDK_LocalProxySettingsCallback	cb,
		void *	userData
	)

Toggle a single domain watchlist item from being enabled over the local proxy.

Parameters

sdk	SpeedifySDK object
title	watchlist item title
enabled	if this watchlist item's domains should be included in the local proxy filter
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: local proxy result object

Since: 9.3

◆ SpeedifySDK_SetLocalProxyEnabled()

SpeedifySDK_LocalProxySettingsResult SpeedifySDK_SetLocalProxyEnabled	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_LocalProxySettingsCallback	cb,
		void *	userData
	)

Enables or disables the local proxy.

Parameters

sdk	SpeedifySDK object
enabled	enable the local proxy
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: local proxy result object

Since: 9.2

◆ SpeedifySDK_SetLocalProxyIPv4()

SpeedifySDK_LocalProxySettingsResult SpeedifySDK_SetLocalProxyIPv4	(	CSpeedifySDK	sdk,
		uint16_t	count,
		struct in_addr *	ipv4,
		SpeedifySDK_LocalProxySettingsCallback	cb,
		void *	userData
	)

Set IPv4 address to proxy locally, instead of going through the VPN. IP addresses should be in network byte order.

Parameters

sdk	SpeedifySDK object
count	number of domain objects
ipv4	ipv4 addresses to redirect through the local proxy
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: local proxy result object

Since: 9.2

◆ SpeedifySDK_SetLocalProxyMatchMode()

SpeedifySDK_LocalProxySettingsResult SpeedifySDK_SetLocalProxyMatchMode	(	CSpeedifySDK	sdk,
		SpeedifySDK_ProxyMatchMode	matchMode,
		SpeedifySDK_LocalProxySettingsCallback	cb,
		void *	userData
	)

Set the match mode used by the local proxy.

Parameters

sdk	SpeedifySDK object
matchMode	how matches are treated
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: local proxy result object

Since: 9.2

◆ SpeedifySDK_SetLocalProxyPorts()

SpeedifySDK_LocalProxySettingsResult SpeedifySDK_SetLocalProxyPorts	(	CSpeedifySDK	sdk,
		uint16_t	count,
		SpeedifySDK_LocalProxyPort *	ports,
		SpeedifySDK_LocalProxySettingsCallback	cb,
		void *	userData
	)

Set ports to proxy locally, instead of going through the VPN. Ports should be in host byte order.

Parameters

sdk	SpeedifySDK object
count	number of domain objects
ports	to redirect through the local proxy
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: local proxy result object

Since: 9.9

◆ SpeedifySDK_SetLocalVendorSettings()

SpeedifySDK_VendorSettingsResult SpeedifySDK_SetLocalVendorSettings	(	CSpeedifySDK	sdk,
		const char *	settingsJson,
		bool	merge,
		SpeedifySDK_VendorSettingsCallback	cb,
		void *	userData
	)

Set local vendor settings.

Parameters

sdk	SpeedifySDK object
settingsJson	a json object as a string
merge	if true, settingsJson is merged in to existing local vendor settings. if false, settingsJson replaces existing local vendor settings
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: vendor settings result object

Since: 9.2

◆ SpeedifySDK_SetMode()

SpeedifySDK_SettingsResult SpeedifySDK_SetMode	(	CSpeedifySDK	sdk,
		SpeedifySDK_BondingMode	mode,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

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

Parameters

sdk	SpeedifySDK object
mode	desired mode
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 7.5

◆ SpeedifySDK_SetOverflowThreshold()

SpeedifySDK_SettingsResult SpeedifySDK_SetOverflowThreshold	(	CSpeedifySDK	sdk,
		double	mbpsOverflow,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

Set the overflow threshold.

Parameters

sdk	SpeedifySDK object
mbpsOverflow	overflow threshold, in megabits per second
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 7.5

◆ SpeedifySDK_SetPacketAggregation()

SpeedifySDK_SettingsResult SpeedifySDK_SetPacketAggregation	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

Sets whether to allow aggregating smaller packets sent over the VPN.

Parameters

sdk	SpeedifySDK object
enabled	allow packet aggregation
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 8.0

◆ SpeedifySDK_SetReportingEncryptionKey()

SpeedifySDK_BaseResult SpeedifySDK_SetReportingEncryptionKey	(	CSpeedifySDK	sdk,
		const char *	key128bit
	)

Set reporting encryption key.

Parameters

sdk	SpeedifySDK object
key128bit	A 16 byte ascii encoded, 32byte hex encoded, or base64 encoded string used to encrypt sensitive reports, or null to use default.

Returns: result object

Since: 7.5

◆ SpeedifySDK_SetSafeBrowsingConfig()

SpeedifySDK_SafeBrowsingResult SpeedifySDK_SetSafeBrowsingConfig	(	CSpeedifySDK	sdk,
		const char *	safeBrowsingConfig,
		SpeedifySDK_SafeBrowsingCallback	cb,
		void *	userData
	)

Sets an optional config, used to bypass certain initialization steps. Applied to subsequent init calls.

Parameters

sdk	SpeedifySDK object
safeBrowsingConfig	a configuration string for the safe browsing service
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: safe browsing result object

Since: 10.6

◆ SpeedifySDK_SetSafeBrowsingEnabled()

SpeedifySDK_SafeBrowsingResult SpeedifySDK_SetSafeBrowsingEnabled	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_SafeBrowsingCallback	cb,
		void *	userData
	)

Sets if Safe Browsing is enabled.

Parameters

sdk	SpeedifySDK object
enabled	if safe browsing should be enabled
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: safe browsing result object

Since: 10.6

◆ SpeedifySDK_SetStartupConnect()

SpeedifySDK_SettingsResult SpeedifySDK_SetStartupConnect	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

Set if Speedify should autmatically connect when the daemon starts.

Parameters

sdk	SpeedifySDK object
enabled	automatically connect
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 7.5

◆ SpeedifySDK_SetTunnelEncrypted()

SpeedifySDK_SettingsResult SpeedifySDK_SetTunnelEncrypted	(	CSpeedifySDK	sdk,
		bool	enabled,
		SpeedifySDK_SettingsCallback	cb,
		void *	userData
	)

Sets encryption status on all connections forming the tunnels.

Parameters

sdk	SpeedifySDK object
enabled	whether to encrypt
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: settings result object

Since: 7.5

◆ SpeedifySDK_SetVendorUserData()

SpeedifySDK_VendorUserDataResult SpeedifySDK_SetVendorUserData	(	CSpeedifySDK	sdk,
		const char *	vendorUserData,
		SpeedifySDK_VendorUserDataCallback	cb,
		void *	userData
	)

Set vendor user data.

Parameters

sdk	SpeedifySDK object
vendorUserData	a string of user data
cb	optional callback
userData	optional user data pointer returned in the callback

Returns: vendor user data result object

Since: 9.8

◆ SpeedifySDK_StartSpeedtest()

SpeedifySDK_SpeedtestResult SpeedifySDK_StartSpeedtest	(	CSpeedifySDK	sdk,
		bool	reportProgress,
		SpeedifySDK_SpeedtestCallback	cb,
		void *	userData
	)

Starts a test of speeds through Speedify.

Parameters

sdk	SpeedifySDK object
reportProgress	if intermediate progress reports should also be reported. These are always delivered to the callback.
cb	optional callback, required to get intermediate progress reports
userData	optional user data pointer returned in the callback

Returns: speedtest result object

Since: 7.5

◆ SpeedifySDK_StopSpeedtest()

SpeedifySDK_BaseResult SpeedifySDK_StopSpeedtest ( CSpeedifySDK sdk )

Stops an in-progress speed test.

Parameters

sdk	SpeedifySDK object

Returns: result object

Since: 7.5

◆ SpeedifySDK_UnregisterCallback()

void SpeedifySDK_UnregisterCallback	(	CSpeedifySDK	sdk,
		SpeedifySDK_EventID	eventId
	)

Unregister an asynchronous callback registered via other calls.

Parameters

sdk	SpeedifySDK object
eventId	id of the callback obtained from the result object's eventId field

Since: 7.5

◆ SpeedifySDK_WaitOnCallback()

bool SpeedifySDK_WaitOnCallback	(	CSpeedifySDK	sdk,
		SpeedifySDK_EventID	eventId,
		uint64_t	timeoutMs
	)

Wait for an asynchronous result.

Parameters

sdk	SpeedifySDK object
eventId	id of an asynchronous sdk call result
timeoutMs	maximum time in milliseconds to wait, 0 for no timeout

Returns: if callback succeeded, false on timeout or invalid argument

Since: 10.0

Detailed Description

Functions

Function Documentation

◆ SpeedifySDK_AccountCheck()

◆ SpeedifySDK_AccountCreate()

◆ SpeedifySDK_AccountPasswordChange()

◆ SpeedifySDK_AddAdapterDailyDataLimitBoost()

◆ SpeedifySDK_CheckForCaptivePortals()

◆ SpeedifySDK_ConnectAuto()

◆ SpeedifySDK_ConnectCity()

◆ SpeedifySDK_ConnectCountry()

◆ SpeedifySDK_ConnectProxy()

◆ SpeedifySDK_ConnectServer()

◆ SpeedifySDK_Create()

◆ SpeedifySDK_CreateWithSettings()

◆ SpeedifySDK_DaemonExit()

◆ SpeedifySDK_Destroy()

◆ SpeedifySDK_DisableAdapterDailyDataLimit()

◆ SpeedifySDK_DisableAdapterMonthlyDataLimit()

◆ SpeedifySDK_Disconnect()

◆ SpeedifySDK_EnableConnectionStatUpdates()

◆ SpeedifySDK_EnableStatUpdates()

◆ SpeedifySDK_EraseAllLogFiles()

◆ SpeedifySDK_Free()

◆ SpeedifySDK_GetAccountingData()

◆ SpeedifySDK_GetAdapters()

◆ SpeedifySDK_GetCaptivePortalLoginMode()

◆ SpeedifySDK_GetConnectedServer()

◆ SpeedifySDK_GetConnectionStats()

◆ SpeedifySDK_GetDirectory()

◆ SpeedifySDK_GetDirectoryDomain()

◆ SpeedifySDK_GetDirectorySettings()

◆ SpeedifySDK_GetFirewallSettings()

◆ SpeedifySDK_GetHistoricConnectionStats()

◆ SpeedifySDK_GetLastDisconnectEvent()

◆ SpeedifySDK_GetLocalProxySettings()

◆ SpeedifySDK_GetLocalVendorSettings()

◆ SpeedifySDK_GetLogSettings()

◆ SpeedifySDK_GetPrivacySettings()

◆ SpeedifySDK_GetRemoteVendorSettings()

◆ SpeedifySDK_GetSafeBrowsing()

◆ SpeedifySDK_GetSafeBrowsingStats()

◆ SpeedifySDK_GetServerSettings()

◆ SpeedifySDK_GetSessionStats()

◆ SpeedifySDK_GetSettings()

◆ SpeedifySDK_GetState()

◆ SpeedifySDK_GetStreamingStats()

◆ SpeedifySDK_GetVendorUserData()

◆ SpeedifySDK_GetVersion()

◆ SpeedifySDK_HandleAdapterOverlimit()

◆ SpeedifySDK_HandleNewAdapter()

◆ SpeedifySDK_InitSafeBrowsing()

◆ SpeedifySDK_ListenForAdapterOverlimit()

◆ SpeedifySDK_ListenForCaptivePortals()

◆ SpeedifySDK_ListenForLocalProxyDomainWatchlistHit()

◆ SpeedifySDK_ListenForNewAdapter()

◆ SpeedifySDK_ListenForSafeBrowsingBlock()

◆ SpeedifySDK_ListenForSafeBrowsingError()

◆ SpeedifySDK_ListenForTorrentDetection()

◆ SpeedifySDK_Login()

◆ SpeedifySDK_LoginAutoAccount()

◆ SpeedifySDK_LoginLocalLoopbackOnly()

◆ SpeedifySDK_LoginOAuth()

◆ SpeedifySDK_Logout()

◆ SpeedifySDK_ResetAdapterUsage()

◆ SpeedifySDK_ResetConnectionRateLimit()

◆ SpeedifySDK_ResetDirectoryDomain()

◆ SpeedifySDK_ResetDirectoryGatewayURI()

◆ SpeedifySDK_SetAdapterDailyDataLimit()

◆ SpeedifySDK_SetAdapterMonthlyDataLimit()

◆ SpeedifySDK_SetAdapterOverlimitRateLimit()

◆ SpeedifySDK_SetAllowChaChaEncryption()

◆ SpeedifySDK_SetCaptivePortalLoginMode()

◆ SpeedifySDK_SetConnectionEncryption()

◆ SpeedifySDK_SetConnectionPriorities()

◆ SpeedifySDK_SetConnectionRateLimit()

◆ SpeedifySDK_SetConnectionTransportMode()

◆ SpeedifySDK_SetConnectMethodAuto()

◆ SpeedifySDK_SetConnectMethodCity()

◆ SpeedifySDK_SetConnectMethodCountry()