types.h File Reference

#include "sdkdefines.h"
#include <stdbool.h>
#include <stdint.h>
#include <time.h>
#include "../cJSON.h"
#include <netinet/ip.h>
#include <arpa/inet.h>

Go to the source code of this file.

Data Structures
struct	SpeedifySDK_CreateSettings
	SDK creation settings structure. More...
struct	SpeedifySDK_Version
	Version structure. More...
struct	SpeedifySDK_ServerInformation
	Detailed information about a server. More...
struct	SpeedifySDK_AccountingData
	Data on an account. More...
struct	SpeedifySDK_AdapterUsageData
	Information about the data usage and limits of a network adapter. More...
struct	SpeedifySDK_ConnectionDirectionalSettings
	Directional settings for a connection. More...
struct	SpeedifySDK_AdapterData
	Information about a network adapter. More...
struct	SpeedifySDK_ServerSettings
	Automatic server selection method settings. More...
struct	SpeedifySDK_ProtocolPortPair
	A protocol/port pair. More...
struct	SpeedifySDK_Subnet
	A subnet. More...
struct	SpeedifySDK_PerConnectionEncryption
	Adapter setting for per-connection encryption. More...
struct	SpeedifySDK_PerConnectionExposeDscp
	Adapter setting for per-connection expose DSCP. More...
struct	SpeedifySDK_PerConnectionParallelSockets
	Adapter setting for per-connection parallel sockets. More...
struct	SpeedifySDK_TargetNumberOfConnections
	Target number of connections for the VPN tunnel. More...
struct	SpeedifySDK_Settings
	Speedify settings. More...
struct	SpeedifySDK_PrivacySettings
	Privacy settings. More...
struct	SpeedifySDK_ConnectionStats
	Statistics about a connection. More...
struct	SpeedifySDK_ConnectionStatsGroup
	A grouping of ConnectionStats. More...
struct	SpeedifySDK_TunStats
	Contains stats regarding the TUN, for use in session stats. More...
struct	SpeedifySDK_HandlerStats
	Contains stats regarding the packet handler, for use in session stats. More...
struct	SpeedifySDK_CaptivePortalStats
	Contains stats regarding the captive portal. More...
struct	SpeedifySDK_StreamingSessionStats
	Contains session stats regarding streaming mode. More...
struct	SpeedifySDK_DscpStats
	Contains stats for a defined DSCP queue. More...
struct	SpeedifySDK_DscpStatsArray
	Array of DSCP queue stats. More...
struct	SpeedifySDK_SessionStats
	Statistics for a period. More...
struct	SpeedifySDK_SessionStatPeriods
	Statistics for sessions over various time periods. More...
struct	SpeedifySDK_LocalProxyDomainWatchlistItem
	Local proxy domain watchlist item. More...
struct	SpeedifySDK_LocalProxySettings
	Settings for the local proxy. More...
struct	SpeedifySDK_StreamingSettings
	Settings for the priority streaming. More...
struct	SpeedifySDK_FirewallSettings
	Firewall settings. More...
struct	SpeedifySDK_StreamStats
	Statistics for a single stream. More...
struct	SpeedifySDK_StreamingStats
	Streaming mode stats. More...
struct	SpeedifySDK_DisconnectEvent
	Information about a disconnect event. More...
struct	SpeedifySDK_DaemonLogSettings
	Settings for logging in the daemon. More...
struct	SpeedifySDK_DirectorySettings
	Directory settings. More...
struct	SpeedifySDK_SpeedTestResultData
	Results of a speed test. More...
struct	SpeedifySDK_NetworkSharingSettings
	Network sharing settings. More...
struct	SpeedifySDK_NetworkSharingUsage
	Network sharing usage data. More...
struct	SpeedifySDK_NetworkSharingConnection
	Network sharing connection. More...
struct	SpeedifySDK_NetworkSharePeer
	Represents a network share peer. More...
struct	SpeedifySDK_DSCPQueue
	DSCP queue configuration. More...
struct	SpeedifySDK_DSCPSettings
	DSCP settings. More...

Enumerations
enum	SpeedifySDK_State {   STATE_LOGGED_OUT , STATE_LOGGING_IN , STATE_LOGGED_IN , STATE_AUTO_CONNECTING ,   STATE_CONNECTING , STATE_DISCONNECTING , STATE_CONNECTED , STATE_OVERLIMIT ,   STATE_UNKNOWN }
	State of the VPN. More...
enum	SpeedifySDK_AutoConnectMethod {   ACM_CLOSEST , ACM_CLOSESTPRIVATE , ACM_CLOSESTPUBLIC , ACM_LAST ,   ACM_P2P , ACM_BYSETTING , ACM_COUNTRYCITYSERVER , ACM_EXACT ,   ACM_PROXY , ACM_IGNORELAST }
	Methods for automatic server selection. More...
enum	SpeedifySDK_AccountPaymentType { APT_FREE , APT_MONTHLY , APT_YEARLY }
	Information on an account's payment type. More...
enum	SpeedifySDK_AccountAction {   AA_NONE , AA_RETRY_LOGIN , AA_CONNECT_INTERNET_AND_RETRY_LOGIN , AA_ACTIVATE ,   AA_ACTIVATE_OR_PURCHASE_LICENCE }
	Actions that should be taken on an account. More...
enum	SpeedifySDK_ConnectionState { CSTATE_DISCONNECTED , CSTATE_CONNECTING , CSTATE_CONNECTED }
	State of Speedify on a given connection (network adapter). More...
