Speedify SDK for Desktop/Embedded  15.0.1
types.h
Go to the documentation of this file.
1 // Copyright 2019, Connectify, Inc. All Rights Reserved
2 
3 #ifndef SPEEDIFYSDK_TYPES
4 #define SPEEDIFYSDK_TYPES
5 
6 #include "sdkdefines.h"
7 #include <stdbool.h>
8 #include <stdint.h>
9 #include <time.h>
10 
11 #ifdef _WIN32
12 #include <ws2tcpip.h>
13 #else
14 #include <netinet/ip.h>
15 #include <arpa/inet.h>
16 #endif
17 
23 
24 
28 
29 
33 
34 
38 
39 
42 SpeedifySDK_EXTERN typedef struct {
51  uint16_t port;
55 SpeedifySDK_EXPORT void SpeedifySDK_InitializeCreateSettings(SpeedifySDK_CreateSettings *settings);
56 
59 SpeedifySDK_EXTERN typedef struct {
62  uint16_t major;
65  uint16_t minor;
68  uint16_t bugfix;
71  uint16_t build;
75 SpeedifySDK_EXPORT const char* SpeedifySDK_Version_toString(SpeedifySDK_Version state);
76 
77 
80 SpeedifySDK_EXTERN typedef enum {
111 SpeedifySDK_EXPORT const char* SpeedifySDK_State_toString(SpeedifySDK_State state);
112 
115 SpeedifySDK_EXTERN typedef enum {
149 SpeedifySDK_EXPORT const char* SpeedifySDK_AutoConnectMethod_toString(SpeedifySDK_AutoConnectMethod method);
150 
151 
154 SpeedifySDK_EXTERN typedef struct {
163  int num;
166  bool isPrivate;
169  bool isPremium;
176  uint16_t publicIPCount;
184  uint16_t dnsIPCount;
197 
203 SpeedifySDK_EXPORT const char* SpeedifySDK_ServerInformation_GetCityName(SpeedifySDK_ServerInformation server);
206 SpeedifySDK_EXPORT const char* SpeedifySDK_ServerInformation_toString(SpeedifySDK_ServerInformation server);
207 
220 
221 
222 
225 SpeedifySDK_EXTERN typedef enum {
238 SpeedifySDK_EXPORT const char* SpeedifySDK_AccountPaymentType_toString(SpeedifySDK_AccountPaymentType paymentType);
239 
242 SpeedifySDK_EXTERN typedef enum {
261 SpeedifySDK_EXPORT const char* SpeedifySDK_AccountAction_toString(SpeedifySDK_AccountAction action);
262 
265 SpeedifySDK_EXTERN typedef struct {
274  int64_t bytesAvailable;
277  int64_t bytesUsed;
280  bool isTeam;
286  int32_t minutesUsed;
292  struct tm dataPeriodEnd;
297 
298 
303 SpeedifySDK_EXTERN typedef enum {
316 SpeedifySDK_EXPORT const char* SpeedifySDK_ConnectionState_toString(SpeedifySDK_ConnectionState state);
317 
320 SpeedifySDK_EXTERN typedef enum {
351 SpeedifySDK_EXPORT const char* SpeedifySDK_NetworkType_toString(SpeedifySDK_NetworkType type);
352 
355 SpeedifySDK_EXTERN typedef enum {
378 SpeedifySDK_EXPORT const char* SpeedifySDK_ConnectionPriority_toString(SpeedifySDK_ConnectionPriority priority);
379 
382 SpeedifySDK_EXTERN typedef struct {
385  int64_t usageMonthly;
388  int64_t usageDaily;
405 
408 SpeedifySDK_EXTERN typedef enum {
419 /* \brief String representation of a SpeedifySDK_ConnectionDirectionalMode
420  * @since 14.8.7 */
422 
425 SpeedifySDK_EXTERN typedef struct {
433 
437 SpeedifySDK_EXTERN typedef struct {
446  char description[SPEEDIFYSDK_MAX_ADAPTER_NAME];
458  char connectedNetworkName[SPEEDIFYSDK_MAX_ADAPTER_NAME];
461  char connectedNetworkBSSID[SPEEDIFYSDK_MAX_ADAPTER_NAME];
464  int64_t rateLimit;
478 
479 
482 SpeedifySDK_EXTERN typedef struct {
494  int32_t num;
496 
499 SpeedifySDK_EXTERN typedef enum {
512 SpeedifySDK_EXPORT const char* SpeedifySDK_BondingMode_toString(SpeedifySDK_BondingMode priority);
513 
516 SpeedifySDK_EXTERN typedef enum {
541 SpeedifySDK_EXPORT const char* SpeedifySDK_TransportMode_toString(SpeedifySDK_TransportMode priority);
542 
545 SpeedifySDK_EXTERN typedef enum {
555 SpeedifySDK_EXPORT const char* SpeedifySDK_PortProtocol_toString(SpeedifySDK_PortProtocol portProto);
556 
559 SpeedifySDK_EXTERN typedef struct {
565  uint16_t port;
568  uint16_t portRangeEnd;
570 
574 
575 
578 SpeedifySDK_EXTERN typedef struct {
584  uint8_t prefixLength;
586 
589 SpeedifySDK_EXTERN typedef struct {
595  bool encrypted;
597 
600 SpeedifySDK_EXTERN typedef struct {
606  bool exposed;
608 
611 SpeedifySDK_EXTERN typedef struct {
617  uint16_t sockets;
619 
622 SpeedifySDK_EXTERN typedef struct {
625  int32_t upload;
628  int32_t download;
630 
633 SpeedifySDK_EXTERN typedef struct {
641  bool encrypted;
656  uint16_t portsCount;
715  uint32_t maxRedundant;
729 
733 
736 SpeedifySDK_EXTERN typedef struct {
752 
755  uint16_t dnsAddressCount;
759 
765 
775 
782 SpeedifySDK_EXTERN typedef struct {
787  int64_t inFlight;
792  int64_t inFlightWindow;
795  bool connected;
798  bool sleeping;
806  char connectionID[SPEEDIFYSDK_MAX_ADAPTER_NAME];
817  double lossReceive;
822  double lossSend;
825  int64_t latencyMs;
842  uint32_t numberOfSockets;
851  int64_t totalBps;
856  int64_t sendBps;
861  int64_t receiveBps;
879  int32_t jitterMs;
885  float mos;
890  uint64_t sendBytes;
895  uint64_t receiveBytes;
900  bool congested;
902 
905 SpeedifySDK_EXTERN typedef struct {
908  uint64_t time;
911  uint16_t count;
916 
919 SpeedifySDK_EXTERN typedef struct {
922  uint64_t packetsIn;
925  uint64_t packetsOut;
928  uint64_t bytesIn;
931  uint64_t bytesOut;
934  uint64_t bufferWaits;
937  uint64_t packetWaits;
940  uint64_t readQueue;
943  uint64_t droppedIncoming;
945 
948 SpeedifySDK_EXTERN typedef struct {
951  uint64_t packetsIn;
954  uint64_t packetsOut;
957  uint64_t bytesIn;
960  uint64_t bytesOut;
963  uint64_t retries;
965 
968 SpeedifySDK_EXTERN typedef struct {
971  uint64_t detections;
974  uint64_t successes;
976 
979 SpeedifySDK_EXTERN typedef struct {
991  uint64_t totalStreams;
994  uint64_t uniqueSaves;
996 
999 SpeedifySDK_EXTERN typedef struct {
1002  uint8_t dscp;
1005  uint64_t bytesReceived;
1008  uint64_t bytesSent;
1011  double sendBps;
1014  double receiveBps;
1028 
1031 SpeedifySDK_EXTERN typedef struct {
1034  uint16_t count;
1039 
1042 SpeedifySDK_EXTERN typedef struct {
1045  uint32_t period;
1048  int64_t bytesReceived;
1051  int64_t bytesSent;
1069  int64_t numFailovers;
1072  int64_t numSessions;
1075  int64_t retransBytes;
1103 
1105 
1108 SpeedifySDK_EXTERN typedef struct {
1111  uint8_t periodCount;
1116 
1117 
1120 SpeedifySDK_EXTERN typedef enum {
1123  ET_OK = 0,
1162  ET_SDK_ASYNC = 0xE00,
1165  ET_SDK_ERROR = 0xF00,
1195 SpeedifySDK_EXPORT const char* SpeedifySDK_ErrorType_toString(SpeedifySDK_ErrorType error);
1196 
1199 SpeedifySDK_EXTERN typedef enum {
1209 SpeedifySDK_EXPORT const char* SpeedifySDK_ProxyMatchMode_toString(SpeedifySDK_ProxyMatchMode matchMode);
1210 
1214 
1217 SpeedifySDK_EXTERN typedef struct {
1223  bool enabled;
1237 
1240 SpeedifySDK_EXTERN typedef struct {
1243  bool enabled;
1252  uint16_t domainsCount;
1258  uint16_t ipv4Count;
1262  struct in_addr ipv4[SPEEDIFYSDK_MAX_PROXY_IPS];
1265  uint16_t ipv6Count;
1269  struct in6_addr ipv6[SPEEDIFYSDK_MAX_PROXY_IPS];
1272  uint16_t portsCount;
1284 
1285 
1289 
1292 SpeedifySDK_EXTERN typedef struct {
1295  uint16_t domainsCount;
1301  uint16_t ipv4Count;
1305  struct in_addr ipv4[SPEEDIFYSDK_MAX_STREAMING_IPS];
1308  uint16_t ipv6Count;
1312  struct in6_addr ipv6[SPEEDIFYSDK_MAX_STREAMING_IPS];
1315  uint16_t portsCount;
1321 
1324 SpeedifySDK_EXTERN typedef enum {
1337 SpeedifySDK_EXPORT const char* SpeedifySDK_FirewallMode_toString(SpeedifySDK_FirewallMode matchMode);
1338 
1342 
1345 SpeedifySDK_EXTERN typedef struct {
1351  uint16_t domainsCount;
1357  uint16_t ipv4Count;
1361  struct in_addr ipv4[SPEEDIFYSDK_MAX_FIREWALL_IPS];
1364  uint16_t ipv6Count;
1368  struct in6_addr ipv6[SPEEDIFYSDK_MAX_FIREWALL_IPS];
1371  uint16_t portsCount;
1377 
1378 
1381 SpeedifySDK_EXTERN typedef enum {
1396 SpeedifySDK_EXPORT const char* SpeedifySDK_StreamHealth_toString(SpeedifySDK_StreamHealth health);
1397 
1400 SpeedifySDK_EXTERN typedef struct {
1403  bool active;
1406  uint64_t duration;
1409  uint64_t id;
1412  uint64_t groupId;
1415  uint64_t startTime;
1418  double uploadSpeed;
1433  uint64_t speedModeSaves;
1436  uint64_t failoverSaves;
1448  uint16_t remotePort;
1458  uint8_t dscp;
1460 
1461 
1464 SpeedifySDK_EXTERN typedef struct {
1470  uint32_t streamsCount;
1477  bool badLoss;
1485  bool badCpu;
1491 
1492 
1493 
1496 SpeedifySDK_EXTERN typedef enum {
1552 SpeedifySDK_EXPORT const char* SpeedifySDK_DisconnectReason_toString(SpeedifySDK_DisconnectReason reason);
1553 
1556 SpeedifySDK_EXTERN typedef struct {
1563  int64_t sessionEnd;
1566  int64_t sessionLength;
1568 
1569 
1572 SpeedifySDK_EXTERN typedef enum {
1586 SpeedifySDK_EXPORT const char* SpeedifySDK_LogLevel_toString(SpeedifySDK_LogLevel level);
1587 
1590 SpeedifySDK_EXTERN typedef struct {
1596  int32_t fileSize;
1608  int32_t totalFiles;
1616 
1617 
1620 SpeedifySDK_EXTERN typedef struct {
1632 
1635 SpeedifySDK_EXTERN typedef enum {
1676 SpeedifySDK_EXTERN typedef enum {
1686 
1689 SpeedifySDK_EXTERN typedef enum {
1694 SpeedifySDK_EXPORT const char*
1696 
1699 SpeedifySDK_EXTERN typedef enum {
1703 
1706 SpeedifySDK_EXPORT const char* SpeedifySDK_SpeedTestType_toString(SpeedifySDK_SpeedTestType type);
1707 
1710 SpeedifySDK_EXTERN typedef struct {
1713  int64_t testTime;
1722  uint16_t numConnections;
1728  double uploadSpeed;
1731  bool isError;
1734  char errorMessage[SPEEDIFYSDK_MAX_ERROR_STRING];
1743  uint16_t fps;
1746  uint16_t jitter;
1749  uint16_t latency;
1752  double loss;
1754 
1764 
1767 SpeedifySDK_EXTERN typedef enum {
1778 
1781 SpeedifySDK_EXTERN typedef enum {
1792 
1796 
1799 SpeedifySDK_EXTERN typedef enum {
1810 
1814 
1817 SpeedifySDK_EXTERN typedef struct {
1844 
1847 SpeedifySDK_EXTERN typedef enum {
1858 
1862 
1865 SpeedifySDK_EXTERN typedef enum {
1897 
1901 
1904 SpeedifySDK_EXTERN typedef struct {
1907  uint64_t bytesToday;
1910  uint64_t bytesLastWeek;
1913  uint64_t bytesLastMonth;
1916  uint64_t bytesTotal;
1918 
1919 
1922 SpeedifySDK_EXTERN typedef struct {
1931  bool allowed;
1936 
1939 SpeedifySDK_EXTERN typedef struct {
1962 
1963 
1966 SpeedifySDK_EXTERN typedef enum {
1979 SpeedifySDK_EXPORT const char* SpeedifySDK_DSCPReplication_toString(SpeedifySDK_DSCPReplication replication);
1980 
1983 SpeedifySDK_EXTERN typedef enum {
1996 SpeedifySDK_EXPORT const char* SpeedifySDK_DSCPPriority_toString(SpeedifySDK_DSCPPriority priority);
1997 
2000 SpeedifySDK_EXTERN typedef struct {
2003  uint8_t dscpValue;
2014 
2017 SpeedifySDK_EXTERN typedef struct {
2020  uint8_t numDscpQueues;
2025 
2026 #endif
const char * SpeedifySDK_SafeBrowsing_LogLevel_toString(SpeedifySDK_SafeBrowsingLogLevel level)
Unknown.
Definition: types.h:347
uint16_t watchedDomainsCount
Number of watched domains.
Definition: types.h:1226
An invalid argument was supplied.
Definition: types.h:1171
SpeedifySDK_AdapterUsageData dataUsage
Data usage and limit information for this adapter.
Definition: types.h:467
uint64_t packetWaits
Number of packet pool waits.
Definition: types.h:937
Always use websocket.
Definition: types.h:528
uint64_t bytesTotal
bytes used total
Definition: types.h:1916
uint16_t publicIPCount
How many public IPs are in the list. Only available on connected server calls.
Definition: types.h:176
uint16_t dnsAddressCount
Number of configured dns addresses to forward to.
Definition: types.h:755
SpeedifySDK_NetworkType type
Type of the adapter.
Definition: types.h:452
SpeedifySDK_NetworkSharingPeerRole
peer role
Definition: types.h:1767
bool sameUserAutoPair
If devices from the same user are automatically paired.
Definition: types.h:1835
uint16_t remotePort
The remote port that this stream is connected to.
Definition: types.h:1448
#define SPEEDIFYSDK_MAX_PROXY_DOMAINS
Maximum number of domains returned.
Definition: sdkdefines.h:59
Definition: types.h:1658
always ask
Definition: types.h:1784
TCP.
Definition: types.h:548
No action needed.
Definition: types.h:245
SpeedifySDK_AccountPaymentType
Information on an account's payment type.
Definition: types.h:225
const char * SpeedifySDK_ProxyMatchMode_toString(SpeedifySDK_ProxyMatchMode matchMode)
String representation of a SpeedifySDK_ProxyMatchMode.
Settings for the local proxy.
Definition: types.h:1240
#define SPEEDIFYSDK_MAX_ADAPTER_NAME
Adapter name length.
Definition: sdkdefines.h:35
uint16_t count
the number of dscp queues
Definition: types.h:1034
Network sharing settings.
Definition: types.h:1817
bool clientEnabled
if network sharing client is enabled
Definition: types.h:1820
int64_t bytesReceived
bytes received this period
Definition: types.h:1048
Account out of data.
Definition: types.h:1544
SpeedifySDK_DisconnectReason
Reason for a disconnect.
Definition: types.h:1496
SpeedifySDK_NetworkSharingConnection peerAsHost
Status of the connection to the host peer.
Definition: types.h:1960
Always use TCP.
Definition: types.h:519
Contains stats regarding the TUN, for use in session stats.
Definition: types.h:919
const char * SpeedifySDK_FirewallMode_toString(SpeedifySDK_FirewallMode matchMode)
String representation of a SpeedifySDK_ProxyMatchMode.
Definition: types.h:1662
bool sleeping
is sleeping. Used on Cellular connections to improve battery life.
Definition: types.h:798
SpeedifySDK_ProtocolPortPair SpeedifySDK_FirewallPort
A firewall port.
Definition: types.h:1341
uint16_t port
Port number, or 0 for any port.
Definition: types.h:565
Statistics about a connection.
Definition: types.h:782
SpeedifySDK_NetworkSharingTunnelStatus
Status of a NetworkSharing tunnel.
Definition: types.h:1865
#define SPEEDIFYSDK_MAX_CITY_LEN
City id.
Definition: sdkdefines.h:26
Synchronous call used from within asynchronous callback. Not supported.
Definition: types.h:1183
#define SPEEDIFYSDK_MAX_HOSTNAME_LENGTH
Length of the hostname field.
Definition: sdkdefines.h:160
uint16_t perConnectionEncryptionCount
Number of configured per-connection encryption settings.
Definition: types.h:671
double priorityOverflowThreshold
Priority overflow threshold, in megabits per second.
Definition: types.h:694
uint64_t time
timestamp of the connection stats
Definition: types.h:908
const char * SpeedifySDK_StreamHealth_toString(SpeedifySDK_StreamHealth health)
String representation of a SpeedifySDK_StreamHealth.
Data on an account.
Definition: types.h:265
#define SPEEDIFYSDK_MAX_FIREWALL_PORTS
Maximum number of ports returned.
Definition: sdkdefines.h:74
SpeedifySDK_SafeBrowsingError
Safe browsing errors.
Definition: types.h:1635
Connected.
Definition: types.h:312
SpeedifySDK_ConnectionDirectionalMode upload
Upload mode.
Definition: types.h:428
Automatic reconnect from setting change.
Definition: types.h:1535
uint8_t dscp
The dscp tag of this stream.
Definition: types.h:1458
bool encrypted
Whether all connections will be enabled.
Definition: types.h:641
Definition: types.h:1639
Host's VPN not connected.
Definition: types.h:1892
uint16_t numConnections
How many connections were used during this test.
Definition: types.h:1722
SpeedifySDK_AutoConnectMethod
Methods for automatic server selection.
Definition: types.h:115
double sendEstimateMbps
estimated maximum megabits per second send.
Definition: types.h:867
Paid, yearly contract.
Definition: types.h:234
const char * SpeedifySDK_DSCPReplication_toString(SpeedifySDK_DSCPReplication replication)
String representation of a SpeedifySDK_DSCPReplication.
Definition: types.h:1678
SpeedifySDK_FirewallMode mode
How matches are handled.
Definition: types.h:1348
DNS timeout.
Definition: types.h:1538
Statistics for a single stream.
Definition: types.h:1400
Paid, monthly contract.
Definition: types.h:231
A (possibly temporary) error occurred. Retry login.
Definition: types.h:248
uint16_t domainsCount
Number of domains.
Definition: types.h:1351
double overflowThreshold
Overflow threshold, in megabits per second.
Definition: types.h:691
const char * SpeedifySDK_Version_toString(SpeedifySDK_Version state)
String representation of a SpeedifySDK_Version.
uint16_t fps
supported streaming frames per second (fps), only valid for streaming tests
Definition: types.h:1743
Error.
Definition: types.h:1584
Software update.
Definition: types.h:1511
Firewall settings.
Definition: types.h:1345
int64_t bytesSent
bytes sent this period
Definition: types.h:1051
uint64_t packetsOut
Number of packets written to TUN.
Definition: types.h:925
An error in the SDK.
Definition: types.h:1165
int32_t download
Target number of connections for download.
Definition: types.h:628
int32_t minutesUsed
Minutes used this data period (typically a month) for this account.
Definition: types.h:286
UDP.
Definition: types.h:551
int64_t totalBps
bits per second through this tunnel
Definition: types.h:851
Definition: types.h:1666
Timeout waiting for result.
Definition: types.h:1168
SpeedifySDK_SpeedTestType testType
type of test
Definition: types.h:1737
uint16_t sockets
Number of parallel sockets.
Definition: types.h:617
bool domainWatchlistEnabled
Boolean to turn domain watchlist enablement on or off.
Definition: types.h:1246
uint64_t bytesOut
Number of bytes leaving packethandler (download)
Definition: types.h:960
Automatically pair with devices from the same user.
Definition: types.h:1805
Combine for reliability.
Definition: types.h:505
#define SPEEDIFYSDK_MAX_PROXY_PORTS
Maximum number of ports returned.
Definition: sdkdefines.h:65
Connecting.
Definition: types.h:309
SpeedifySDK_DSCPPriority
DSCP priority behavior.
Definition: types.h:1983
uint16_t minor
Minor version.
Definition: types.h:65
const char * SpeedifySDK_ServerInformation_toString(SpeedifySDK_ServerInformation server)
String representation of a SpeedifySDK_ServerInformation.
Definition: types.h:1692
Definition: types.h:1656
Definition: types.h:1636
Active but paused.
Definition: types.h:1895
char SpeedifySDK_HostnameString[SPEEDIFYSDK_MAX_HOSTNAME_LENGTH]
String representation of an IP address.
Definition: types.h:732
#define SPEEDIFYSDK_NETWORKSHARING_PEER_UUID_LENGTH
Length of the peer UUID field.
Definition: sdkdefines.h:147
#define SPEEDIFYSDK_MAX_LANGUAGE_LEN
Language id length.
Definition: sdkdefines.h:122
Cellular.
Definition: types.h:329
const char * SpeedifySDK_NetworkSharingAutoPairBehavior_toString(SpeedifySDK_NetworkSharingAutoPairBehavior behavior)
String representation of a SpeedifySDK_NetworkSharingAutoPairBehavior.
SpeedifySDK_ProxyMatchMode matchMode
How matches are handled.
Definition: types.h:1249
Transitional state as system automatically connects us to speed server.
Definition: types.h:92
Daemon stopped cleanly.
Definition: types.h:1526
Disconnected.
Definition: types.h:306
SpeedifySDK_StreamHealth health
Stream health.
Definition: types.h:1442
const char * SpeedifySDK_ServerInformationDetailed_toString(SpeedifySDK_ServerInformationDetailed server)
String representation of a SpeedifySDK_ServerInformationDetailed.
bool apiProtection
if API protection is enabled
Definition: types.h:773
Tunnel timeout.
Definition: types.h:1532
SpeedifySDK_ConnectionPriority workingPriority
Effective priority of connections over this adapter.
Definition: types.h:470
uint16_t ipv6Count
Number of IPv6 addresses.
Definition: types.h:1265
Network Share Host.
Definition: types.h:344
double maxDownloadSpeed
maximum download speed this period, megabits per second
Definition: types.h:1060
Definition: types.h:1647
An issue with the account being used.
Definition: types.h:1138
All networks are over data limit.
Definition: types.h:1889
uint16_t perConnectionExposeDscpCount
Number of configured per-connection expose DSCP settings. Only supported on Linux.
Definition: types.h:678
uint32_t period
period the time period this stat covers, in hours, SPEEDIFYSDK_STAT_PERIOD_CURRENT for current,...
Definition: types.h:1045
Definition: types.h:1652
A grouping of ConnectionStats.
Definition: types.h:905
Ethernet.
Definition: types.h:326
Always on.
Definition: types.h:411
Network related error.
Definition: types.h:1126
SpeedifySDK_PortProtocol
Protocol for ports.
Definition: types.h:545
Speedify settings.
Definition: types.h:633
const char * SpeedifySDK_ConnectionState_toString(SpeedifySDK_ConnectionState state)
String representation of a SpeedifySDK_ConnectionState.
Always use Multi TCP.
Definition: types.h:531
double averageDownloadSpeed
Average download speed of this stream, in megabits per second.
Definition: types.h:1427
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:403
bool perConnectionEncryptionEnabled
If per-connection encryption is being used.
Definition: types.h:668
Definition: types.h:1654
uint64_t bytesLastWeek
bytes used this week
Definition: types.h:1910
uint64_t totalRedundantModeSaves
Total number of saves while in redundant mode.
Definition: types.h:988
DSCP settings.
Definition: types.h:2017
uint64_t totalSpeedModeSaves
Total number of saves while in speed mode.
Definition: types.h:985
Definition: types.h:1638
Info.
Definition: types.h:1578
uint16_t ipv6Count
Number of IPv6 addresses.
Definition: types.h:1308
bool haveAuthToken
If we have exchanged an auth token with the peer.
Definition: types.h:1948
Array of DSCP queue stats.
Definition: types.h:1031
double maxUploadSpeed
maximum upload speed this period, megabits per second
Definition: types.h:1063
double lossSend
send loss ratio (0.0-1.0)
Definition: types.h:822
Contains stats for a defined DSCP queue.
Definition: types.h:999
const char * SpeedifySDK_SpeedTestType_toString(SpeedifySDK_SpeedTestType type)
String representation of a SpeedifySDK_SpeedTestType.
int32_t filesPerDaemon
Number of log files allowed per SDK service instance.
Definition: types.h:1602
Definition: types.h:1650
SpeedifySDK_ProtocolPortPair SpeedifySDK_ForwardedPort
A forwarded port.
Definition: types.h:573
uint64_t receiveBytes
bytes received
Definition: types.h:895
SpeedifySDK_TransportMode
Transport Protocol modes.
Definition: types.h:516
int32_t num
Chosen server number, if connectMethod is ACM_COUNTRYCITYSERVER or ACM_EXACT.
Definition: types.h:494
int64_t receiveBps
bits per second received through this tunnel.
Definition: types.h:861
const char * SpeedifySDK_TransportMode_toString(SpeedifySDK_TransportMode priority)
String representation of a SpeedifySDK_TransportMode.
uint64_t readQueue
Size of the read queue.
Definition: types.h:940
SpeedifySDK_BondingMode
Mode of the VPN tunnel.
Definition: types.h:499
SpeedifySDK_NetworkSharingPeerStatus peerStatus
status of this pure connection
Definition: types.h:1925
SpeedifySDK_ConnectionPriority priority
Priority of connections over this adapter.
Definition: types.h:455
Never use this connection.
Definition: types.h:371
SpeedifySDK_IPAddressString localIp
internet facing ip address of the adapter.
Definition: types.h:812
int64_t encryptedBytesSent
encrypted bytes sent this period
Definition: types.h:1057
bool alwaysOnDiscovery
If discovery is always active.
Definition: types.h:1839
Unknown reason.
Definition: types.h:1499
A subnet.
Definition: types.h:578
Device reboot.
Definition: types.h:1508
Free/unpaid.
Definition: types.h:228
const char * SpeedifySDK_ServerInformation_GetCountryName(SpeedifySDK_ServerInformation server)
String representation of a SpeedifySDK_ServerInformation's country.
Target number of connections for the VPN tunnel.
Definition: types.h:622
bool hostEnabled
if network sharing host is enabled
Definition: types.h:1823
bool ipLeakProtection
If IP Leak protection is enabled.
Definition: types.h:751
SpeedifySDK_AccountAction
Actions that should be taken on an account.
Definition: types.h:242
SpeedifySDK_AccountPaymentType paymentType
Payment status of this account.
Definition: types.h:289
int32_t jitterMs
Jitter, in milliseconds.
Definition: types.h:879
#define SPEEDIFYSDK_MAX_DATACENTER_LENGTH
Length of the data center field.
Definition: sdkdefines.h:157
DSCP queue configuration.
Definition: types.h:2000
SpeedifySDK_NetworkSharingConnectCode hostConnectCode
json data used for clients to manually connect to this host
Definition: types.h:1826
SpeedifySDK_BondingMode bondingMode
The current bonding mode.
Definition: types.h:647
#define SPEEDIFYSDK_MAX_APP_NAME_LENGTH
Maximum SDK App name length.
Definition: sdkdefines.h:131
#define SPEEDIFYSDK_MAX_FIREWALL_DOMAINS
Maximum number of domains returned.
Definition: sdkdefines.h:68
bool enabled
If the local proxy should be enabled.
Definition: types.h:1243
Bluetooth.
Definition: types.h:338
uint8_t dscp
dscp value for this queue
Definition: types.h:1002
int32_t totalFiles
Total number of daemon log files to keep over all SDK service instances.
Definition: types.h:1608
Setting locked by server configuration.
Definition: types.h:1153
No saved credentials/not previously activated. Activate the account.
Definition: types.h:254
int64_t bytesAvailable
Bytes allowed per data period (typically a month) for this account. -1 for unlimited.
Definition: types.h:274
Definition: types.h:1643
int64_t usageMonthlyResetDay
Day of the month to reset monthly usage on. 0 for last 30 days.
Definition: types.h:394
uint64_t droppedIncoming
Number of incoming packets dropped.
Definition: types.h:943
SpeedifySDK_StreamHealth
Stream health indicator.
Definition: types.h:1381
Adapter setting for per-connection parallel sockets.
Definition: types.h:611
const char * SpeedifySDK_ServerInformationDetailed_GetCountryName(SpeedifySDK_ServerInformationDetailed server)
String representation of a SpeedifySDK_ServerInformationDetailed's country.
bool killswitch
If Internet Killswitch is enabled.
Definition: types.h:741
No error.
Definition: types.h:1123
uint8_t numDscpQueues
The number of DSCP queue configurations.
Definition: types.h:2020
int64_t retransBytes
bytes retransmitted this period
Definition: types.h:1075
const char * SpeedifySDK_AccountAction_toString(SpeedifySDK_AccountAction action)
String representation of a SpeedifySDK_AccountAction.
int64_t bytesUsed
Bytes used this data period (typically a month) for this account.
Definition: types.h:277
int64_t testTime
time of the test, in seconds since epoch
Definition: types.h:1713
bool enableEsni
If ESNI is enabled for this domain.
Definition: types.h:1627
Domains and IP Addresses matched are sent over the VPN, all others are sent over the proxy.
Definition: types.h:1205
Use this connection if others are unavailable.
Definition: types.h:368
char SpeedifySDK_AppNameString[SPEEDIFYSDK_MAX_APP_NAME_LENGTH]
String representation of a SDK App name.
Definition: types.h:37
#define SPEEDIFYSDK_MAX_DSCP_QUEUE_LENGTH
Maximum number of DSCP queues.
Definition: sdkdefines.h:169
uint16_t domainWatchlistItemsCount
Number of watchlist items.
Definition: types.h:1279
uint16_t jitter
jitter during test in ms, only valid for streaming tests
Definition: types.h:1746
Transitional state as we log in.
Definition: types.h:86
#define SPEEDIFYSDK_MAX_DNS_COUNT
Maximum number of DNS addresses to configure.
Definition: sdkdefines.h:53
bool enableDefaultRoute
Whether the default route goes over the VPN tunnel.
Definition: types.h:700
Information about a network adapter.
Definition: types.h:437
Nothing to report.
Definition: types.h:1550
uint64_t bufferWaits
Number of buffer full waits.
Definition: types.h:934
uint16_t perConnectionParallelSocketsCount
Number of configured per-connection parallel socket settings.
Definition: types.h:685
uint64_t failoverSaves
Definition: types.h:1436
SpeedifySDK_DSCPPriority priority
DSCP priority setting.
Definition: types.h:2006
Connect to the internet and retry login.
Definition: types.h:251
connected and authenticated
Definition: types.h:1856
const char * SpeedifySDK_ConnectionPriority_toString(SpeedifySDK_ConnectionPriority priority)
String representation of a SpeedifySDK_ConnectionPriority.
Server that supports P2P/BitTorrent.
Definition: types.h:130
Definition: types.h:1649
int64_t encryptedBytesReceived
encrypted bytes received this period
Definition: types.h:1054
int64_t sessionEnd
Time of the disconnect, in seconds since epoch. If 0, there has been no disconnect event to report....
Definition: types.h:1563
double uploadSpeed
Current upload speed of this stream, in megabits per second.
Definition: types.h:1418
DSCP priority is on.
Definition: types.h:1989
uint64_t bytesToday
bytes used today
Definition: types.h:1907
no automatic pairing
Definition: types.h:1802
Adapter setting for per-connection expose DSCP.
Definition: types.h:600
DSCP priority is off.
Definition: types.h:1992
uint16_t major
Major version.
Definition: types.h:62
#define SPEEDIFYSDK_MAX_WATCHLIST_ITEMS
Maximum number of domain watchlist items.
Definition: sdkdefines.h:77
Combine for speed.
Definition: types.h:502
Intelligently choose between available protocols.
Definition: types.h:525
Definition: types.h:1691
bool isPremium
Whether this is a premium-only server.
Definition: types.h:169
uint16_t domainsCount
Number of domains.
Definition: types.h:1252
uint16_t latency
baseline latency in ms
Definition: types.h:1749
bool allowed
If this connection is allowed.
Definition: types.h:1931
uint64_t packetsIn
Number of packets going into packethandler (upload)
Definition: types.h:951
User initiated.
Definition: types.h:1520
#define SPEEDIFYSDK_MAX_EMAIL
Email length.
Definition: sdkdefines.h:32
uint64_t bytesIn
Number of bytes going into packethandler (upload)
Definition: types.h:957
uint64_t packetsIn
Number of packets read from TUN.
Definition: types.h:922
SpeedifySDK_SafeBrowsingLogLevel
Log levels in the SDK.
Definition: types.h:1676
On a safe network, determined by safe browsing.
Definition: types.h:1547
Network sharing connection.
Definition: types.h:1922
uint64_t speedModeSaves
Number of saves while in speed mode.
Definition: types.h:1433
SpeedifySDK_DisconnectReason disconnectReason
Reason for the disconnect.
Definition: types.h:1559
#define SPEEDIFYSDK_MAX_WATCHLIST_TITLE
Maximum title length of domain watchlist item.
Definition: sdkdefines.h:80
Error opening or configuring the VPN adapter.
Definition: types.h:1147
bool startupConnect
If Speedify will automatically connect when the daemon starts.
Definition: types.h:650
All available adapters are overlimit, VPN still in connected state.
Definition: types.h:104
SpeedifySDK_NetworkSharingTunnelStatus tunnelStatus
status of the tunnel connection with this peer
Definition: types.h:1928
#define SPEEDIFYSDK_MAX_DOWNSTREAM_SUBNETS
Maximum number of subnets supported.
Definition: sdkdefines.h:41
Automatic server selection method settings.
Definition: types.h:482
Directory settings.
Definition: types.h:1620
uint64_t transportBytesSent
bytes sent through this queue on transport connections, includes retransmissions and redundancy
Definition: types.h:1020
Last server connected to.
Definition: types.h:127
Closest private server to user.
Definition: types.h:121
uint64_t transportBytesReceived
bytes received through this queue on transport connections, includes retransmissions and redundancy
Definition: types.h:1017
const char * SpeedifySDK_NetworkType_toString(SpeedifySDK_NetworkType type)
String representation of a SpeedifySDK_NetworkType.
SpeedifySDK_DSCPReplication replication
DSCP replication setting.
Definition: types.h:2009
const char * SpeedifySDK_ServerInformation_GetCityName(SpeedifySDK_ServerInformation server)
String representation of a SpeedifySDK_ServerInformation's city.
SpeedifySDK_IPAddressString remoteIp
The remote ip that this stream is connected to.
Definition: types.h:1445
char SpeedifySDK_NetworkSharingDisplayName[SPEEDIFYSDK_MAX_NETWORKSHARING_DISPLAY_NAME_LENGTH]
The public display name for this device.
Definition: types.h:1760
#define SPEEDIFYSDK_MAX_DIRECTORY_DOMAIN
Length of directory server domain.
Definition: sdkdefines.h:47
#define SPEEDIFYSDK_MAX_STREAMS
Maximum number of streams returns in a stats result.
Definition: sdkdefines.h:86
Transitional state as we connect to speed server.
Definition: types.h:95
int32_t upload
Target number of connections for upload.
Definition: types.h:625
bool isAutoAccount
If this account is an automatically generated account.
Definition: types.h:271
Closest public or private server to user.
Definition: types.h:118
bool connected
is connected
Definition: types.h:795
#define SPEEDIFYSDK_MAX_NETWORKSHARING_CONNECT_CODE_LENGTH
Maxmimum size of network sharing connect code.
Definition: sdkdefines.h:141
bool badCpu
Indicator of high CPU usage on the system, greater than 90%. Only tracked while active streams are ru...
Definition: types.h:1485
SpeedifySDK_NetworkType
Type of network adapter.
Definition: types.h:320
SpeedifySDK_SafeBrowsingSafeNetworkOverride
Override safe network decisions.
Definition: types.h:1689
bool supportsHost
If this peer supports being a host.
Definition: types.h:1951
Fail open error.
Definition: types.h:1642
SpeedifySDK_ConnectionDirectionalMode
Directional mode of a connection.
Definition: types.h:408
uint32_t maximumTransportRetry
maximum time between transport connection retries, in seconds
Definition: types.h:721
uint16_t bugfix
Bugfix version.
Definition: types.h:68
bool exposed
If DSCP is exposed.
Definition: types.h:606
not authenticated
Definition: types.h:1886
SpeedifySDK_NetworkSharingDisplayName displayName
The public display name for this device.
Definition: types.h:1829
bool enabled
If the domains in this watchlist should be added to the local proxy filter.
Definition: types.h:1223
Completely disconnected and unathenticated. Need to login() to do anything.
Definition: types.h:83
SpeedifySDK_IPAddressString address
IP address.
Definition: types.h:581
SpeedifySDK_ProtocolPortPair SpeedifySDK_StreamingPort
A streaming port.
Definition: types.h:1288
const char * SpeedifySDK_SafeBrowsing_SafeNetworkOverride_toString(SpeedifySDK_SafeBrowsingSafeNetworkOverride level)
active tunnels
Definition: types.h:1871
Definition: types.h:1664
#define SPEEDIFYSDK_MAX_STREAM_RESOLUTION_LENGTH
Maximum streaming resolution length.
Definition: sdkdefines.h:128
Connect using the current selection setting, but choose a different server instance than the one last...
Definition: types.h:145
int64_t usageDailyBoost
Extra Bytes allowed over this adapter today. This value resets to 0 every day.
Definition: types.h:400
VPN.
Definition: types.h:332
int64_t inFlight
bytes currently in flight
Definition: types.h:787
SpeedifySDK_ConnectionPriority
How a connection should be combined.
Definition: types.h:355
Directional settings for a connection.
Definition: types.h:425
no networks available
Definition: types.h:1880
uint16_t ipv6Count
Number of IPv6 addresses.
Definition: types.h:1364
double mbpsUpBenefit
extra upload bandwidth acheived this period, in megabits per second
Definition: types.h:1087
Always use this connection.
Definition: types.h:360
uint64_t totalStreams
Total number of streams seen.
Definition: types.h:991
double lossReceive
receive loss ratio (0.0-1.0)
Definition: types.h:817
bool congested
True if the connection is congested.
Definition: types.h:900
uint16_t dnsIPCount
How many DNS IPs are in the list. Only available on connected server calls.
Definition: types.h:184
Definition: types.h:1701
Streaming mode stats.
Definition: types.h:1464
Definition: types.h:1679
const char * SpeedifySDK_AutoConnectMethod_toString(SpeedifySDK_AutoConnectMethod method)
String representation of a SpeedifySDK_AutoConnectMethod.
SpeedifySDK_TransportMode transportMode
Currently used connection transport mode selection.
Definition: types.h:653
SpeedifySDK_NetworkSharingPeerStatus
Status of a NetworkSharing Peer Connection.
Definition: types.h:1847
double transportReceiveBps
bits per second received through this queue on transport connections, includes retransmissions and re...
Definition: types.h:1026
SpeedifySDK_IPAddressString privateIp
local ip address of the adapter.
Definition: types.h:831
int64_t usageDailyLimit
Bytes allowed over this adapter in a single day. 0 for unlimited.
Definition: types.h:397
uint64_t bytesReceived
bytes received through this queue
Definition: types.h:1005
Transitional state as we disconnect from speed server.
Definition: types.h:98
Network Share Client.
Definition: types.h:341
SpeedifySDK_IPAddressString ip
IP address of the speedify daemon to connect to.
Definition: types.h:48
uint16_t ipv4Count
Number of IPv4 addresses.
Definition: types.h:1357
Let Speedify manage the priority.
Definition: types.h:374
SpeedifySDK_ErrorType
Type classification for errors.
Definition: types.h:1120
SpeedifySDK_ProxyMatchMode
How local proxy treats matches.
Definition: types.h:1199
uint32_t maximumConnectRetry
maximum time between login/connect retries, in seconds
Definition: types.h:718
int64_t rateLimit
Speed limit, in bits per second. Or zero if unlimited.
Definition: types.h:464
int64_t periodStartTime
start time of this period, in seconds since epoch
Definition: types.h:1078
int64_t usageDaily
Bytes used over this adapter today.
Definition: types.h:388
SpeedifySDK_TransportMode protocol
protocol used for the tunnel.
Definition: types.h:836
double downloadSpeed
tested download speed, bits per second
Definition: types.h:1725
uint64_t startTime
Time this stream started, seconds since epoch.
Definition: types.h:1415
SpeedifySDK_NetworkSharingPairRequestBehavior pairRequestBehavior
How pair requests are handled.
Definition: types.h:1832
const char * SpeedifySDK_ErrorType_toString(SpeedifySDK_ErrorType error)
String representation of a SpeedifySDK_ErrorType.
Stream may be encountering errors.
Definition: types.h:1389
#define SPEEDIFYSDK_MAX_STREAM_NAME_LEN
Maximum length of SpeedifySDK_StreamStats name field.
Definition: sdkdefines.h:89
SpeedifySDK_LogLevel logLevel
Minimim logging level to allow.
Definition: types.h:1614
By exact specific country/city/server.
Definition: types.h:139
uint16_t portsCount
Number of ports.
Definition: types.h:1315
bool torrentAllowed
Whether this server allows bittorrent/P2P.
Definition: types.h:172
const char * SpeedifySDK_State_toString(SpeedifySDK_State state)
String representation of a SpeedifySDK_State.
uint16_t portRangeEnd
End of port range. If this entry is a single port, then this is 0.
Definition: types.h:568
SpeedifySDK_NetworkSharingDisplayName displayName
The public display name.
Definition: types.h:1954
Domains and IP Addresses matched are sent over the proxy, all others are sent over the VPN.
Definition: types.h:1202
double uploadSpeed
tested upload speed, bits per second
Definition: types.h:1728
SpeedifySDK_LogLevel
Log levels in the SDK.
Definition: types.h:1572
general error
Definition: types.h:1883
SpeedifySDK_AppNameString name
Name of the SDK app, used for auto accounts.
Definition: types.h:45
SpeedifySDK_ProtocolPortPair SpeedifySDK_LocalProxyPort
A proxied port.
Definition: types.h:1213
bool isError
is this test errored
Definition: types.h:1731
char SpeedifySDK_NetworkSharingPeerUuid[SPEEDIFYSDK_NETWORKSHARING_PEER_UUID_LENGTH]
Peer UUID for network sharing peer data.
Definition: types.h:1763
double receiveEstimateMbps
estimated maximum megabits per second received.
Definition: types.h:873
unsigned long ulpReportIntervalSeconds
Represents the ULP reporting interval in seconds.
Definition: types.h:712
#define SPEEDIFYSDK_MAX_NETWORKSHARING_DISPLAY_NAME_LENGTH
Maxmimum size a device's display name for pair and share discovery and advertisement.
Definition: sdkdefines.h:138
Firewall is disabled.
Definition: types.h:1327
Optimize for streaming.
Definition: types.h:508
Off when not needed.
Definition: types.h:417
const char * SpeedifySDK_BondingMode_toString(SpeedifySDK_BondingMode priority)
String representation of a SpeedifySDK_BondingMode.
const char * SpeedifySDK_NetworkSharingPeerStatus_toString(SpeedifySDK_NetworkSharingPeerStatus status)
String representation of a SpeedifySDK_NetworkSharingTunnelStatus.
bool jumboPackets
Whether to allow jumbo packets over the VPN tunnel.
Definition: types.h:636
uint16_t count
how many connections are in this group
Definition: types.h:911
SpeedifySDK_ConnectionDirectionalSettings directionalSettings
Connection direction settings.
Definition: types.h:476
uint16_t domainsCount
Number of domains.
Definition: types.h:1295
#define SPEEDIFYSDK_MAX_PACKET_POOL_NAME_LENGTH
Maximum length of the packet pool size string.
Definition: sdkdefines.h:166
Matches are allowed through the VPN, all others are dropped.
Definition: types.h:1330
SpeedifySDK_ConnectionState
State of Speedify on a given connection (network adapter).
Definition: types.h:303
Network sharing usage data.
Definition: types.h:1904
uint64_t bytesLastMonth
bytes used this month
Definition: types.h:1913
uint16_t build
Build number.
Definition: types.h:71
#define SPEEDIFYSDK_MAX_COUNTRY_LEN
Country id length.
Definition: sdkdefines.h:23
Too many requests are being made by this device.
Definition: types.h:1141
Verbose.
Definition: types.h:1575
const char * SpeedifySDK_NetworkSharingTunnelStatus_toString(SpeedifySDK_NetworkSharingTunnelStatus status)
String representation of a SpeedifySDK_NetworkSharingTunnelStatus.
bool badLoss
Indicator of high loss, greater than 3%. Only tracked while active streams are running.
Definition: types.h:1477
uint16_t portsCount
Number of ports.
Definition: types.h:1371
uint64_t groupId
Group ID number of this stream.
Definition: types.h:1412
Speedify stream detection.
Definition: types.h:1986
Setting locked by server configuration.
Definition: types.h:1187
host
Definition: types.h:1773
#define SPEEDIFYSDK_MAX_STREAMING_IPS
Maximum number of IPs returned.
Definition: sdkdefines.h:116
Stream has stopped.
Definition: types.h:1386
bool badMemory
Indicator of high memory usage on the system, greater than 90%. Only tracked while active streams are...
Definition: types.h:1489
uint8_t periodCount
Number of stat periods.
Definition: types.h:1111
const char * SpeedifySDK_LogLevel_toString(SpeedifySDK_LogLevel level)
uint64_t duration
Time, in seconds, this stream has been active.
Definition: types.h:1406
Timeout initializing the connection.
Definition: types.h:1529
const char * SpeedifySDK_NetworkSharingPeerRole_toString(SpeedifySDK_NetworkSharingPeerRole role)
String representation of a SpeedifySDK_NetworkSharingPeerRole.
uint32_t numberOfSockets
Number of active sockets for this connection.
Definition: types.h:842
int64_t sessionLength
Length of the session in seconds.
Definition: types.h:1566
const char * SpeedifySDK_DSCPPriority_toString(SpeedifySDK_DSCPPriority priority)
String representation of a SpeedifySDK_DSCPPriority.
uint64_t totalFailoverSaves
Total number of saves from a failover.
Definition: types.h:982
Statistics for sessions over various time periods.
Definition: types.h:1108
#define SPEEDIFYSDK_MAX_FORWARD_PORTS
Forwarded ports supported.
Definition: sdkdefines.h:38
uint64_t bytesOut
Number of bytes written to TUN.
Definition: types.h:931
The connection is disconnected.
Definition: types.h:1850
Stream is in good health.
Definition: types.h:1392
disallowed on host
Definition: types.h:1877
#define SPEEDIFYSDK_MAX_ERROR_STRING
Length of an error message.
Definition: sdkdefines.h:14
#define SPEEDIFYSDK_MAX_PROTOCOL_LENGTH
Length of the protocol field.
Definition: sdkdefines.h:163
The provided OAUTH token is expired.
Definition: types.h:1144
uint8_t dscpValue
DSCP value.
Definition: types.h:2003
bool requestToDisableDoH
Whether DoH is requested to be disabled.
Definition: types.h:769
Definition: types.h:1700
SpeedifySDK_FirewallMode
How firewall treats matches.
Definition: types.h:1324
SpeedifySDK_PortProtocol protocol
Transport layer protocol.
Definition: types.h:562
SpeedifySDK_NetworkSharingUsage usage
usage over this connection
Definition: types.h:1934
SpeedifySDK_HostnameString hostname
The hostname of the service that this stream is connected to.
Definition: types.h:1455
char SpeedifySDK_NetworkSharingConnectCode[SPEEDIFYSDK_MAX_NETWORKSHARING_CONNECT_CODE_LENGTH]
Connect code for network sharing.
Definition: types.h:1757
uint64_t packetsOut
Number of packets leaving packethandler (download)
Definition: types.h:954
shared traffic. This is not valid for SpeedifySDK_SetConnectionTransportMode.
Definition: types.h:537
No network connectivity.
Definition: types.h:1502
bool enableAutomaticPriority
If automatic connection priorites are enabled.
Definition: types.h:709
Definition: types.h:1670
Connect by automatic connection method.
Definition: types.h:133
double sendBps
bits per second sent through this queue.
Definition: types.h:1011
Setting locked by account configuration.
Definition: types.h:1156
SpeedifySDK_DscpStatsArray dscpStats
Contains stats for DSCP queues this period.
Definition: types.h:1102
const char * SpeedifySDK_PortProtocol_toString(SpeedifySDK_PortProtocol portProto)
String representation of a SpeedifySDK_PortProtocol.
SpeedifySDK_NetworkSharingConnection peerAsClient
Status of the connection to the client peer.
Definition: types.h:1957
const char * SpeedifySDK_AccountPaymentType_toString(SpeedifySDK_AccountPaymentType paymentType)
String representation of a SpeedifySDK_AccountPaymentType.
const char * SpeedifySDK_DisconnectReason_toString(SpeedifySDK_DisconnectReason reason)
const char * SpeedifySDK_ConnectionDirectionalMode_toString(SpeedifySDK_ConnectionDirectionalMode mode)
int32_t fileSize
Size of individual daemon log files, in bytes.
Definition: types.h:1596
Always off.
Definition: types.h:414
double receiveBps
bits per second received through this queue
Definition: types.h:1014
const char * SpeedifySDK_ServerInformationDetailed_GetCityName(SpeedifySDK_ServerInformationDetailed server)
String representation of a SpeedifySDK_ServerInformationDetailed's city.
Contains stats regarding the packet handler, for use in session stats.
Definition: types.h:948
A callback is required for this call.
Definition: types.h:1174
SpeedifySDK_AutoConnectMethod connectMethod
Type of automatic selection used.
Definition: types.h:485
const char * SpeedifySDK_NetworkSharingPairRequestBehavior_toString(SpeedifySDK_NetworkSharingPairRequestBehavior behavior)
String representation of a SpeedifySDK_NetworkSharingPairRequestBehavior.
Definition: types.h:1660
double loss
packet loss percent during test, only valid for streaming tests
Definition: types.h:1752
uint64_t bytesSent
bytes sent through this queue
Definition: types.h:1008
Local-proxy only connection.
Definition: types.h:142
Current account does not have a license usable on this device. Activate or purchase a license.
Definition: types.h:257
Use this connection if others are full.
Definition: types.h:365
#define SPEEDIFYSDK_MAX_PROXY_IPS
Maximum number of IPs returned.
Definition: sdkdefines.h:62
Unable to connect to the local Speedify daemon.
Definition: types.h:107
SpeedifySDK_AccountAction action
If any actions should be taken on this account.
Definition: types.h:295
SpeedifySDK_HandlerStats handlerStats
Contains stats regarding the packet handler this period.
Definition: types.h:1093
SDK creation settings structure.
Definition: types.h:42
double averageUploadSpeed
Average upload speed of this stream, in megabits per second.
Definition: types.h:1424
Invalid credentials.
Definition: types.h:1132
Privacy settings.
Definition: types.h:736
uint8_t prefixLength
network prefix length
Definition: types.h:584
int64_t numSessions
total number of sessions this period
Definition: types.h:1072
Proxy-only. This is not valid for SpeedifySDK_SetConnectionTransportMode.
Definition: types.h:534
Fully authenticated, but not using a speed server. Ready to connect()
Definition: types.h:89
Adapter setting for per-connection encryption.
Definition: types.h:589
Definition: types.h:1668
uint16_t proxiedDomainsCount
Number of proxied domains.
Definition: types.h:1232
uint16_t portsCount
Number of ports.
Definition: types.h:1272
Closest public server to user.
Definition: types.h:124
Statistics for a period.
Definition: types.h:1042
disallowed on client
Definition: types.h:1874
#define SPEEDIFYSDK_MAX_DOMAIN_LENGTH
Maximum length of domain to proxy.
Definition: sdkdefines.h:56
#define SPEEDIFYSDK_MAX_STREAMING_PORTS
Maximum number of ports returned.
Definition: sdkdefines.h:119
void SpeedifySDK_InitializeCreateSettings(SpeedifySDK_CreateSettings *settings)
Initialize an SpeedifySDK_CreateSettings object to defaults.
uint16_t port
Port number of the speedify daemon to connect to.
Definition: types.h:51
SpeedifySDK_BondingMode bondingMode
Bonding mode in use.
Definition: types.h:1467
#define SPEEDIFYSDK_MAX_STREAMING_DOMAINS
Maximum number of domains returned.
Definition: sdkdefines.h:113
SpeedifySDK_State
State of the VPN.
Definition: types.h:80
SpeedifySDK_ConnectionState state
State of the connection over this adapter.
Definition: types.h:449
int num
Server number. Each specific server in an area is given a number unique to that region,...
Definition: types.h:163
The device limit has been reached.
Definition: types.h:1150
uint8_t retransmissionAttempts
Maximum number of retransmission attempts.
Definition: types.h:2012
int64_t inFlightWindow
inflight window, bytes
Definition: types.h:792
int64_t totalConnectedMinutes
minutes connected, this period
Definition: types.h:1081
int64_t numFailovers
connection failovers this period
Definition: types.h:1069
automatically reject
Definition: types.h:1790
By specific country/city/server.
Definition: types.h:136
bool badLatency
Indicator of high latency, greater than 300ms. Only tracked while active streams are running.
Definition: types.h:1481
Definition: types.h:1648
bool dnsLeakProtection
If DNS Leak protection is enabled.
Definition: types.h:746
Definition: types.h:1681
DSCP replication is off.
Definition: types.h:1975
Contains stats regarding the captive portal.
Definition: types.h:968
Version structure.
Definition: types.h:59
bool isTeam
If this user is a teams member.
Definition: types.h:280
int64_t latencyMs
latency, milliseconds
Definition: types.h:825
No active tunnels.
Definition: types.h:1868
SpeedifySDK_NetworkSharingAutoPairBehavior
Auto pair behavior types.
Definition: types.h:1799
Speedify stream mode behavior.
Definition: types.h:1969
uint16_t ipv4Count
Number of IPv4 addresses.
Definition: types.h:1258
SpeedifySDK_ServerInformation SpeedifySDK_ServerInformationDetailed
Information about a.
Definition: types.h:196
#define SPEEDIFYSDK_MAX_WATCHLIST_DOMAINS
Maximum number of domains in a watchlist item.
Definition: sdkdefines.h:83
Setting locked by account configuration.
Definition: types.h:1191
SpeedifySDK_DSCPReplication
DSCP replication behavior.
Definition: types.h:1966
Information about a disconnect event.
Definition: types.h:1556
Contains session stats regarding streaming mode.
Definition: types.h:979
#define SPEEDIFYSDK_MAX_IP_STRING_LENGTH
IP string length.
Definition: sdkdefines.h:44
Result is an async call SDK. Not an error.
Definition: types.h:1162
char SpeedifySDK_DomainString[SPEEDIFYSDK_MAX_DOMAIN_LENGTH]
String representation of a domain or hostname.
Definition: types.h:32
Really connected to a speed server.
Definition: types.h:101
SpeedifySDK_CaptivePortalStats captivePortalStats
Contains stats regarding captive portals this period.
Definition: types.h:1096
bool autoReconnect
If its peer will be automatically reconnected one seen on the network.
Definition: types.h:1945
int64_t sendBps
bits per second sent through this tunnel.
Definition: types.h:856
SpeedifySDK_NetworkSharingPeerUuid uuid
UUID of the peer.
Definition: types.h:1942
Wi-Fi.
Definition: types.h:323
Device sleep.
Definition: types.h:1517
Settings for the priority streaming.
Definition: types.h:1292
uint16_t downstreamSubnetsCount
Number of configured downstream subnets.
Definition: types.h:662
uint64_t id
ID number of this stream.
Definition: types.h:1409
Detailed information about a server.
Definition: types.h:154
Results of a speed test.
Definition: types.h:1710
uint32_t maxRedundant
The maximum number of connections used to send redundant packets.
Definition: types.h:715
uint32_t streamsCount
Number of streams in this result.
Definition: types.h:1470
uint64_t uniqueSaves
Unique streams saved.
Definition: types.h:994
Airplane mode activated, or no networks available.
Definition: types.h:1505
uint16_t ipv4Count
Number of IPv4 addresses.
Definition: types.h:1301
SpeedifySDK_NetworkSharingAutoPairBehavior autoPairBehavior
If devices from the same user and/or team are automatically paired.
Definition: types.h:1842
#define SPEEDIFYSDK_MAX_FIREWALL_IPS
Maximum number of IPs returned.
Definition: sdkdefines.h:71
int32_t daysSinceFirst
days since first connection
Definition: types.h:1066
#define SPEEDIFYSDK_MAX_IP_COUNT
Maximum number of IPs on a server.
Definition: sdkdefines.h:50
Always use UDP.
Definition: types.h:522
#define SPEEDIFYSDK_MAX_STATS_PERIODS
Maximum number of stat periods requested.
Definition: sdkdefines.h:95
DSCP replication is on.
Definition: types.h:1972
SpeedifySDK_ConnectionDirectionalMode download
Download mode.
Definition: types.h:431
bool headerCompression
Whether header compression is enabled.
Definition: types.h:703
int32_t minutesAvailable
Minutes allowed per data period (typically a month) for this account. -1 for unlimited.
Definition: types.h:283
Local proxy domain watchlist item.
Definition: types.h:1217
An invalid argument was supplied.
Definition: types.h:1159
int64_t usageMonthly
Bytes used over this adapter in current month period.
Definition: types.h:385
uint16_t portsCount
Number of configured ports to forward.
Definition: types.h:656
Platform does not support this call.
Definition: types.h:1177
Definition: types.h:1645
uint64_t detections
Captive portal detections.
Definition: types.h:971
uint64_t bytesIn
Number of bytes read from TUN.
Definition: types.h:928
double downloadSpeed
Current download speed of this stream, in megabits per second.
Definition: types.h:1421
Definition: types.h:1677
client
Definition: types.h:1770
uint64_t redundantModeSaves
Number of saves while in redundant mode.
Definition: types.h:1430
uint64_t sendBytes
bytes sent
Definition: types.h:890
uint64_t successes
Successful captive portal logins.
Definition: types.h:974
VPN tunnel blocked.
Definition: types.h:1541
bool allowChaChaEncryption
Whether the use of ChaCha is allowed for connection encryption.
Definition: types.h:644
double mbpsDownBenefit
extra download bandwidth acheived this period, in megabits per second
Definition: types.h:1084
SpeedifySDK_SpeedTestType
Internal speed test types.
Definition: types.h:1699
An error occurred on the server.
Definition: types.h:1129
Automatic disconnect from torrent activity.
Definition: types.h:1523
SpeedifySDK_TargetNumberOfConnections targetNumberOfConnections
The target number of connections for the VPN tunnel.
Definition: types.h:727
A protocol/port pair.
Definition: types.h:559
int64_t usageMonthlyLimit
Bytes allowed over this adapter in current month period. 0 for unlimited.
Definition: types.h:391
Warning.
Definition: types.h:1581
Information about the data usage and limits of a network adapter.
Definition: types.h:382
Matches are dropped, all others are allowed through the VPN.
Definition: types.h:1333
SpeedifySDK_StreamingSessionStats streamingStats
Contains stats regarding streaming mode this period.
Definition: types.h:1099
Represents a network share peer.
Definition: types.h:1939
float mos
Mean Opinion Score, 1-5.
Definition: types.h:885
Definition: types.h:1690
SpeedifySDK_NetworkSharingPairRequestBehavior
pair request behavior types
Definition: types.h:1781
bool doNotStoreCredentials
If credentials, including oauth tokens and passwords, are not stored locally.
Definition: types.h:764
Settings for logging in the daemon.
Definition: types.h:1590
Automatically pair with devices from the same user and/or team.
Definition: types.h:1808
Daemon crash.
Definition: types.h:1514
bool isPrivate
Whether this is a private or public server.
Definition: types.h:166
Definition: types.h:1683
SpeedifySDK_TunStats tunStats
Contains stats regarding the TUN this period.
Definition: types.h:1090
connected, but not authenticated
Definition: types.h:1853
bool active
If this stream is currently active.
Definition: types.h:1403
#define SPEEDIFYSDK_MAX_ADAPTERS
Simultaneous adapters supported.
Definition: sdkdefines.h:17
automatically accept
Definition: types.h:1787
uint64_t retries
Number of packets retries.
Definition: types.h:963
Directory list was empty.
Definition: types.h:1135
double transportSendBps
bits per second sent through this queue on transport connections, includes retransmissions and redund...
Definition: types.h:1023
bool encrypted
If encryption is enabled.
Definition: types.h:595
No connection to the Speedify daemon.
Definition: types.h:1180
Loopback.
Definition: types.h:335
bool packetAggregation
Whether packet aggregation is enabled.
Definition: types.h:697
SpeedifySDK_IPAddressString remoteIp
internet facing ip address of the tunnel.
Definition: types.h:848
char SpeedifySDK_IPAddressString[SPEEDIFYSDK_MAX_IP_STRING_LENGTH]
String representation of an IP address.
Definition: types.h:27