Speedify SDK for Desktop/Embedded 15.5.0
Loading...
Searching...
No Matches
types.h
Go to the documentation of this file.
1// Copyright 2019, Connectify, Inc. All Rights Reserved
2#pragma once
3
4#include "sdkdefines.h"
5#include <stdbool.h>
6#include <stdint.h>
7#include <time.h>
8#include "../cJSON.h"
9
10#ifdef _WIN32
11#include <ws2tcpip.h>
12#else
13#include <netinet/ip.h>
14#include <arpa/inet.h>
15#endif
16
22
23
27
28
32
33
37
38
55
58SpeedifySDK_EXTERN typedef struct {
61 uint16_t major;
64 uint16_t minor;
67 uint16_t bugfix;
70 uint16_t build;
74SpeedifySDK_EXPORT const char* SpeedifySDK_Version_toString(SpeedifySDK_Version state);
75
76
110SpeedifySDK_EXPORT const char* SpeedifySDK_State_toString(SpeedifySDK_State state);
111
149
150
196
206
219
220
221
238
261
296
297
316
351
378
381SpeedifySDK_EXTERN typedef struct {
387 int64_t usageDaily;
404
418/* \brief String representation of a SpeedifySDK_ConnectionDirectionalMode
419 * @since 14.8.7 */
421
432
489
490
507
523SpeedifySDK_EXPORT const char* SpeedifySDK_BondingMode_toString(SpeedifySDK_BondingMode priority);
524
552SpeedifySDK_EXPORT const char* SpeedifySDK_TransportMode_toString(SpeedifySDK_TransportMode priority);
553
556SpeedifySDK_EXTERN typedef enum {
566SpeedifySDK_EXPORT const char* SpeedifySDK_PortProtocol_toString(SpeedifySDK_PortProtocol portProto);
567
570SpeedifySDK_EXTERN typedef struct {
576 uint16_t port;
579 uint16_t portRangeEnd;
581
585
586
589SpeedifySDK_EXTERN typedef struct {
597
600SpeedifySDK_EXTERN typedef struct {
608
611SpeedifySDK_EXTERN typedef struct {
619
622SpeedifySDK_EXTERN typedef struct {
628 uint16_t sockets;
630
633SpeedifySDK_EXTERN typedef struct {
636 int32_t upload;
639 int32_t download;
641
743
747
789
926
929SpeedifySDK_EXTERN typedef struct {
932 uint64_t time;
935 uint16_t count;
940
943SpeedifySDK_EXTERN typedef struct {
946 uint64_t packetsIn;
949 uint64_t packetsOut;
952 uint64_t bytesIn;
955 uint64_t bytesOut;
958 uint64_t bufferWaits;
961 uint64_t packetWaits;
964 uint64_t readQueue;
969
972SpeedifySDK_EXTERN typedef struct {
975 uint64_t packetsIn;
978 uint64_t packetsOut;
981 uint64_t bytesIn;
984 uint64_t bytesOut;
987 uint64_t retries;
989
992SpeedifySDK_EXTERN typedef struct {
995 uint64_t detections;
998 uint64_t successes;
1000
1003SpeedifySDK_EXTERN typedef struct {
1018 uint64_t uniqueSaves;
1020
1023SpeedifySDK_EXTERN typedef struct {
1026 uint8_t dscp;
1032 uint64_t bytesSent;
1035 double sendBps;
1052
1063
1129
1140
1141
1219SpeedifySDK_EXPORT const char* SpeedifySDK_ErrorType_toString(SpeedifySDK_ErrorType error);
1220
1223SpeedifySDK_EXTERN typedef enum {
1233SpeedifySDK_EXPORT const char* SpeedifySDK_ProxyMatchMode_toString(SpeedifySDK_ProxyMatchMode matchMode);
1234
1238
1261
1308
1309
1313
1345
1361SpeedifySDK_EXPORT const char* SpeedifySDK_FirewallMode_toString(SpeedifySDK_FirewallMode matchMode);
1362
1366
1401
1402
1405SpeedifySDK_EXTERN typedef enum {
1416 SH_GOOD
1421
1484
1485
1515
1516
1517
1577
1592
1593
1610SpeedifySDK_EXPORT const char* SpeedifySDK_LogLevel_toString(SpeedifySDK_LogLevel level);
1611
1614SpeedifySDK_EXTERN typedef struct {
1620 int32_t fileSize;
1632 int32_t totalFiles;
1640
1641
1644SpeedifySDK_EXTERN typedef struct {
1656
1659SpeedifySDK_EXTERN typedef enum {
1710
1718SpeedifySDK_EXPORT const char*
1720
1723SpeedifySDK_EXTERN typedef enum {
1727
1731
1778
1788
1791SpeedifySDK_EXTERN typedef enum {
1802
1816
1820
1834
1838
1868
1882
1886
1921
1925
1928SpeedifySDK_EXTERN typedef struct {
1931 uint64_t bytesToday;
1940 uint64_t bytesTotal;
1942
1943
1960
1986
1987
2003SpeedifySDK_EXPORT const char* SpeedifySDK_DSCPReplication_toString(SpeedifySDK_DSCPReplication replication);
2004
2020SpeedifySDK_EXPORT const char* SpeedifySDK_DSCPPriority_toString(SpeedifySDK_DSCPPriority priority);
2021
2038
2049
#define SPEEDIFYSDK_MAX_IP_STRING_LENGTH
IP string length.
Definition sdkdefines.h:42
#define SPEEDIFYSDK_MAX_DSCP_QUEUE_LENGTH
Maximum number of DSCP queues.
Definition sdkdefines.h:167
#define SPEEDIFYSDK_MAX_DOWNSTREAM_SUBNETS
Maximum number of subnets supported.
Definition sdkdefines.h:39
#define SPEEDIFYSDK_MAX_FIREWALL_PORTS
Maximum number of ports returned.
Definition sdkdefines.h:72
#define SPEEDIFYSDK_MAX_STATS_PERIODS
Maximum number of stat periods requested.
Definition sdkdefines.h:93
#define SPEEDIFYSDK_MAX_WATCHLIST_DOMAINS
Maximum number of domains in a watchlist item.
Definition sdkdefines.h:81
#define SPEEDIFYSDK_MAX_PROXY_PORTS
Maximum number of ports returned.
Definition sdkdefines.h:63
#define SPEEDIFYSDK_MAX_IP_COUNT
Maximum number of IPs on a server.
Definition sdkdefines.h:48
#define SPEEDIFYSDK_MAX_STREAM_RESOLUTION_LENGTH
Maximum streaming resolution length.
Definition sdkdefines.h:126
#define SPEEDIFYSDK_MAX_DATACENTER_LENGTH
Length of the data center field.
Definition sdkdefines.h:155
#define SPEEDIFYSDK_MAX_STREAMING_PORTS
Maximum number of ports returned.
Definition sdkdefines.h:117
#define SPEEDIFYSDK_MAX_NETWORKSHARING_DISPLAY_NAME_LENGTH
Maxmimum size a device's display name for pair and share discovery and advertisement.
Definition sdkdefines.h:136
#define SPEEDIFYSDK_MAX_WATCHLIST_TITLE
Maximum title length of domain watchlist item.
Definition sdkdefines.h:78
#define SPEEDIFYSDK_MAX_STREAMING_IPS
Maximum number of IPs returned.
Definition sdkdefines.h:114
#define SPEEDIFYSDK_MAX_ERROR_STRING
Length of an error message.
Definition sdkdefines.h:12
#define SPEEDIFYSDK_MAX_DNS_COUNT
Maximum number of DNS addresses to configure.
Definition sdkdefines.h:51
#define SPEEDIFYSDK_MAX_PACKET_POOL_NAME_LENGTH
Maximum length of the packet pool size string.
Definition sdkdefines.h:164
#define SPEEDIFYSDK_NETWORKSHARING_PEER_UUID_LENGTH
Length of the peer UUID field.
Definition sdkdefines.h:145
#define SPEEDIFYSDK_MAX_APP_NAME_LENGTH
Maximum SDK App name length.
Definition sdkdefines.h:129
#define SPEEDIFYSDK_MAX_LANGUAGE_LEN
Language id length.
Definition sdkdefines.h:120
#define SPEEDIFYSDK_MAX_EMAIL
Email length.
Definition sdkdefines.h:30
#define SPEEDIFYSDK_MAX_STREAMS
Maximum number of streams returns in a stats result.
Definition sdkdefines.h:84
#define SPEEDIFYSDK_MAX_WATCHLIST_ITEMS
Maximum number of domain watchlist items.
Definition sdkdefines.h:75
#define SPEEDIFYSDK_MAX_ADAPTER_NAME
Adapter name length.
Definition sdkdefines.h:33
#define SPEEDIFYSDK_MAX_FIREWALL_DOMAINS
Maximum number of domains returned.
Definition sdkdefines.h:66
#define SPEEDIFYSDK_MAX_STREAM_NAME_LEN
Maximum length of SpeedifySDK_StreamStats name field.
Definition sdkdefines.h:87
#define SPEEDIFYSDK_MAX_PROTOCOL_LENGTH
Length of the protocol field.
Definition sdkdefines.h:161
#define SPEEDIFYSDK_MAX_PROXY_DOMAINS
Maximum number of domains returned.
Definition sdkdefines.h:57
#define SPEEDIFYSDK_MAX_DOMAIN_LENGTH
Maximum length of domain to proxy.
Definition sdkdefines.h:54
#define SPEEDIFYSDK_MAX_ADAPTERS
Simultaneous adapters supported.
Definition sdkdefines.h:15
#define SPEEDIFYSDK_MAX_CITY_LEN
City id.
Definition sdkdefines.h:24
#define SPEEDIFYSDK_MAX_PROXY_IPS
Maximum number of IPs returned.
Definition sdkdefines.h:60
#define SPEEDIFYSDK_MAX_FIREWALL_IPS
Maximum number of IPs returned.
Definition sdkdefines.h:69
#define SPEEDIFYSDK_MAX_HOSTNAME_LENGTH
Length of the hostname field.
Definition sdkdefines.h:158
#define SPEEDIFYSDK_MAX_FORWARD_PORTS
Forwarded ports supported.
Definition sdkdefines.h:36
#define SPEEDIFYSDK_MAX_STREAMING_DOMAINS
Maximum number of domains returned.
Definition sdkdefines.h:111
#define SPEEDIFYSDK_MAX_COUNTRY_LEN
Country id length.
Definition sdkdefines.h:21
#define SPEEDIFYSDK_MAX_NETWORKSHARING_CONNECT_CODE_LENGTH
Maxmimum size of network sharing connect code.
Definition sdkdefines.h:139
#define SPEEDIFYSDK_MAX_DIRECTORY_DOMAIN
Length of directory server domain.
Definition sdkdefines.h:45
Data on an account.
Definition types.h:264
SpeedifySDK_AccountAction action
If any actions should be taken on this account.
Definition types.h:294
SpeedifySDK_AccountPaymentType paymentType
Payment status of this account.
Definition types.h:288
int64_t bytesAvailable
Bytes allowed per data period (typically a month) for this account. -1 for unlimited.
Definition types.h:273
int32_t minutesAvailable
Minutes allowed per data period (typically a month) for this account. -1 for unlimited.
Definition types.h:282
int64_t bytesUsed
Bytes used this data period (typically a month) for this account.
Definition types.h:276
bool isAutoAccount
If this account is an automatically generated account.
Definition types.h:270
int32_t minutesUsed
Minutes used this data period (typically a month) for this account.
Definition types.h:285
bool isTeam
If this user is a teams member.
Definition types.h:279
Information about a network adapter.
Definition types.h:436
SpeedifySDK_ConnectionState state
State of the connection over this adapter.
Definition types.h:448
int64_t rateLimitUploadBps
Upload speed limit, in bits per second. Or zero if unlimited.
Definition types.h:470
int64_t rateLimitDownloadBps
Download speed limit, in bits per second. Or zero if unlimited.
Definition types.h:467
int64_t rateLimit
Upload speed limit, in bits per second. Or zero if unlimited. This is provided for backwards compatib...
Definition types.h:464
SpeedifySDK_NetworkType type
Type of the adapter.
Definition types.h:451
SpeedifySDK_AdapterUsageData dataUsage
Data usage and limit information for this adapter.
Definition types.h:473
SpeedifySDK_ConnectionPriority workingPriority
Effective priority of connections over this adapter.
Definition types.h:476
SpeedifySDK_ConnectionDirectionalSettings directionalSettings
Connection direction settings.
Definition types.h:487
SpeedifySDK_ConnectionPriority priority
Priority of connections over this adapter.
Definition types.h:454
cJSON ** ispStats
JSON object containing ISP data, if available The cJSON is valid until the next AdapterData update is...
Definition types.h:484
Information about the data usage and limits of a network adapter.
Definition types.h:381
int64_t usageMonthlyResetDay
Day of the month to reset monthly usage on. 0 for last 30 days.
Definition types.h:393
int64_t usageDaily
Bytes used over this adapter today.
Definition types.h:387
int64_t usageMonthly
Bytes used over this adapter in current month period.
Definition types.h:384
int64_t usageDailyBoost
Extra Bytes allowed over this adapter today. This value resets to 0 every day.
Definition types.h:399
int64_t overlimitRatelimit
Rate limit used when this adapter hits a daily or monthly limit. If 0, this adapter is no longer used...
Definition types.h:402
int64_t usageMonthlyLimit
Bytes allowed over this adapter in current month period. 0 for unlimited.
Definition types.h:390
int64_t usageDailyLimit
Bytes allowed over this adapter in a single day. 0 for unlimited.
Definition types.h:396
Contains stats regarding the captive portal.
Definition types.h:992
uint64_t successes
Successful captive portal logins.
Definition types.h:998
uint64_t detections
Captive portal detections.
Definition types.h:995
Directional settings for a connection.
Definition types.h:424
SpeedifySDK_ConnectionDirectionalMode upload
Upload mode.
Definition types.h:427
SpeedifySDK_ConnectionDirectionalMode download
Download mode.
Definition types.h:430
A grouping of ConnectionStats.
Definition types.h:929
uint16_t count
how many connections are in this group
Definition types.h:935
uint64_t time
timestamp of the connection stats
Definition types.h:932
Statistics about a connection.
Definition types.h:796
uint32_t numberOfSockets
Number of active sockets for this connection.
Definition types.h:856
int64_t totalBps
bits per second through this tunnel
Definition types.h:865
bool uploadCongested
True if the connection is congested in the upload direction.
Definition types.h:919
int64_t inFlight
bytes currently in flight
Definition types.h:801
double lossReceive
receive loss ratio (0.0-1.0)
Definition types.h:831
uint64_t sendBytes
bytes sent
Definition types.h:904
float mos
Mean Opinion Score, 1-5.
Definition types.h:899
double sendEstimateMbps
estimated maximum megabits per second send.
Definition types.h:881
bool connected
is connected
Definition types.h:809
SpeedifySDK_IPAddressString remoteIp
internet facing ip address of the tunnel.
Definition types.h:862
bool sleeping
is sleeping. Used on Cellular connections to improve battery life.
Definition types.h:812
bool congested
True if the connection is upload or download congested.
Definition types.h:914
uint64_t receiveBytes
bytes received
Definition types.h:909
int64_t inFlightWindow
inflight window, bytes
Definition types.h:806
SpeedifySDK_IPAddressString localIp
internet facing ip address of the adapter.
Definition types.h:826
SpeedifySDK_IPAddressString privateIp
local ip address of the adapter.
Definition types.h:845
int64_t latencyMs
latency, milliseconds
Definition types.h:839
int32_t jitterMs
Jitter, in milliseconds.
Definition types.h:893
double receiveEstimateMbps
estimated maximum megabits per second received.
Definition types.h:887
int64_t sendBps
bits per second sent through this tunnel.
Definition types.h:870
double lossSend
send loss ratio (0.0-1.0)
Definition types.h:836
int64_t receiveBps
bits per second received through this tunnel.
Definition types.h:875
bool downloadCongested
True if the connection is congested in the download direction.
Definition types.h:924
SpeedifySDK_TransportMode protocol
protocol used for the tunnel.
Definition types.h:850
SDK creation settings structure.
Definition types.h:41
SpeedifySDK_IPAddressString ip
IP address of the speedify daemon to connect to.
Definition types.h:47
uint16_t port
Port number of the speedify daemon to connect to.
Definition types.h:50
SpeedifySDK_AppNameString name
Name of the SDK app, used for auto accounts.
Definition types.h:44
DSCP queue configuration.
Definition types.h:2024
SpeedifySDK_DSCPReplication replication
DSCP replication setting.
Definition types.h:2033
uint8_t dscpValue
DSCP value.
Definition types.h:2027
SpeedifySDK_DSCPPriority priority
DSCP priority setting.
Definition types.h:2030
uint8_t retransmissionAttempts
Maximum number of retransmission attempts.
Definition types.h:2036
DSCP settings.
Definition types.h:2041
uint8_t numDscpQueues
The number of DSCP queue configurations.
Definition types.h:2044
Settings for logging in the daemon.
Definition types.h:1614
int32_t fileSize
Size of individual daemon log files, in bytes.
Definition types.h:1620
int32_t totalFiles
Total number of daemon log files to keep over all SDK service instances.
Definition types.h:1632
SpeedifySDK_LogLevel logLevel
Minimim logging level to allow.
Definition types.h:1638
int32_t filesPerDaemon
Number of log files allowed per SDK service instance.
Definition types.h:1626
Directory settings.
Definition types.h:1644
bool enableEsni
If ESNI is enabled for this domain.
Definition types.h:1651
Information about a disconnect event.
Definition types.h:1580
SpeedifySDK_DisconnectReason disconnectReason
Reason for the disconnect.
Definition types.h:1583
int64_t sessionEnd
Time of the disconnect, in seconds since epoch. If 0, there has been no disconnect event to report....
Definition types.h:1587
int64_t sessionLength
Length of the session in seconds.
Definition types.h:1590
Array of DSCP queue stats.
Definition types.h:1055
uint16_t count
the number of dscp queues
Definition types.h:1058
Contains stats for a defined DSCP queue.
Definition types.h:1023
uint64_t bytesSent
bytes sent through this queue
Definition types.h:1032
uint64_t transportBytesReceived
bytes received through this queue on transport connections, includes retransmissions and redundancy
Definition types.h:1041
uint64_t bytesReceived
bytes received through this queue
Definition types.h:1029
uint64_t transportBytesSent
bytes sent through this queue on transport connections, includes retransmissions and redundancy
Definition types.h:1044
double receiveBps
bits per second received through this queue
Definition types.h:1038
uint8_t dscp
dscp value for this queue
Definition types.h:1026
double sendBps
bits per second sent through this queue.
Definition types.h:1035
double transportSendBps
bits per second sent through this queue on transport connections, includes retransmissions and redund...
Definition types.h:1047
double transportReceiveBps
bits per second received through this queue on transport connections, includes retransmissions and re...
Definition types.h:1050
Firewall settings.
Definition types.h:1369
SpeedifySDK_FirewallMode mode
How matches are handled.
Definition types.h:1372
uint16_t portsCount
Number of ports.
Definition types.h:1395
uint16_t ipv4Count
Number of IPv4 addresses.
Definition types.h:1381
uint16_t domainsCount
Number of domains.
Definition types.h:1375
uint16_t ipv6Count
Number of IPv6 addresses.
Definition types.h:1388
Contains stats regarding the packet handler, for use in session stats.
Definition types.h:972
uint64_t bytesIn
Number of bytes going into packethandler (upload)
Definition types.h:981
uint64_t retries
Number of packets retries.
Definition types.h:987
uint64_t bytesOut
Number of bytes leaving packethandler (download)
Definition types.h:984
uint64_t packetsOut
Number of packets leaving packethandler (download)
Definition types.h:978
uint64_t packetsIn
Number of packets going into packethandler (upload)
Definition types.h:975
Local proxy domain watchlist item.
Definition types.h:1241
uint16_t proxiedDomainsCount
Number of proxied domains.
Definition types.h:1256
bool enabled
If the domains in this watchlist should be added to the local proxy filter.
Definition types.h:1247
uint16_t watchedDomainsCount
Number of watched domains.
Definition types.h:1250
Settings for the local proxy.
Definition types.h:1264
uint16_t portsCount
Number of ports.
Definition types.h:1296
bool domainWatchlistEnabled
Boolean to turn domain watchlist enablement on or off.
Definition types.h:1270
SpeedifySDK_ProxyMatchMode matchMode
How matches are handled.
Definition types.h:1273
bool enabled
If the local proxy should be enabled.
Definition types.h:1267
uint16_t domainsCount
Number of domains.
Definition types.h:1276
uint16_t ipv4Count
Number of IPv4 addresses.
Definition types.h:1282
uint16_t ipv6Count
Number of IPv6 addresses.
Definition types.h:1289
uint16_t domainWatchlistItemsCount
Number of watchlist items.
Definition types.h:1303
Represents a network share peer.
Definition types.h:1963
bool haveAuthToken
If we have exchanged an auth token with the peer.
Definition types.h:1972
bool autoReconnect
If its peer will be automatically reconnected one seen on the network.
Definition types.h:1969
bool supportsHost
If this peer supports being a host.
Definition types.h:1975
SpeedifySDK_NetworkSharingDisplayName displayName
The public display name.
Definition types.h:1978
SpeedifySDK_NetworkSharingConnection peerAsHost
Status of the connection to the host peer.
Definition types.h:1984
SpeedifySDK_NetworkSharingConnection peerAsClient
Status of the connection to the client peer.
Definition types.h:1981
SpeedifySDK_NetworkSharingPeerUuid uuid
UUID of the peer.
Definition types.h:1966
Network sharing connection.
Definition types.h:1946
SpeedifySDK_NetworkSharingUsage usage
usage over this connection
Definition types.h:1958
SpeedifySDK_NetworkSharingTunnelStatus tunnelStatus
status of the tunnel connection with this peer
Definition types.h:1952
SpeedifySDK_NetworkSharingPeerStatus peerStatus
status of this pure connection
Definition types.h:1949
bool allowed
If this connection is allowed.
Definition types.h:1955
Network sharing settings.
Definition types.h:1841
SpeedifySDK_NetworkSharingPairRequestBehavior pairRequestBehavior
How pair requests are handled.
Definition types.h:1856
bool alwaysOnDiscovery
If discovery is always active.
Definition types.h:1863
bool sameUserAutoPair
If devices from the same user are automatically paired.
Definition types.h:1859
bool clientEnabled
if network sharing client is enabled
Definition types.h:1844
SpeedifySDK_NetworkSharingConnectCode hostConnectCode
json data used for clients to manually connect to this host
Definition types.h:1850
SpeedifySDK_NetworkSharingDisplayName displayName
The public display name for this device.
Definition types.h:1853
SpeedifySDK_NetworkSharingAutoPairBehavior autoPairBehavior
If devices from the same user and/or team are automatically paired.
Definition types.h:1866
bool hostEnabled
if network sharing host is enabled
Definition types.h:1847
Network sharing usage data.
Definition types.h:1928
uint64_t bytesLastMonth
bytes used this month
Definition types.h:1937
uint64_t bytesToday
bytes used today
Definition types.h:1931
uint64_t bytesLastWeek
bytes used this week
Definition types.h:1934
uint64_t bytesTotal
bytes used total
Definition types.h:1940
Adapter setting for per-connection encryption.
Definition types.h:600
bool encrypted
If encryption is enabled.
Definition types.h:606
Adapter setting for per-connection expose DSCP.
Definition types.h:611
bool exposed
If DSCP is exposed.
Definition types.h:617
Adapter setting for per-connection parallel sockets.
Definition types.h:622
uint16_t sockets
Number of parallel sockets.
Definition types.h:628
Privacy settings.
Definition types.h:750
bool ipLeakProtection
If IP Leak protection is enabled.
Definition types.h:765
bool doNotStoreCredentials
If credentials, including oauth tokens and passwords, are not stored locally.
Definition types.h:778
uint16_t dnsAddressCount
Number of configured dns addresses to forward to.
Definition types.h:769
bool killswitch
If Internet Killswitch is enabled.
Definition types.h:755
bool apiProtection
if API protection is enabled
Definition types.h:787
bool requestToDisableDoH
Whether DoH is requested to be disabled.
Definition types.h:783
bool dnsLeakProtection
If DNS Leak protection is enabled.
Definition types.h:760
A protocol/port pair.
Definition types.h:570
uint16_t portRangeEnd
End of port range. If this entry is a single port, then this is 0.
Definition types.h:579
uint16_t port
Port number, or 0 for any port.
Definition types.h:576
SpeedifySDK_PortProtocol protocol
Transport layer protocol.
Definition types.h:573
Detailed information about a server.
Definition types.h:153
uint16_t publicIPCount
How many public IPs are in the list. Only available on connected server calls.
Definition types.h:175
uint16_t dnsIPCount
How many DNS IPs are in the list. Only available on connected server calls.
Definition types.h:183
int num
Server number. Each specific server in an area is given a number unique to that region,...
Definition types.h:162
bool isPremium
Whether this is a premium-only server.
Definition types.h:168
bool torrentAllowed
Whether this server allows bittorrent/P2P.
Definition types.h:171
bool isPrivate
Whether this is a private or public server.
Definition types.h:165
Automatic server selection method settings.
Definition types.h:493
SpeedifySDK_AutoConnectMethod connectMethod
Type of automatic selection used.
Definition types.h:496
int32_t num
Chosen server number, if connectMethod is ACM_COUNTRYCITYSERVER or ACM_EXACT.
Definition types.h:505
Statistics for sessions over various time periods.
Definition types.h:1132
uint8_t periodCount
Number of stat periods.
Definition types.h:1135
Statistics for a period.
Definition types.h:1066
int64_t bytesReceived
bytes received this period
Definition types.h:1072
int64_t encryptedBytesReceived
encrypted bytes received this period
Definition types.h:1078
SpeedifySDK_DscpStatsArray dscpStats
Contains stats for DSCP queues this period.
Definition types.h:1126
double mbpsDownBenefit
extra download bandwidth acheived this period, in megabits per second
Definition types.h:1108
int32_t daysSinceFirst
days since first connection
Definition types.h:1090
SpeedifySDK_HandlerStats handlerStats
Contains stats regarding the packet handler this period.
Definition types.h:1117
int64_t numFailovers
connection failovers this period
Definition types.h:1093
double maxUploadSpeed
maximum upload speed this period, megabits per second
Definition types.h:1087
SpeedifySDK_TunStats tunStats
Contains stats regarding the TUN this period.
Definition types.h:1114
int64_t bytesSent
bytes sent this period
Definition types.h:1075
int64_t totalConnectedMinutes
minutes connected, this period
Definition types.h:1105
int64_t retransBytes
bytes retransmitted this period
Definition types.h:1099
int64_t periodStartTime
start time of this period, in seconds since epoch
Definition types.h:1102
uint32_t period
period the time period this stat covers, in hours, SPEEDIFYSDK_STAT_PERIOD_CURRENT for current,...
Definition types.h:1069
SpeedifySDK_CaptivePortalStats captivePortalStats
Contains stats regarding captive portals this period.
Definition types.h:1120
SpeedifySDK_StreamingSessionStats streamingStats
Contains stats regarding streaming mode this period.
Definition types.h:1123
double mbpsUpBenefit
extra upload bandwidth acheived this period, in megabits per second
Definition types.h:1111
double maxDownloadSpeed
maximum download speed this period, megabits per second
Definition types.h:1084
int64_t encryptedBytesSent
encrypted bytes sent this period
Definition types.h:1081
int64_t numSessions
total number of sessions this period
Definition types.h:1096
Speedify settings.
Definition types.h:644
bool perConnectionEncryptionEnabled
If per-connection encryption is being used.
Definition types.h:679
double overflowThreshold
Overflow threshold, in megabits per second.
Definition types.h:702
uint32_t maximumTransportRetry
maximum time between transport connection retries, in seconds
Definition types.h:732
bool headerCompression
Whether header compression is enabled.
Definition types.h:714
uint16_t perConnectionExposeDscpCount
Number of configured per-connection expose DSCP settings. Only supported on Linux.
Definition types.h:689
uint16_t downstreamSubnetsCount
Number of configured downstream subnets.
Definition types.h:673
SpeedifySDK_TargetNumberOfConnections targetNumberOfConnections
The target number of connections for the VPN tunnel.
Definition types.h:738
bool encrypted
Whether all connections will be enabled.
Definition types.h:652
uint32_t maxRedundant
The maximum number of connections used to send redundant packets.
Definition types.h:726
bool enableAutomaticPriority
If automatic connection priorites are enabled.
Definition types.h:720
bool enableDefaultRoute
Whether the default route goes over the VPN tunnel.
Definition types.h:711
bool allowChaChaEncryption
Whether the use of ChaCha is allowed for connection encryption.
Definition types.h:655
uint16_t portsCount
Number of configured ports to forward.
Definition types.h:667
bool startupConnect
If Speedify will automatically connect when the daemon starts.
Definition types.h:661
uint32_t fixedDelay
The delay in ms applied in each direction to select flows.
Definition types.h:741
bool packetAggregation
Whether packet aggregation is enabled.
Definition types.h:708
unsigned long ulpReportIntervalSeconds
Represents the ULP reporting interval in seconds.
Definition types.h:723
SpeedifySDK_TransportMode transportMode
Currently used connection transport mode selection.
Definition types.h:664
uint16_t perConnectionParallelSocketsCount
Number of configured per-connection parallel socket settings.
Definition types.h:696
uint32_t maximumConnectRetry
maximum time between login/connect retries, in seconds
Definition types.h:729
double priorityOverflowThreshold
Priority overflow threshold, in megabits per second.
Definition types.h:705
bool jumboPackets
Whether to allow jumbo packets over the VPN tunnel.
Definition types.h:647
SpeedifySDK_BondingMode bondingMode
The current bonding mode.
Definition types.h:658
uint16_t perConnectionEncryptionCount
Number of configured per-connection encryption settings.
Definition types.h:682
Results of a speed test.
Definition types.h:1734
uint16_t jitter
jitter during test in ms, only valid for streaming tests
Definition types.h:1770
int64_t testTime
time of the test, in seconds since epoch
Definition types.h:1737
double downloadSpeed
tested download speed, bits per second
Definition types.h:1749
bool isError
is this test errored
Definition types.h:1755
uint16_t numConnections
How many connections were used during this test.
Definition types.h:1746
uint16_t fps
supported streaming frames per second (fps), only valid for streaming tests
Definition types.h:1767
double uploadSpeed
tested upload speed, bits per second
Definition types.h:1752
uint16_t latency
baseline latency in ms
Definition types.h:1773
double loss
packet loss percent during test, only valid for streaming tests
Definition types.h:1776
SpeedifySDK_SpeedTestType testType
type of test
Definition types.h:1761
Statistics for a single stream.
Definition types.h:1424
double averageDownloadSpeed
Average download speed of this stream, in megabits per second.
Definition types.h:1451
uint8_t dscp
The dscp tag of this stream.
Definition types.h:1482
SpeedifySDK_HostnameString hostname
The hostname of the service that this stream is connected to.
Definition types.h:1479
uint64_t duration
Time, in seconds, this stream has been active.
Definition types.h:1430
SpeedifySDK_StreamHealth health
Stream health.
Definition types.h:1466
uint64_t groupId
Group ID number of this stream.
Definition types.h:1436
uint64_t speedModeSaves
Number of saves while in speed mode.
Definition types.h:1457
uint64_t startTime
Time this stream started, seconds since epoch.
Definition types.h:1439
uint64_t failoverSaves
Definition types.h:1460
uint16_t remotePort
The remote port that this stream is connected to.
Definition types.h:1472
bool active
If this stream is currently active.
Definition types.h:1427
SpeedifySDK_IPAddressString remoteIp
The remote ip that this stream is connected to.
Definition types.h:1469
double downloadSpeed
Current download speed of this stream, in megabits per second.
Definition types.h:1445
double averageUploadSpeed
Average upload speed of this stream, in megabits per second.
Definition types.h:1448
uint64_t id
ID number of this stream.
Definition types.h:1433
uint64_t redundantModeSaves
Number of saves while in redundant mode.
Definition types.h:1454
double uploadSpeed
Current upload speed of this stream, in megabits per second.
Definition types.h:1442
Contains session stats regarding streaming mode.
Definition types.h:1003
uint64_t uniqueSaves
Unique streams saved.
Definition types.h:1018
uint64_t totalStreams
Total number of streams seen.
Definition types.h:1015
uint64_t totalFailoverSaves
Total number of saves from a failover.
Definition types.h:1006
uint64_t totalRedundantModeSaves
Total number of saves while in redundant mode.
Definition types.h:1012
uint64_t totalSpeedModeSaves
Total number of saves while in speed mode.
Definition types.h:1009
Settings for the priority streaming.
Definition types.h:1316
uint16_t ipv4Count
Number of IPv4 addresses.
Definition types.h:1325
uint16_t ipv6Count
Number of IPv6 addresses.
Definition types.h:1332
uint16_t portsCount
Number of ports.
Definition types.h:1339
uint16_t domainsCount
Number of domains.
Definition types.h:1319
Streaming mode stats.
Definition types.h:1488
bool badMemory
Indicator of high memory usage on the system, greater than 90%. Only tracked while active streams are...
Definition types.h:1513
SpeedifySDK_BondingMode bondingMode
Bonding mode in use.
Definition types.h:1491
bool badLoss
Indicator of high loss, greater than 3%. Only tracked while active streams are running.
Definition types.h:1501
bool badCpu
Indicator of high CPU usage on the system, greater than 90%. Only tracked while active streams are ru...
Definition types.h:1509
uint32_t streamsCount
Number of streams in this result.
Definition types.h:1494
bool badLatency
Indicator of high latency, greater than 300ms. Only tracked while active streams are running.
Definition types.h:1505
A subnet.
Definition types.h:589
SpeedifySDK_IPAddressString address
IP address.
Definition types.h:592
uint8_t prefixLength
network prefix length
Definition types.h:595
Target number of connections for the VPN tunnel.
Definition types.h:633
int32_t upload
Target number of connections for upload.
Definition types.h:636
int32_t download
Target number of connections for download.
Definition types.h:639
Contains stats regarding the TUN, for use in session stats.
Definition types.h:943
uint64_t packetsIn
Number of packets read from TUN.
Definition types.h:946
uint64_t packetsOut
Number of packets written to TUN.
Definition types.h:949
uint64_t bufferWaits
Number of buffer full waits.
Definition types.h:958
uint64_t readQueue
Size of the read queue.
Definition types.h:964
uint64_t bytesOut
Number of bytes written to TUN.
Definition types.h:955
uint64_t droppedIncoming
Number of incoming packets dropped.
Definition types.h:967
uint64_t bytesIn
Number of bytes read from TUN.
Definition types.h:952
uint64_t packetWaits
Number of packet pool waits.
Definition types.h:961
Version structure.
Definition types.h:58
uint16_t major
Major version.
Definition types.h:61
uint16_t build
Build number.
Definition types.h:70
uint16_t bugfix
Bugfix version.
Definition types.h:67
uint16_t minor
Minor version.
Definition types.h:64
SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair SpeedifySDK_StreamingPort
A streaming port.
Definition types.h:1312
ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkSharingPeerRole_toString(SpeedifySDK_NetworkSharingPeerRole role)
SpeedifySDK_DisconnectReason
Reason for a disconnect.
Definition types.h:1520
@ DR_UPDATE
Software update.
Definition types.h:1535
@ DR_SETTINGCHANGERECONNECT
Automatic reconnect from setting change.
Definition types.h:1559
@ DR_CONNECTIVITY
No network connectivity.
Definition types.h:1526
@ DR_REBOOT
Device reboot.
Definition types.h:1532
@ DR_NONE
Nothing to report.
Definition types.h:1574
@ DR_TORRENT
Automatic disconnect from torrent activity.
Definition types.h:1547
@ DR_OVERQUOTA
Account out of data.
Definition types.h:1568
@ DR_UNKNOWN
Unknown reason.
Definition types.h:1523
@ DR_TUNNELTIMEOUT
VPN tunnel blocked.
Definition types.h:1565
@ DR_USERINITIATED
User initiated.
Definition types.h:1544
@ DR_SERVICESTOP
Daemon stopped cleanly.
Definition types.h:1550
@ DR_SAFENETWORK
On a safe network, determined by safe browsing.
Definition types.h:1571
@ DR_DNSTIMEOUT
DNS timeout.
Definition types.h:1562
@ DR_SLEEP
Device sleep.
Definition types.h:1541
@ DR_STARTTIMEOUT
Timeout initializing the connection.
Definition types.h:1553
@ DR_INACTIVETIMEOUT
Tunnel timeout.
Definition types.h:1556
@ DR_AIRPLANE
Airplane mode activated, or no networks available.
Definition types.h:1529
@ DR_CRASH
Daemon crash.
Definition types.h:1538
SpeedifySDK_TransportMode
Transport Protocol modes.
Definition types.h:527
@ TMODE_PROXY
Proxy-only. This is not valid for SpeedifySDK_SetConnectionTransportMode.
Definition types.h:545
@ TMODE_SHARE
shared traffic. This is not valid for SpeedifySDK_SetConnectionTransportMode.
Definition types.h:548
@ TMODE_AUTO
Intelligently choose between available protocols.
Definition types.h:536
@ TMODE_TCP
Always use TCP.
Definition types.h:530
@ TMODE_UDP
Always use UDP.
Definition types.h:533
@ TMODE_MULTITCP
Always use Multi TCP.
Definition types.h:542
@ TMODE_HTTPS
Always use websocket.
Definition types.h:539
SpeedifySDK_NetworkSharingPeerRole
peer role
Definition types.h:1791
@ PR_CLIENT
client
Definition types.h:1794
@ PR_HOST
host
Definition types.h:1797
SpeedifySDK_EXTERN typedef char SpeedifySDK_NetworkSharingDisplayName[SPEEDIFYSDK_MAX_NETWORKSHARING_DISPLAY_NAME_LENGTH]
The public display name for this device.
Definition types.h:1784
SpeedifySDK_EXTERN typedef char SpeedifySDK_HostnameString[SPEEDIFYSDK_MAX_HOSTNAME_LENGTH]
String representation of an IP address.
Definition types.h:746
ENABLE_NETWORK_SHARING const char * SpeedifySDK_ErrorType_toString(SpeedifySDK_ErrorType error)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_State_toString(SpeedifySDK_State state)
SpeedifySDK_NetworkType
Type of network adapter.
Definition types.h:319
@ NETWORKTYPE_ETHERNET
Ethernet.
Definition types.h:325
@ NETWORKTYPE_VPN
VPN.
Definition types.h:331
@ NETWORKTYPE_NETWORKSHARE_CLIENT
Network Share Client.
Definition types.h:340
@ NETWORKTYPE_BLUETOOTH
Bluetooth.
Definition types.h:337
@ NETWORKTYPE_LOOPBACK
Loopback.
Definition types.h:334
@ NETWORKTYPE_WIFI
Wi-Fi.
Definition types.h:322
@ NETWORKTYPE_CELLULAR
Cellular.
Definition types.h:328
@ NETWORKTYPE_UNKNOWN
Unknown.
Definition types.h:346
@ NETWORKTYPE_NETWORKSHARE_HOST
Network Share Host.
Definition types.h:343
ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformationDetailed_GetCountryName(SpeedifySDK_ServerInformationDetailed server)
SpeedifySDK_ErrorType
Type classification for errors.
Definition types.h:1144
@ ET_SDK_CALLBACK_REQUIRED
A callback is required for this call.
Definition types.h:1198
@ ET_SDK_ASYNC
Result is an async call SDK. Not an error.
Definition types.h:1186
@ ET_SDK_SETTING_LOCKED_TEAM
Setting locked by server configuration.
Definition types.h:1211
@ ET_VPN_ADAPTER
Error opening or configuring the VPN adapter.
Definition types.h:1171
@ ET_NETWORK
Network related error.
Definition types.h:1150
@ ET_RATELIMITED
Too many requests are being made by this device.
Definition types.h:1165
@ ET_SDK_TIMEOUT
Timeout waiting for result.
Definition types.h:1192
@ ET_CREDENTIAL
Invalid credentials.
Definition types.h:1156
@ ET_SDK_NO_CONNECTION
No connection to the Speedify daemon.
Definition types.h:1204
@ ET_DIRECTORY
Directory list was empty.
Definition types.h:1159
@ ET_SDK_PLATFORM_NO_SUPPORT
Platform does not support this call.
Definition types.h:1201
@ ET_SDK_SYNC_FROM_ASYNC
Synchronous call used from within asynchronous callback. Not supported.
Definition types.h:1207
@ ET_SDK_INVALID_ARGUMENT
An invalid argument was supplied.
Definition types.h:1195
@ ET_TOKEN_EXPIRED
The provided OAUTH token is expired.
Definition types.h:1168
@ ET_DEVICE_LIMIT
The device limit has been reached.
Definition types.h:1174
@ ET_LOCK_ACCOUNT
Setting locked by account configuration.
Definition types.h:1180
@ ET_INVALID_ARGUMENT
An invalid argument was supplied.
Definition types.h:1183
@ ET_SERVER
An error occurred on the server.
Definition types.h:1153
@ ET_OK
No error.
Definition types.h:1147
@ ET_ACCOUNT
An issue with the account being used.
Definition types.h:1162
@ ET_LOCK_TEAM
Setting locked by server configuration.
Definition types.h:1177
@ ET_SDK_ERROR
An error in the SDK.
Definition types.h:1189
@ ET_SDK_SETTING_LOCKED_ACCOUNT
Setting locked by account configuration.
Definition types.h:1215
SpeedifySDK_EXTERN typedef char SpeedifySDK_NetworkSharingConnectCode[SPEEDIFYSDK_MAX_NETWORKSHARING_CONNECT_CODE_LENGTH]
Connect code for network sharing.
Definition types.h:1781
SpeedifySDK_EXTERN typedef char SpeedifySDK_DomainString[SPEEDIFYSDK_MAX_DOMAIN_LENGTH]
String representation of a domain or hostname.
Definition types.h:31
ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformation_GetCityName(SpeedifySDK_ServerInformation server)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkSharingTunnelStatus_toString(SpeedifySDK_NetworkSharingTunnelStatus status)
SpeedifySDK_StreamHealth
Stream health indicator.
Definition types.h:1405
@ SH_STOPPED
Stream has stopped.
Definition types.h:1410
@ SH_POOR
Stream may be encountering errors.
Definition types.h:1413
@ SH_GOOD
Stream is in good health.
Definition types.h:1416
ENABLE_NETWORK_SHARING const char * SpeedifySDK_ConnectionPriority_toString(SpeedifySDK_ConnectionPriority priority)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_SafeBrowsing_SafeNetworkOverride_toString(SpeedifySDK_SafeBrowsingSafeNetworkOverride level)
SpeedifySDK_NetworkSharingPeerStatus
Status of a NetworkSharing Peer Connection.
Definition types.h:1871
@ NPS_AUTHENTICATED
connected and authenticated
Definition types.h:1880
@ NPS_UNAUTHENTICATED
connected, but not authenticated
Definition types.h:1877
@ NPS_DISCONNECTED
The connection is disconnected.
Definition types.h:1874
ENABLE_NETWORK_SHARING const char * SpeedifySDK_DSCPPriority_toString(SpeedifySDK_DSCPPriority priority)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformationDetailed_GetCityName(SpeedifySDK_ServerInformationDetailed server)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkSharingAutoPairBehavior_toString(SpeedifySDK_NetworkSharingAutoPairBehavior behavior)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkType_toString(SpeedifySDK_NetworkType type)
SpeedifySDK_SafeBrowsingSafeNetworkOverride
Override safe network decisions.
Definition types.h:1713
@ SN_OVERRIDE_NONE
Definition types.h:1714
@ SN_OVERRIDE_UNSAFE
Definition types.h:1715
@ SN_OVERRIDE_SAFE
Definition types.h:1716
ENABLE_NETWORK_SHARING const char * SpeedifySDK_LogLevel_toString(SpeedifySDK_LogLevel level)
SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair SpeedifySDK_ForwardedPort
A forwarded port.
Definition types.h:584
SpeedifySDK_AccountAction
Actions that should be taken on an account.
Definition types.h:241
@ AA_ACTIVATE
No saved credentials/not previously activated. Activate the account.
Definition types.h:253
@ AA_NONE
No action needed.
Definition types.h:244
@ AA_RETRY_LOGIN
A (possibly temporary) error occurred. Retry login.
Definition types.h:247
@ AA_CONNECT_INTERNET_AND_RETRY_LOGIN
Connect to the internet and retry login.
Definition types.h:250
@ AA_ACTIVATE_OR_PURCHASE_LICENCE
Current account does not have a license usable on this device. Activate or purchase a license.
Definition types.h:256
SpeedifySDK_BondingMode
Mode of the VPN tunnel.
Definition types.h:510
@ BMODE_SPEED
Combine for speed.
Definition types.h:513
@ BMODE_STREAMING
Optimize for streaming.
Definition types.h:519
@ BMODE_REDUNDANT
Combine for reliability.
Definition types.h:516
SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair SpeedifySDK_LocalProxyPort
A proxied port.
Definition types.h:1237
ENABLE_NETWORK_SHARING const char * SpeedifySDK_Version_toString(SpeedifySDK_Version state)
SpeedifySDK_PortProtocol
Protocol for ports.
Definition types.h:556
@ PPROTO_TCP
TCP.
Definition types.h:559
@ PPROTO_UDP
UDP.
Definition types.h:562
ENABLE_NETWORK_SHARING const char * SpeedifySDK_AccountPaymentType_toString(SpeedifySDK_AccountPaymentType paymentType)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_DSCPReplication_toString(SpeedifySDK_DSCPReplication replication)
ENABLE_NETWORK_SHARING void SpeedifySDK_InitializeCreateSettings(SpeedifySDK_CreateSettings *settings)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_FirewallMode_toString(SpeedifySDK_FirewallMode matchMode)
SpeedifySDK_ConnectionDirectionalMode
Directional mode of a connection.
Definition types.h:407
@ CDM_STRICT_OFF
Always off.
Definition types.h:413
@ CDM_BACKUP_OFF
Off when not needed.
Definition types.h:416
@ CDM_ON
Always on.
Definition types.h:410
SpeedifySDK_EXTERN typedef SpeedifySDK_ServerInformation SpeedifySDK_ServerInformationDetailed
Information about a.
Definition types.h:195
SpeedifySDK_EXTERN typedef char SpeedifySDK_IPAddressString[SPEEDIFYSDK_MAX_IP_STRING_LENGTH]
String representation of an IP address.
Definition types.h:26
SpeedifySDK_DSCPReplication
DSCP replication behavior.
Definition types.h:1990
@ DSCP_REPLICATION_ON
DSCP replication is on.
Definition types.h:1996
@ DSCP_REPLICATION_AUTO
Speedify stream mode behavior.
Definition types.h:1993
@ DSCP_REPLICATION_OFF
DSCP replication is off.
Definition types.h:1999
ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformationDetailed_toString(SpeedifySDK_ServerInformationDetailed server)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_BondingMode_toString(SpeedifySDK_BondingMode priority)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformation_GetCountryName(SpeedifySDK_ServerInformation server)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_TransportMode_toString(SpeedifySDK_TransportMode priority)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformation_toString(SpeedifySDK_ServerInformation server)
SpeedifySDK_NetworkSharingAutoPairBehavior
Auto pair behavior types.
Definition types.h:1823
@ APB_MANUAL
no automatic pairing
Definition types.h:1826
@ APB_AUTO_USER_TEAM
Automatically pair with devices from the same user and/or team.
Definition types.h:1832
@ APB_AUTO_USER
Automatically pair with devices from the same user.
Definition types.h:1829
ENABLE_NETWORK_SHARING const char * SpeedifySDK_AccountAction_toString(SpeedifySDK_AccountAction action)
SpeedifySDK_FirewallMode
How firewall treats matches.
Definition types.h:1348
@ FWM_DENYLIST
Matches are dropped, all others are allowed through the VPN.
Definition types.h:1357
@ FWM_ALLOWLIST
Matches are allowed through the VPN, all others are dropped.
Definition types.h:1354
@ FWM_OFF
Firewall is disabled.
Definition types.h:1351
ENABLE_NETWORK_SHARING const char * SpeedifySDK_SpeedTestType_toString(SpeedifySDK_SpeedTestType type)
SpeedifySDK_State
State of the VPN.
Definition types.h:79
@ STATE_CONNECTING
Transitional state as we connect to speed server.
Definition types.h:94
@ STATE_DISCONNECTING
Transitional state as we disconnect from speed server.
Definition types.h:97
@ STATE_AUTO_CONNECTING
Transitional state as system automatically connects us to speed server.
Definition types.h:91
@ STATE_LOGGED_IN
Fully authenticated, but not using a speed server. Ready to connect()
Definition types.h:88
@ STATE_CONNECTED
Really connected to a speed server.
Definition types.h:100
@ STATE_UNKNOWN
Unable to connect to the local Speedify daemon.
Definition types.h:106
@ STATE_LOGGED_OUT
Completely disconnected and unathenticated. Need to login() to do anything.
Definition types.h:82
@ STATE_LOGGING_IN
Transitional state as we log in.
Definition types.h:85
@ STATE_OVERLIMIT
All available adapters are overlimit, VPN still in connected state.
Definition types.h:103
ENABLE_NETWORK_SHARING const char * SpeedifySDK_ConnectionDirectionalMode_toString(SpeedifySDK_ConnectionDirectionalMode mode)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkSharingPairRequestBehavior_toString(SpeedifySDK_NetworkSharingPairRequestBehavior behavior)
SpeedifySDK_ConnectionPriority
How a connection should be combined.
Definition types.h:354
@ CP_ALWAYS
Always use this connection.
Definition types.h:359
@ CP_BACKUP
Use this connection if others are unavailable.
Definition types.h:367
@ CP_AUTOMATIC
Let Speedify manage the priority.
Definition types.h:373
@ CP_NEVER
Never use this connection.
Definition types.h:370
@ CP_SECONDARY
Use this connection if others are full.
Definition types.h:364
SpeedifySDK_AutoConnectMethod
Methods for automatic server selection.
Definition types.h:114
@ ACM_CLOSEST
Closest public or private server to user.
Definition types.h:117
@ ACM_BYSETTING
Connect by automatic connection method.
Definition types.h:132
@ ACM_CLOSESTPRIVATE
Closest private server to user.
Definition types.h:120
@ ACM_P2P
Server that supports P2P/BitTorrent.
Definition types.h:129
@ ACM_PROXY
Local-proxy only connection.
Definition types.h:141
@ ACM_IGNORELAST
Connect using the current selection setting, but choose a different server instance than the one last...
Definition types.h:144
@ ACM_COUNTRYCITYSERVER
By specific country/city/server.
Definition types.h:135
@ ACM_CLOSESTPUBLIC
Closest public server to user.
Definition types.h:123
@ ACM_LAST
Last server connected to.
Definition types.h:126
@ ACM_EXACT
By exact specific country/city/server.
Definition types.h:138
SpeedifySDK_ConnectionState
State of Speedify on a given connection (network adapter).
Definition types.h:302
@ CSTATE_DISCONNECTED
Disconnected.
Definition types.h:305
@ CSTATE_CONNECTING
Connecting.
Definition types.h:308
@ CSTATE_CONNECTED
Connected.
Definition types.h:311
ENABLE_NETWORK_SHARING const char * SpeedifySDK_SafeBrowsing_LogLevel_toString(SpeedifySDK_SafeBrowsingLogLevel level)
SpeedifySDK_ProxyMatchMode
How local proxy treats matches.
Definition types.h:1223
@ PMM_DENYLIST
Domains and IP Addresses matched are sent over the VPN, all others are sent over the proxy.
Definition types.h:1229
@ PMM_ALLOWLIST
Domains and IP Addresses matched are sent over the proxy, all others are sent over the VPN.
Definition types.h:1226
ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkSharingPeerStatus_toString(SpeedifySDK_NetworkSharingPeerStatus status)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_AutoConnectMethod_toString(SpeedifySDK_AutoConnectMethod method)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_ConnectionState_toString(SpeedifySDK_ConnectionState state)
SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair SpeedifySDK_FirewallPort
A firewall port.
Definition types.h:1365
SpeedifySDK_SafeBrowsingLogLevel
Log levels in the SDK.
Definition types.h:1700
@ CUJO_LOG_DEBUG
Definition types.h:1701
@ CUJO_LOG_TRACE
Definition types.h:1705
@ CUJO_LOG_INFO
Definition types.h:1702
@ CUJO_LOG_WARNING
Definition types.h:1707
@ CUJO_LOG_ERROR
Definition types.h:1703
SpeedifySDK_SafeBrowsingError
Safe browsing errors.
Definition types.h:1659
@ CUJO_ERR_BAD_FUNCTION_ARGUMENT
Definition types.h:1673
@ CUJO_ERR_PARSE_ERROR
Definition types.h:1674
@ CUJO_ERR_NOT_CONFIGURED
Definition types.h:1663
@ CUJO_ERR_CURL_INIT_FAILURE
Definition types.h:1676
@ CUJO_ERR_CURL_EASY_INIT_FAILURE
Definition types.h:1678
@ CUJO_ERR_NO_ENDPOINT_URL
Definition types.h:1662
@ CUJO_ERR_CURL_HEADER_APPEND_FAILURE
Definition types.h:1680
@ CUJO_ERR_CURL
Definition types.h:1671
@ CUJO_ERR_TIMED_OUT
Fail open error.
Definition types.h:1666
@ CUJO_ERR_INTERRUPTED_EVENT_LOOP
Definition types.h:1694
@ CUJO_OK
Definition types.h:1660
@ CUJO_ERR_JSON_SET_FAILURE
Definition types.h:1682
@ CUJO_ERR_NO_MEMORY
Definition types.h:1672
@ CUJO_ERR_HTTP_STATUS
Definition types.h:1669
@ CUJO_ERR_ALREADY_IN_PROGRESS
Definition types.h:1686
@ CUJO_ERR_INVALID_NSP_TOKEN
Definition types.h:1688
@ CUJO_ERR_RETRIABLE_SERVER_ERROR
Definition types.h:1667
@ CUJO_ERR_ON_PROTECTED_NETWORK
Definition types.h:1690
@ CUJO_ERR_ASYNC_INIT_FAILURE
Definition types.h:1692
@ CUJO_ERR_UV_LOOP_INIT_FAILURE
Definition types.h:1684
ENABLE_NETWORK_SHARING const char * SpeedifySDK_DisconnectReason_toString(SpeedifySDK_DisconnectReason reason)
SpeedifySDK_SpeedTestType
Internal speed test types.
Definition types.h:1723
@ TEST_STREAMING
Definition types.h:1725
@ TEST_SPEED
Definition types.h:1724
SpeedifySDK_EXTERN typedef char SpeedifySDK_AppNameString[SPEEDIFYSDK_MAX_APP_NAME_LENGTH]
String representation of a SDK App name.
Definition types.h:36
ENABLE_NETWORK_SHARING const char * SpeedifySDK_ProxyMatchMode_toString(SpeedifySDK_ProxyMatchMode matchMode)
SpeedifySDK_LogLevel
Log levels in the SDK.
Definition types.h:1596
@ LL_INFO
Info.
Definition types.h:1602
@ LL_ERROR
Error.
Definition types.h:1608
@ LL_WARN
Warning.
Definition types.h:1605
@ LL_VERBOSE
Verbose.
Definition types.h:1599
SpeedifySDK_EXTERN typedef char SpeedifySDK_NetworkSharingPeerUuid[SPEEDIFYSDK_NETWORKSHARING_PEER_UUID_LENGTH]
Peer UUID for network sharing peer data.
Definition types.h:1787
ENABLE_NETWORK_SHARING const char * SpeedifySDK_StreamHealth_toString(SpeedifySDK_StreamHealth health)
ENABLE_NETWORK_SHARING const char * SpeedifySDK_PortProtocol_toString(SpeedifySDK_PortProtocol portProto)
SpeedifySDK_DSCPPriority
DSCP priority behavior.
Definition types.h:2007
@ DSCP_PRIORITY_OFF
DSCP priority is off.
Definition types.h:2016
@ DSCP_PRIORITY_ON
DSCP priority is on.
Definition types.h:2013
@ DSCP_PRIORITY_AUTO
Speedify stream detection.
Definition types.h:2010
SpeedifySDK_NetworkSharingPairRequestBehavior
pair request behavior types
Definition types.h:1805
@ PRB_ACCEPT
automatically accept
Definition types.h:1811
@ PRB_ASK
always ask
Definition types.h:1808
@ PRB_REJECT
automatically reject
Definition types.h:1814
SpeedifySDK_NetworkSharingTunnelStatus
Status of a NetworkSharing tunnel.
Definition types.h:1889
@ NTS_ACTIVE
active tunnels
Definition types.h:1895
@ NTS_DISABLED_ON_CLIENT
disallowed on client
Definition types.h:1898
@ NTS_TUNNEL_ERROR
general error
Definition types.h:1907
@ NTS_DISABLED_ON_HOST
disallowed on host
Definition types.h:1901
@ NTS_VPN_NOT_CONNECTED
Host's VPN not connected.
Definition types.h:1916
@ NTS_PAUSED
Active but paused.
Definition types.h:1919
@ NTS_INACTIVE
No active tunnels.
Definition types.h:1892
@ NTS_NOT_AUTHENTICATED
not authenticated
Definition types.h:1910
@ NTS_NETWORKS_OVERLIMIT
All networks are over data limit.
Definition types.h:1913
@ NTS_NO_NETWORKS
no networks available
Definition types.h:1904
SpeedifySDK_AccountPaymentType
Information on an account's payment type.
Definition types.h:224
@ APT_FREE
Free/unpaid.
Definition types.h:227
@ APT_MONTHLY
Paid, monthly contract.
Definition types.h:230
@ APT_YEARLY
Paid, yearly contract.
Definition types.h:233