enum	SpeedifySDK_NetworkType {   NETWORKTYPE_WIFI , NETWORKTYPE_ETHERNET , NETWORKTYPE_CELLULAR , NETWORKTYPE_VPN ,   NETWORKTYPE_LOOPBACK , NETWORKTYPE_BLUETOOTH , NETWORKTYPE_NETWORKSHARE_CLIENT , NETWORKTYPE_NETWORKSHARE_HOST ,   NETWORKTYPE_UNKNOWN }
	Type of network adapter. More...
enum	SpeedifySDK_ConnectionPriority {   CP_ALWAYS , CP_SECONDARY , CP_BACKUP , CP_NEVER ,   CP_AUTOMATIC }
	How a connection should be combined. More...
enum	SpeedifySDK_ConnectionDirectionalMode { CDM_ON , CDM_STRICT_OFF , CDM_BACKUP_OFF }
	Directional mode of a connection. More...
enum	SpeedifySDK_BondingMode { BMODE_SPEED , BMODE_REDUNDANT , BMODE_STREAMING }
	Mode of the VPN tunnel. More...
enum	SpeedifySDK_TransportMode {   TMODE_TCP , TMODE_UDP , TMODE_AUTO , TMODE_HTTPS ,   TMODE_MULTITCP , TMODE_PROXY , TMODE_SHARE }
	Transport Protocol modes. More...
enum	SpeedifySDK_PortProtocol { PPROTO_TCP , PPROTO_UDP , PPROTO_ICMP }
	Protocol for ports. More...
enum	SpeedifySDK_ErrorType {   ET_OK = 0 , ET_NETWORK = 1 , ET_SERVER = 2 , ET_CREDENTIAL = 3 ,   ET_DIRECTORY = 4 , ET_ACCOUNT = 5 , ET_RATELIMITED = 6 , ET_TOKEN_EXPIRED = 7 ,   ET_VPN_ADAPTER = 8 , ET_DEVICE_LIMIT = 10 , ET_LOCK_TEAM =11 , ET_LOCK_ACCOUNT =12 ,   ET_INVALID_ARGUMENT =13 , ET_SDK_ASYNC = 0xE00 , ET_SDK_ERROR = 0xF00 , ET_SDK_TIMEOUT ,   ET_SDK_INVALID_ARGUMENT , ET_SDK_CALLBACK_REQUIRED , ET_SDK_PLATFORM_NO_SUPPORT , ET_SDK_NO_CONNECTION ,   ET_SDK_SYNC_FROM_ASYNC , ET_SDK_SETTING_LOCKED_TEAM = ET_LOCK_TEAM , ET_SDK_SETTING_LOCKED_ACCOUNT = ET_LOCK_ACCOUNT }
	Type classification for errors. More...
enum	SpeedifySDK_ProxyMatchMode { PMM_ALLOWLIST , PMM_DENYLIST }
	How local proxy treats matches. More...
enum	SpeedifySDK_FirewallMode { FWM_OFF , FWM_ALLOWLIST , FWM_DENYLIST }
	How firewall treats matches. More...
enum	SpeedifySDK_StreamHealth { SH_STOPPED , SH_POOR , SH_GOOD }
	Stream health indicator. More...
enum	SpeedifySDK_DisconnectReason {   DR_UNKNOWN , DR_CONNECTIVITY , DR_AIRPLANE , DR_REBOOT ,   DR_UPDATE , DR_CRASH , DR_SLEEP , DR_USERINITIATED ,   DR_TORRENT , DR_SERVICESTOP , DR_STARTTIMEOUT , DR_INACTIVETIMEOUT ,   DR_SETTINGCHANGERECONNECT , DR_DNSTIMEOUT , DR_TUNNELTIMEOUT , DR_OVERQUOTA ,   DR_SAFENETWORK , DR_NONE }
	Reason for a disconnect. More...
enum	SpeedifySDK_LogLevel { LL_VERBOSE , LL_INFO , LL_WARN , LL_ERROR }
	Log levels in the SDK. More...
enum	SpeedifySDK_SafeBrowsingError {   CUJO_OK , CUJO_ERR_NO_ENDPOINT_URL , CUJO_ERR_NOT_CONFIGURED , CUJO_ERR_TIMED_OUT ,   CUJO_ERR_RETRIABLE_SERVER_ERROR , CUJO_ERR_HTTP_STATUS , CUJO_ERR_CURL , CUJO_ERR_NO_MEMORY ,   CUJO_ERR_BAD_FUNCTION_ARGUMENT , CUJO_ERR_PARSE_ERROR , CUJO_ERR_CURL_INIT_FAILURE , CUJO_ERR_CURL_EASY_INIT_FAILURE ,   CUJO_ERR_CURL_HEADER_APPEND_FAILURE , CUJO_ERR_JSON_SET_FAILURE , CUJO_ERR_UV_LOOP_INIT_FAILURE , CUJO_ERR_ALREADY_IN_PROGRESS ,   CUJO_ERR_INVALID_NSP_TOKEN , CUJO_ERR_ON_PROTECTED_NETWORK , CUJO_ERR_ASYNC_INIT_FAILURE , CUJO_ERR_INTERRUPTED_EVENT_LOOP }
	Safe browsing errors. More...
enum	SpeedifySDK_SafeBrowsingLogLevel {   CUJO_LOG_DEBUG , CUJO_LOG_INFO , CUJO_LOG_ERROR , CUJO_LOG_TRACE ,   CUJO_LOG_WARNING }
	Log levels in the SDK. More...
enum	SpeedifySDK_SafeBrowsingSafeNetworkOverride { SN_OVERRIDE_NONE , SN_OVERRIDE_UNSAFE , SN_OVERRIDE_SAFE }
	Override safe network decisions. More...
enum	SpeedifySDK_SpeedTestType { TEST_SPEED , TEST_STREAMING }
	Internal speed test types. More...
enum	SpeedifySDK_NetworkSharingPeerRole { PR_CLIENT , PR_HOST }
	peer role More...
enum	SpeedifySDK_NetworkSharingPairRequestBehavior { PRB_ASK , PRB_ACCEPT , PRB_REJECT }
	pair request behavior types More...
enum	SpeedifySDK_NetworkSharingAutoPairBehavior { APB_MANUAL , APB_AUTO_USER , APB_AUTO_USER_TEAM }
	Auto pair behavior types. More...
enum	SpeedifySDK_NetworkSharingPeerStatus { NPS_DISCONNECTED , NPS_UNAUTHENTICATED , NPS_AUTHENTICATED }
	Status of a NetworkSharing Peer Connection. More...
enum	SpeedifySDK_NetworkSharingTunnelStatus {   NTS_INACTIVE , NTS_ACTIVE , NTS_DISABLED_ON_CLIENT , NTS_DISABLED_ON_HOST ,   NTS_NO_NETWORKS , NTS_TUNNEL_ERROR , NTS_NOT_AUTHENTICATED , NTS_NETWORKS_OVERLIMIT ,   NTS_VPN_NOT_CONNECTED , NTS_PAUSED }
	Status of a NetworkSharing tunnel. More...
enum	SpeedifySDK_DSCPReplication { DSCP_REPLICATION_AUTO , DSCP_REPLICATION_ON , DSCP_REPLICATION_OFF }
	DSCP replication behavior. More...
enum	SpeedifySDK_DSCPPriority { DSCP_PRIORITY_AUTO , DSCP_PRIORITY_ON , DSCP_PRIORITY_OFF }
	DSCP priority behavior. More...
enum	SpeedifySDK_TrafficRuleChangeMethod { TRAFFIC_RULE_UPDATE , TRAFFIC_RULE_REPLACE , TRAFFIC_RULE_REMOVE }
	Traffic rules change method. More...

Functions
ENABLE_NETWORK_SHARING void	SpeedifySDK_InitializeCreateSettings (SpeedifySDK_CreateSettings *settings)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_Version_toString (SpeedifySDK_Version state)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_State_toString (SpeedifySDK_State state)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_AutoConnectMethod_toString (SpeedifySDK_AutoConnectMethod method)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_ServerInformation_GetCountryName (SpeedifySDK_ServerInformation server)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_ServerInformation_GetCityName (SpeedifySDK_ServerInformation server)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_ServerInformation_toString (SpeedifySDK_ServerInformation server)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_ServerInformationDetailed_GetCountryName (SpeedifySDK_ServerInformationDetailed server)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_ServerInformationDetailed_GetCityName (SpeedifySDK_ServerInformationDetailed server)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_ServerInformationDetailed_toString (SpeedifySDK_ServerInformationDetailed server)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_AccountPaymentType_toString (SpeedifySDK_AccountPaymentType paymentType)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_AccountAction_toString (SpeedifySDK_AccountAction action)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_ConnectionState_toString (SpeedifySDK_ConnectionState state)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_NetworkType_toString (SpeedifySDK_NetworkType type)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_ConnectionPriority_toString (SpeedifySDK_ConnectionPriority priority)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_ConnectionDirectionalMode_toString (SpeedifySDK_ConnectionDirectionalMode mode)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_BondingMode_toString (SpeedifySDK_BondingMode priority)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_TransportMode_toString (SpeedifySDK_TransportMode priority)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_PortProtocol_toString (SpeedifySDK_PortProtocol portProto)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_ErrorType_toString (SpeedifySDK_ErrorType error)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_ProxyMatchMode_toString (SpeedifySDK_ProxyMatchMode matchMode)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_FirewallMode_toString (SpeedifySDK_FirewallMode matchMode)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_StreamHealth_toString (SpeedifySDK_StreamHealth health)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_DisconnectReason_toString (SpeedifySDK_DisconnectReason reason)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_LogLevel_toString (SpeedifySDK_LogLevel level)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_SafeBrowsing_LogLevel_toString (SpeedifySDK_SafeBrowsingLogLevel level)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_SafeBrowsing_SafeNetworkOverride_toString (SpeedifySDK_SafeBrowsingSafeNetworkOverride level)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_SpeedTestType_toString (SpeedifySDK_SpeedTestType type)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_NetworkSharingPeerRole_toString (SpeedifySDK_NetworkSharingPeerRole role)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_NetworkSharingPairRequestBehavior_toString (SpeedifySDK_NetworkSharingPairRequestBehavior behavior)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_NetworkSharingAutoPairBehavior_toString (SpeedifySDK_NetworkSharingAutoPairBehavior behavior)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_NetworkSharingPeerStatus_toString (SpeedifySDK_NetworkSharingPeerStatus status)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_NetworkSharingTunnelStatus_toString (SpeedifySDK_NetworkSharingTunnelStatus status)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_DSCPReplication_toString (SpeedifySDK_DSCPReplication replication)
ENABLE_NETWORK_SHARING const char *	SpeedifySDK_DSCPPriority_toString (SpeedifySDK_DSCPPriority priority)

Variables
SpeedifySDK_EXTERN typedef char	SpeedifySDK_IPAddressString [SPEEDIFYSDK_MAX_IP_STRING_LENGTH]
	String representation of an IP address.
SpeedifySDK_EXTERN typedef char	SpeedifySDK_DomainString [SPEEDIFYSDK_MAX_DOMAIN_LENGTH]
	String representation of a domain or hostname.
SpeedifySDK_EXTERN typedef char	SpeedifySDK_AppNameString [SPEEDIFYSDK_MAX_APP_NAME_LENGTH]
	String representation of a SDK App name.
SpeedifySDK_EXTERN typedef SpeedifySDK_ServerInformation	SpeedifySDK_ServerInformationDetailed
	Information about a.
SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair	SpeedifySDK_ForwardedPort
	A forwarded port.
SpeedifySDK_EXTERN typedef char	SpeedifySDK_HostnameString [SPEEDIFYSDK_MAX_HOSTNAME_LENGTH]
	String representation of an IP address.
SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair	SpeedifySDK_LocalProxyPort
	A proxied port.
SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair	SpeedifySDK_StreamingPort
	A streaming port.
SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair	SpeedifySDK_FirewallPort
	A firewall port.
SpeedifySDK_EXTERN typedef char	SpeedifySDK_NetworkSharingConnectCode [SPEEDIFYSDK_MAX_NETWORKSHARING_CONNECT_CODE_LENGTH]
	Connect code for network sharing.
SpeedifySDK_EXTERN typedef char	SpeedifySDK_NetworkSharingDisplayName [SPEEDIFYSDK_MAX_NETWORKSHARING_DISPLAY_NAME_LENGTH]
	The public display name for this device.
SpeedifySDK_EXTERN typedef char	SpeedifySDK_NetworkSharingPeerUuid [SPEEDIFYSDK_NETWORKSHARING_PEER_UUID_LENGTH]
	Peer UUID for network sharing peer data.

Enumeration Type Documentation

SpeedifySDK_AccountAction

enum SpeedifySDK_AccountAction

Actions that should be taken on an account.

Since

14.9.1

Enumerator
AA_NONE	No action needed. Since 14.9.1
AA_RETRY_LOGIN	A (possibly temporary) error occurred. Retry login. Since 14.9.1
AA_CONNECT_INTERNET_AND_RETRY_LOGIN	Connect to the internet and retry login. Since 14.9.1
AA_ACTIVATE	No saved credentials/not previously activated. Activate the account. Since 14.9.1
AA_ACTIVATE_OR_PURCHASE_LICENCE	Current account does not have a license usable on this device. Activate or purchase a license. Since 14.9.1

SpeedifySDK_AccountPaymentType

enum SpeedifySDK_AccountPaymentType

Information on an account's payment type.

Since

9.4

Enumerator
APT_FREE	Free/unpaid. Since 9.4
APT_MONTHLY	Paid, monthly contract. Since 9.4
APT_YEARLY	Paid, yearly contract. Since 9.4

SpeedifySDK_AutoConnectMethod

enum SpeedifySDK_AutoConnectMethod

Methods for automatic server selection.

Since

7.5

Enumerator
ACM_CLOSEST	Closest public or private server to user. Since 7.5
ACM_CLOSESTPRIVATE	Closest private server to user. Since 7.5
ACM_CLOSESTPUBLIC	Closest public server to user. Since 7.5
ACM_LAST	Last server connected to. Since 7.5
ACM_P2P	Server that supports P2P/BitTorrent. Since 7.5
ACM_BYSETTING	Connect by automatic connection method. Since 7.5
ACM_COUNTRYCITYSERVER	By specific country/city/server. Since 7.5
ACM_EXACT	By exact specific country/city/server. Since 14.0
ACM_PROXY	Local-proxy only connection. Since 10.4
ACM_IGNORELAST	Connect using the current selection setting, but choose a different server instance than the one last used. Since 12.6

SpeedifySDK_BondingMode

enum SpeedifySDK_BondingMode

Mode of the VPN tunnel.

Since

7.5

Enumerator
BMODE_SPEED	Combine for speed. Since 7.5
BMODE_REDUNDANT	Combine for reliability. Since 7.5
BMODE_STREAMING	Optimize for streaming. Since 9.6

SpeedifySDK_ConnectionDirectionalMode

enum SpeedifySDK_ConnectionDirectionalMode

Directional mode of a connection.

Since

14.8.7

Enumerator
CDM_ON	Always on. Since 14.8.7
CDM_STRICT_OFF	Always off. Since 14.8.7
CDM_BACKUP_OFF	Off when not needed. Since 14.8.7

SpeedifySDK_ConnectionPriority

enum SpeedifySDK_ConnectionPriority

How a connection should be combined.

Since

7.5

Enumerator
CP_ALWAYS	Always use this connection. This is the default for all non-CELLULAR adapters. Since 7.5
CP_SECONDARY	Use this connection if others are full. This is the default for CELLULAR adapters. Since 7.5
CP_BACKUP	Use this connection if others are unavailable. Since 7.5
CP_NEVER	Never use this connection. Since 7.5
CP_AUTOMATIC	Let Speedify manage the priority. Since 12.4

SpeedifySDK_ConnectionState

enum SpeedifySDK_ConnectionState

State of Speedify on a given connection (network adapter).

Because different connections come and go, it's possible for Speedify as whole to be connected as long as even one tunnel is CONNECTED, while others may be CONNECTING or DISCONNECTED.

Since

7.5

Enumerator
CSTATE_DISCONNECTED	Disconnected. Since 7.5
CSTATE_CONNECTING	Connecting. Since 7.5
CSTATE_CONNECTED	Connected. Since 7.5

SpeedifySDK_DisconnectReason

enum SpeedifySDK_DisconnectReason

Reason for a disconnect.

Since

10.4

Enumerator
DR_UNKNOWN	Unknown reason. Since 10.4
DR_CONNECTIVITY	No network connectivity. Since 10.4
DR_AIRPLANE	Airplane mode activated, or no networks available. Since 10.4
DR_REBOOT	Device reboot. Since 10.4
DR_UPDATE	Software update. Since 10.4
DR_CRASH	Daemon crash. Since 10.4
DR_SLEEP	Device sleep. Since 10.4
DR_USERINITIATED	User initiated. Since 10.4
DR_TORRENT	Automatic disconnect from torrent activity. Since 10.4
DR_SERVICESTOP	Daemon stopped cleanly. Since 10.4
DR_STARTTIMEOUT	Timeout initializing the connection. Since 10.4
DR_INACTIVETIMEOUT	Tunnel timeout. Since 10.4
DR_SETTINGCHANGERECONNECT	Automatic reconnect from setting change. Since 10.4
DR_DNSTIMEOUT	DNS timeout. Since 10.7
DR_TUNNELTIMEOUT	VPN tunnel blocked. Since 10.7
DR_OVERQUOTA	Account out of data. Since 10.9
DR_SAFENETWORK	On a safe network, determined by safe browsing. Since 11.0
DR_NONE	Nothing to report. Since 12.7.0

SpeedifySDK_DSCPPriority

enum SpeedifySDK_DSCPPriority

DSCP priority behavior.

Since

15.0

Enumerator
DSCP_PRIORITY_AUTO	Speedify stream detection. Since 15.0
DSCP_PRIORITY_ON	DSCP priority is on. Since 15.0
DSCP_PRIORITY_OFF	DSCP priority is off. Since 15.0

SpeedifySDK_DSCPReplication

enum SpeedifySDK_DSCPReplication

DSCP replication behavior.

Since

15.0

Enumerator
DSCP_REPLICATION_AUTO	Speedify stream mode behavior. Since 15.0
DSCP_REPLICATION_ON	DSCP replication is on. Since 15.0
DSCP_REPLICATION_OFF	DSCP replication is off. Since 15.0

SpeedifySDK_ErrorType

enum SpeedifySDK_ErrorType

Type classification for errors.

Since

7.5

Enumerator
ET_OK	No error. Since 7.5
ET_NETWORK	Network related error. Since 7.5
ET_SERVER	An error occurred on the server. Since 7.5
ET_CREDENTIAL	Invalid credentials. Since 7.5
ET_DIRECTORY	Directory list was empty. Since 7.5
ET_ACCOUNT	An issue with the account being used. Since 7.5
ET_RATELIMITED	Too many requests are being made by this device. Since 7.5
ET_TOKEN_EXPIRED	The provided OAUTH token is expired. Since 7.5
ET_VPN_ADAPTER	Error opening or configuring the VPN adapter. Since 8.0
ET_DEVICE_LIMIT	The device limit has been reached. Since 13.3
ET_LOCK_TEAM	Setting locked by server configuration. Since 14.0
ET_LOCK_ACCOUNT	Setting locked by account configuration. Since 14.0
ET_INVALID_ARGUMENT	An invalid argument was supplied. Since 14.0
ET_SDK_ASYNC	Result is an async call SDK. Not an error. Since 7.5
ET_SDK_ERROR	An error in the SDK. Since 7.5
ET_SDK_TIMEOUT	Timeout waiting for result. Since 7.5
ET_SDK_INVALID_ARGUMENT	An invalid argument was supplied. Since 7.5
ET_SDK_CALLBACK_REQUIRED	A callback is required for this call. Since 7.5
ET_SDK_PLATFORM_NO_SUPPORT	Platform does not support this call. Since 7.5
ET_SDK_NO_CONNECTION	No connection to the Speedify daemon. Since 8.0
ET_SDK_SYNC_FROM_ASYNC	Synchronous call used from within asynchronous callback. Not supported. Since 9.3
ET_SDK_SETTING_LOCKED_TEAM	Setting locked by server configuration. Deprecated As of 14.0. Use ET_LOCK_TEAM instead. Since 9.2
ET_SDK_SETTING_LOCKED_ACCOUNT	Setting locked by account configuration. Deprecated As of 14.0. Use ET_LOCK_ACCOUNT instead. Since 11.2

SpeedifySDK_FirewallMode

enum SpeedifySDK_FirewallMode

How firewall treats matches.

Since

9.2

Enumerator
FWM_OFF	Firewall is disabled. Since 9.2
FWM_ALLOWLIST	Matches are allowed through the VPN, all others are dropped. Since 10.2
FWM_DENYLIST	Matches are dropped, all others are allowed through the VPN. Since 10.2

SpeedifySDK_LogLevel

enum SpeedifySDK_LogLevel

Log levels in the SDK.

Since

10.5

Enumerator
LL_VERBOSE	Verbose. Since 10.5
LL_INFO	Info. Since 10.5
LL_WARN	Warning. Since 10.5
LL_ERROR	Error. Since 10.5

SpeedifySDK_NetworkSharingAutoPairBehavior

enum SpeedifySDK_NetworkSharingAutoPairBehavior

Auto pair behavior types.

Since

14.8

Enumerator
APB_MANUAL	no automatic pairing Since 14.8
APB_AUTO_USER	Automatically pair with devices from the same user. Since 14.8
APB_AUTO_USER_TEAM	Automatically pair with devices from the same user and/or team. Since 14.8

SpeedifySDK_NetworkSharingPairRequestBehavior

enum SpeedifySDK_NetworkSharingPairRequestBehavior

pair request behavior types

Since

14.0

Enumerator
PRB_ASK	always ask Since 14.0
PRB_ACCEPT	automatically accept Since 14.0
PRB_REJECT	automatically reject Since 14.0

SpeedifySDK_NetworkSharingPeerRole

enum SpeedifySDK_NetworkSharingPeerRole

peer role

Since

14.0

Enumerator
PR_CLIENT	client Since 14.0
PR_HOST	host Since 14.0

SpeedifySDK_NetworkSharingPeerStatus

enum SpeedifySDK_NetworkSharingPeerStatus

Status of a NetworkSharing Peer Connection.

Since

14.0

Enumerator
NPS_DISCONNECTED	The connection is disconnected. Since 14.0
NPS_UNAUTHENTICATED	connected, but not authenticated Since 14.0
NPS_AUTHENTICATED	connected and authenticated Since 14.0

SpeedifySDK_NetworkSharingTunnelStatus

enum SpeedifySDK_NetworkSharingTunnelStatus

Status of a NetworkSharing tunnel.

Since

14.0

Enumerator
NTS_INACTIVE	No active tunnels. Since 14.0
NTS_ACTIVE	active tunnels Since 14.0
NTS_DISABLED_ON_CLIENT	disallowed on client Since 14.0
NTS_DISABLED_ON_HOST	disallowed on host Since 14.0
NTS_NO_NETWORKS	no networks available Since 14.0
NTS_TUNNEL_ERROR	general error Since 14.0
NTS_NOT_AUTHENTICATED	not authenticated Since 14.0
NTS_NETWORKS_OVERLIMIT	All networks are over data limit. Since 14.0
NTS_VPN_NOT_CONNECTED	Host's VPN not connected. Since 14.0
NTS_PAUSED	Active but paused. Since 14.7

SpeedifySDK_NetworkType

enum SpeedifySDK_NetworkType

Type of network adapter.

Since

7.5

Enumerator
NETWORKTYPE_WIFI	Wi-Fi. Since 7.5
NETWORKTYPE_ETHERNET	Ethernet. Since 7.5
NETWORKTYPE_CELLULAR	Cellular. Since 7.5
NETWORKTYPE_VPN	VPN. Since 7.5
NETWORKTYPE_LOOPBACK	Loopback. Since 7.5
NETWORKTYPE_BLUETOOTH	Bluetooth. Since 7.5
NETWORKTYPE_NETWORKSHARE_CLIENT	Network Share Client. Since 14.0
NETWORKTYPE_NETWORKSHARE_HOST	Network Share Host. Since 14.0
NETWORKTYPE_UNKNOWN	Unknown. Since 7.5

SpeedifySDK_PortProtocol

enum SpeedifySDK_PortProtocol

Protocol for ports.

Since

7.5

Enumerator
PPROTO_TCP	TCP. Since 7.5
PPROTO_UDP	UDP. Since 7.5
PPROTO_ICMP	ICMP. Since 15.6

SpeedifySDK_ProxyMatchMode

enum SpeedifySDK_ProxyMatchMode

How local proxy treats matches.

Since

9.2

Enumerator
PMM_ALLOWLIST	Domains and IP Addresses matched are sent over the proxy, all others are sent over the VPN. Since 10.2
PMM_DENYLIST	Domains and IP Addresses matched are sent over the VPN, all others are sent over the proxy. Since 10.2

SpeedifySDK_SafeBrowsingError

enum SpeedifySDK_SafeBrowsingError

Safe browsing errors.

Since

10.6

Enumerator
CUJO_OK
CUJO_ERR_NO_ENDPOINT_URL	Since 10.9
CUJO_ERR_NOT_CONFIGURED
CUJO_ERR_TIMED_OUT	Fail open error. Since 10.7
CUJO_ERR_RETRIABLE_SERVER_ERROR
CUJO_ERR_HTTP_STATUS	Since 10.9
CUJO_ERR_CURL	Since 10.9
CUJO_ERR_NO_MEMORY
CUJO_ERR_BAD_FUNCTION_ARGUMENT
CUJO_ERR_PARSE_ERROR
CUJO_ERR_CURL_INIT_FAILURE	Since 10.9
CUJO_ERR_CURL_EASY_INIT_FAILURE	Since 10.9
CUJO_ERR_CURL_HEADER_APPEND_FAILURE	Since 10.9
CUJO_ERR_JSON_SET_FAILURE	Since 10.9
CUJO_ERR_UV_LOOP_INIT_FAILURE	Since 10.9
CUJO_ERR_ALREADY_IN_PROGRESS	Since 11.0
CUJO_ERR_INVALID_NSP_TOKEN	Since 11.0
CUJO_ERR_ON_PROTECTED_NETWORK	Since 11.0
CUJO_ERR_ASYNC_INIT_FAILURE	Since 11.1
CUJO_ERR_INTERRUPTED_EVENT_LOOP	Since 11.1

SpeedifySDK_SafeBrowsingLogLevel

enum SpeedifySDK_SafeBrowsingLogLevel

Log levels in the SDK.

Since

10.8

Enumerator
CUJO_LOG_DEBUG
CUJO_LOG_INFO
CUJO_LOG_ERROR
CUJO_LOG_TRACE	Since 11.2.2
CUJO_LOG_WARNING	Since 11.4

SpeedifySDK_SafeBrowsingSafeNetworkOverride

enum SpeedifySDK_SafeBrowsingSafeNetworkOverride

Override safe network decisions.

Since

11.1

Enumerator
SN_OVERRIDE_NONE
SN_OVERRIDE_UNSAFE
SN_OVERRIDE_SAFE

SpeedifySDK_SpeedTestType

enum SpeedifySDK_SpeedTestType

Internal speed test types.

Since

11.5

Enumerator
TEST_SPEED
TEST_STREAMING

SpeedifySDK_State

enum SpeedifySDK_State

State of the VPN.

Since

7.5

Enumerator
STATE_LOGGED_OUT	Completely disconnected and unathenticated. Need to login() to do anything. Since 7.5
STATE_LOGGING_IN	Transitional state as we log in. Since 7.5
STATE_LOGGED_IN	Fully authenticated, but not using a speed server. Ready to connect() Since 7.5
STATE_AUTO_CONNECTING	Transitional state as system automatically connects us to speed server. Since 7.5
STATE_CONNECTING	Transitional state as we connect to speed server. Since 7.5
STATE_DISCONNECTING	Transitional state as we disconnect from speed server. Since 7.5
STATE_CONNECTED	Really connected to a speed server. Since 7.5
STATE_OVERLIMIT	All available adapters are overlimit, VPN still in connected state. Since 7.5
STATE_UNKNOWN	Unable to connect to the local Speedify daemon. Since 7.5

SpeedifySDK_StreamHealth

enum SpeedifySDK_StreamHealth

Stream health indicator.

Since

11.5

Enumerator
SH_STOPPED	Stream has stopped. Stream has not sent any data for multiple seconds, and is suspected of having stopped. If active is still true, then it's possible that this stream could still return to a GOOD health state. Since 11.5
SH_POOR	Stream may be encountering errors. Since 11.5
SH_GOOD	Stream is in good health. Since 11.5

SpeedifySDK_TrafficRuleChangeMethod

enum SpeedifySDK_TrafficRuleChangeMethod

Traffic rules change method.

Since

15.6

Enumerator
TRAFFIC_RULE_UPDATE	Update an existing traffic rule, or add a new one if it doesn't exist. Since 15.6
TRAFFIC_RULE_REPLACE	Replace an existing traffic rule, or add a new one if it doesn't exist. Since 15.6
TRAFFIC_RULE_REMOVE	Remove an existing traffic rule. Since 15.6

SpeedifySDK_TransportMode

enum SpeedifySDK_TransportMode

Transport Protocol modes.

Since

7.5

Enumerator
TMODE_TCP	Always use TCP. Since 7.5
TMODE_UDP	Always use UDP. Since 7.5
TMODE_AUTO	Intelligently choose between available protocols. Since 7.5
TMODE_HTTPS	Always use websocket. Since 9.0
TMODE_MULTITCP	Always use Multi TCP. Since 10.9.5
TMODE_PROXY	Proxy-only. This is not valid for SpeedifySDK_SetConnectionTransportMode. Since 12.2
TMODE_SHARE	shared traffic. This is not valid for SpeedifySDK_SetConnectionTransportMode. Since 14.0

Function Documentation

SpeedifySDK_AccountAction_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_AccountAction_toString

(

SpeedifySDK_AccountAction

action

)

SpeedifySDK_AccountPaymentType_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_AccountPaymentType_toString

(

SpeedifySDK_AccountPaymentType

paymentType

)

SpeedifySDK_AutoConnectMethod_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_AutoConnectMethod_toString

(

SpeedifySDK_AutoConnectMethod

method

)

SpeedifySDK_BondingMode_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_BondingMode_toString

(

SpeedifySDK_BondingMode

priority

)

SpeedifySDK_ConnectionDirectionalMode_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_ConnectionDirectionalMode_toString

(

SpeedifySDK_ConnectionDirectionalMode

mode

)

SpeedifySDK_ConnectionPriority_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_ConnectionPriority_toString

(

SpeedifySDK_ConnectionPriority

priority

)

SpeedifySDK_ConnectionState_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_ConnectionState_toString

(

SpeedifySDK_ConnectionState

state

)

SpeedifySDK_DisconnectReason_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_DisconnectReason_toString

(

SpeedifySDK_DisconnectReason

reason

)

SpeedifySDK_DSCPPriority_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_DSCPPriority_toString

(

SpeedifySDK_DSCPPriority

priority

)

SpeedifySDK_DSCPReplication_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_DSCPReplication_toString

(

SpeedifySDK_DSCPReplication

replication

)

SpeedifySDK_ErrorType_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_ErrorType_toString

(

SpeedifySDK_ErrorType

error

)

SpeedifySDK_FirewallMode_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_FirewallMode_toString

(

SpeedifySDK_FirewallMode

matchMode

)

SpeedifySDK_InitializeCreateSettings()

ENABLE_NETWORK_SHARING void SpeedifySDK_InitializeCreateSettings

(

SpeedifySDK_CreateSettings *

settings

)

SpeedifySDK_LogLevel_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_LogLevel_toString

(

SpeedifySDK_LogLevel

level

)

SpeedifySDK_NetworkSharingAutoPairBehavior_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkSharingAutoPairBehavior_toString

(

SpeedifySDK_NetworkSharingAutoPairBehavior

behavior

)

SpeedifySDK_NetworkSharingPairRequestBehavior_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkSharingPairRequestBehavior_toString

(

SpeedifySDK_NetworkSharingPairRequestBehavior

behavior

)

SpeedifySDK_NetworkSharingPeerRole_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkSharingPeerRole_toString

(

SpeedifySDK_NetworkSharingPeerRole

role

)

SpeedifySDK_NetworkSharingPeerStatus_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkSharingPeerStatus_toString

(

SpeedifySDK_NetworkSharingPeerStatus

status

)

SpeedifySDK_NetworkSharingTunnelStatus_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkSharingTunnelStatus_toString

(

SpeedifySDK_NetworkSharingTunnelStatus

status

)

SpeedifySDK_NetworkType_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkType_toString

(

SpeedifySDK_NetworkType

type

)

SpeedifySDK_PortProtocol_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_PortProtocol_toString

(

SpeedifySDK_PortProtocol

portProto

)

SpeedifySDK_ProxyMatchMode_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_ProxyMatchMode_toString

(

SpeedifySDK_ProxyMatchMode

matchMode

)

SpeedifySDK_SafeBrowsing_LogLevel_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_SafeBrowsing_LogLevel_toString

(

SpeedifySDK_SafeBrowsingLogLevel

level

)

SpeedifySDK_SafeBrowsing_SafeNetworkOverride_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_SafeBrowsing_SafeNetworkOverride_toString

(

SpeedifySDK_SafeBrowsingSafeNetworkOverride

level

)

SpeedifySDK_ServerInformation_GetCityName()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformation_GetCityName

(

SpeedifySDK_ServerInformation

server

)

SpeedifySDK_ServerInformation_GetCountryName()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformation_GetCountryName

(

SpeedifySDK_ServerInformation

server

)

SpeedifySDK_ServerInformation_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformation_toString

(

SpeedifySDK_ServerInformation

server

)

SpeedifySDK_ServerInformationDetailed_GetCityName()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformationDetailed_GetCityName

(

SpeedifySDK_ServerInformationDetailed

server

)

SpeedifySDK_ServerInformationDetailed_GetCountryName()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformationDetailed_GetCountryName

(

SpeedifySDK_ServerInformationDetailed

server

)

SpeedifySDK_ServerInformationDetailed_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformationDetailed_toString

(

SpeedifySDK_ServerInformationDetailed

server

)

SpeedifySDK_SpeedTestType_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_SpeedTestType_toString

(

SpeedifySDK_SpeedTestType

type

)

SpeedifySDK_State_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_State_toString

(

SpeedifySDK_State

state

)

SpeedifySDK_StreamHealth_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_StreamHealth_toString

(

SpeedifySDK_StreamHealth

health

)

SpeedifySDK_TransportMode_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_TransportMode_toString

(

SpeedifySDK_TransportMode

priority

)

SpeedifySDK_Version_toString()

ENABLE_NETWORK_SHARING const char * SpeedifySDK_Version_toString

(

SpeedifySDK_Version

state

)

Variable Documentation

SpeedifySDK_AppNameString

SpeedifySDK_EXTERN typedef char SpeedifySDK_AppNameString[SPEEDIFYSDK_MAX_APP_NAME_LENGTH]

String representation of a SDK App name.

Since

11.8

SpeedifySDK_DomainString

SpeedifySDK_EXTERN typedef char SpeedifySDK_DomainString[SPEEDIFYSDK_MAX_DOMAIN_LENGTH]

String representation of a domain or hostname.

Since

9.2

SpeedifySDK_FirewallPort

SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair SpeedifySDK_FirewallPort

A firewall port.

Since

7.5

SpeedifySDK_ForwardedPort

SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair SpeedifySDK_ForwardedPort

A forwarded port.

Since

7.5

SpeedifySDK_HostnameString

SpeedifySDK_EXTERN typedef char SpeedifySDK_HostnameString[SPEEDIFYSDK_MAX_HOSTNAME_LENGTH]

String representation of an IP address.

Since

14.1

SpeedifySDK_IPAddressString

SpeedifySDK_EXTERN typedef char SpeedifySDK_IPAddressString[SPEEDIFYSDK_MAX_IP_STRING_LENGTH]

String representation of an IP address.

Since

7.5

SpeedifySDK_LocalProxyPort

SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair SpeedifySDK_LocalProxyPort

A proxied port.

Since

9.9

SpeedifySDK_NetworkSharingConnectCode

SpeedifySDK_EXTERN typedef char SpeedifySDK_NetworkSharingConnectCode[SPEEDIFYSDK_MAX_NETWORKSHARING_CONNECT_CODE_LENGTH]

Connect code for network sharing.

Since

14.0

SpeedifySDK_NetworkSharingDisplayName

SpeedifySDK_EXTERN typedef char SpeedifySDK_NetworkSharingDisplayName[SPEEDIFYSDK_MAX_NETWORKSHARING_DISPLAY_NAME_LENGTH]

The public display name for this device.

Since

14.0

SpeedifySDK_NetworkSharingPeerUuid

SpeedifySDK_EXTERN typedef char SpeedifySDK_NetworkSharingPeerUuid[SPEEDIFYSDK_NETWORKSHARING_PEER_UUID_LENGTH]

Peer UUID for network sharing peer data.

Since

14.0

SpeedifySDK_ServerInformationDetailed

SpeedifySDK_EXTERN typedef SpeedifySDK_ServerInformation SpeedifySDK_ServerInformationDetailed

Information about a.

Deprecated

as of 14.0. Use SpeedifySDK_ServerInformation instead.

Since

7.5

SpeedifySDK_StreamingPort

SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair SpeedifySDK_StreamingPort

A streaming port.

Since

10.9