Speedify SDK for Desktop  10.7.0
types.h
Go to the documentation of this file.
1 #ifndef SPEEDIFYSDK_TYPES
2 #define SPEEDIFYSDK_TYPES
3 
4 #include "sdkdefines.h"
5 #include <stdbool.h>
6 #include <stdint.h>
7 #include <time.h>
8 
9 #ifdef _WIN32
10 #include <ws2tcpip.h>
11 #else
12 #include <netinet/ip.h>
13 #include <arpa/inet.h>
14 #endif
15 
21 
22 
26 
27 
31 
32 
35 SpeedifySDK_EXTERN typedef struct {
41  uint16_t port;
43 
46 SpeedifySDK_EXTERN typedef struct {
49  uint16_t major;
52  uint16_t minor;
55  uint16_t bugfix;
58  uint16_t build;
62 SpeedifySDK_EXPORT const char* SpeedifySDK_Version_toString(SpeedifySDK_Version state);
63 
64 
67 SpeedifySDK_EXTERN typedef enum {
98 SpeedifySDK_EXPORT const char* SpeedifySDK_State_toString(SpeedifySDK_State state);
99 
102 SpeedifySDK_EXTERN typedef enum {
130 SpeedifySDK_EXPORT const char* SpeedifySDK_AutoConnectMethod_toString(SpeedifySDK_AutoConnectMethod method);
131 
134 SpeedifySDK_EXTERN typedef struct {
143  int32_t num;
146  bool isPrivate;
148 
151 SpeedifySDK_EXTERN typedef struct {
160  int num;
163  bool isPrivate;
169  uint16_t publicIPCount;
173 
175 
181 SpeedifySDK_EXPORT const char* SpeedifySDK_ServerInformation_GetCityName(SpeedifySDK_ServerInformation server);
184 SpeedifySDK_EXPORT const char* SpeedifySDK_ServerInformation_toString(SpeedifySDK_ServerInformation server);
185 
195 
196 
197 
200 SpeedifySDK_EXTERN typedef enum {
213 SpeedifySDK_EXPORT const char* SpeedifySDK_AccountPaymentType_toString(SpeedifySDK_AccountPaymentType paymentType);
214 
217 SpeedifySDK_EXTERN typedef struct {
226  int64_t bytesAvailable;
229  int64_t bytesUsed;
232  bool isTeam;
238  int32_t minutesUsed;
244  struct tm dataPeriodEnd;
246 
247 
252 SpeedifySDK_EXTERN typedef enum {
265 SpeedifySDK_EXPORT const char* SpeedifySDK_ConnectionState_toString(SpeedifySDK_ConnectionState state);
266 
269 SpeedifySDK_EXTERN typedef enum {
294 SpeedifySDK_EXPORT const char* SpeedifySDK_NetworkType_toString(SpeedifySDK_NetworkType type);
295 
298 SpeedifySDK_EXTERN typedef enum {
321 SpeedifySDK_EXPORT const char* SpeedifySDK_ConnectionPriority_toString(SpeedifySDK_ConnectionPriority priority);
322 
325 SpeedifySDK_EXTERN typedef struct {
328  int64_t usageMonthly;
331  int64_t usageDaily;
348 
352 SpeedifySDK_EXTERN typedef struct {
361  char description[SPEEDIFYSDK_MAX_ADAPTER_NAME];
373  char connectedNetworkName[SPEEDIFYSDK_MAX_ADAPTER_NAME];
376  char connectedNetworkBSSID[SPEEDIFYSDK_MAX_ADAPTER_NAME];
379  int64_t rateLimit;
384 
385 
388 SpeedifySDK_EXTERN typedef struct {
400  int32_t num;
402 
405 SpeedifySDK_EXTERN typedef enum {
418 SpeedifySDK_EXPORT const char* SpeedifySDK_BondingMode_toString(SpeedifySDK_BondingMode priority);
419 
422 SpeedifySDK_EXTERN typedef enum {
438 SpeedifySDK_EXPORT const char* SpeedifySDK_TransportMode_toString(SpeedifySDK_TransportMode priority);
439 
442 SpeedifySDK_EXTERN typedef enum {
452 SpeedifySDK_EXPORT const char* SpeedifySDK_PortProtocol_toString(SpeedifySDK_PortProtocol portProto);
453 
456 SpeedifySDK_EXTERN typedef struct {
462  uint16_t port;
464 
467 SpeedifySDK_EXTERN typedef struct {
473  bool encrypted;
475 
478 SpeedifySDK_EXTERN typedef struct {
486  bool encrypted;
501  uint16_t portsCount;
527 
528 
531 SpeedifySDK_EXTERN typedef struct {
541  bool dnsleak;
546  bool ipleak;
551 
554  uint16_t dnsAddressCount;
560 
567 
574 SpeedifySDK_EXTERN typedef struct {
579  int64_t inFlight;
584  int64_t inFlightWindow;
587  bool connected;
590  bool sleeping;
598  char connectionID[SPEEDIFYSDK_MAX_ADAPTER_NAME];
609  int64_t lossReceive;
614  int64_t lossSend;
617  int64_t latencyMs;
638  int64_t totalBps;
643  int64_t sendBps;
648  int64_t receiveBps;
662 
665 SpeedifySDK_EXTERN typedef struct {
668  uint64_t time;
671  uint16_t count;
676 
679 SpeedifySDK_EXTERN typedef struct {
682  uint64_t packetsIn;
685  uint64_t packetsOut;
688  uint64_t bytesIn;
691  uint64_t bytesOut;
694  uint64_t bufferWaits;
697  uint64_t packetWaits;
700  uint64_t readQueue;
703  uint64_t droppedIncoming;
705 
708 SpeedifySDK_EXTERN typedef struct {
711  uint64_t packetsIn;
714  uint64_t packetsOut;
717  uint64_t bytesIn;
720  uint64_t bytesOut;
723  uint64_t retries;
725 
728 SpeedifySDK_EXTERN typedef struct {
731  uint64_t detections;
734  uint64_t successes;
736 
739 SpeedifySDK_EXTERN typedef struct {
751  uint64_t totalStreams;
754  uint64_t uniqueSaves;
756 
759 SpeedifySDK_EXTERN typedef struct {
762  uint32_t period;
765  int64_t bytesReceived;
768  int64_t bytesSent;
783  int32_t daysSinceFirst;
786  int64_t numFailovers;
789  int64_t numSessions;
792  int64_t retransBytes;
817 
819 
822 SpeedifySDK_EXTERN typedef struct {
825  uint8_t periodCount;
830 
833 SpeedifySDK_EXTERN typedef enum {
846 SpeedifySDK_EXPORT const char* SpeedifySDK_SpeedTestStatus_toString(SpeedifySDK_SpeedTestStatus status);
847 
850 SpeedifySDK_EXTERN typedef enum {
866 SpeedifySDK_EXPORT const char* SpeedifySDK_SpeedTestStep_toString(SpeedifySDK_SpeedTestStep step);
867 
870 SpeedifySDK_EXTERN typedef struct {
881  double stepProgress;
884  double rttMs;
887  double downloadBps;
890  double uploadBps;
892 
895 SpeedifySDK_EXTERN typedef struct {
901  uint16_t count;
906 
907 
910 SpeedifySDK_EXTERN typedef enum {
913  ET_OK = 0,
940  ET_SDK_ASYNC = 0xE00,
943  ET_SDK_ERROR = 0xF00,
968 SpeedifySDK_EXPORT const char* SpeedifySDK_ErrorType_toString(SpeedifySDK_ErrorType error);
969 
972 SpeedifySDK_EXTERN typedef enum {
982 SpeedifySDK_EXPORT const char* SpeedifySDK_ProxyMatchMode_toString(SpeedifySDK_ProxyMatchMode matchMode);
983 
984 
987 SpeedifySDK_EXTERN typedef struct {
993  uint16_t port;
995 
998 SpeedifySDK_EXTERN typedef struct {
1004  bool enabled;
1018 
1021 SpeedifySDK_EXTERN typedef struct {
1024  bool enabled;
1030  uint16_t domainsCount;
1036  uint16_t ipv4Count;
1040  struct in_addr ipv4[SPEEDIFYSDK_MAX_PROXY_IPS];
1043  uint16_t portsCount;
1055 
1056 
1059 SpeedifySDK_EXTERN typedef enum {
1072 SpeedifySDK_EXPORT const char* SpeedifySDK_FirewallMode_toString(SpeedifySDK_FirewallMode matchMode);
1073 
1076 SpeedifySDK_EXTERN typedef struct {
1082  uint16_t port;
1084 
1087 SpeedifySDK_EXTERN typedef struct {
1093  uint16_t domainsCount;
1099  uint16_t ipv4Count;
1103  struct in_addr ipv4[SPEEDIFYSDK_MAX_FIREWALL_IPS];
1106  uint16_t ipv6Count;
1110  struct in6_addr ipv6[SPEEDIFYSDK_MAX_FIREWALL_IPS];
1113  uint16_t portsCount;
1119 
1120 
1123 SpeedifySDK_EXTERN typedef struct {
1126  bool active;
1129  uint64_t duration;
1132  uint64_t id;
1135  uint64_t groupId;
1138  uint64_t startTime;
1141  double uploadSpeed;
1156  uint64_t speedModeSaves;
1161 
1162 
1165 SpeedifySDK_EXTERN typedef struct {
1171  uint32_t streamsCount;
1176 
1177 
1178 
1181 SpeedifySDK_EXTERN typedef enum {
1228 SpeedifySDK_EXPORT const char* SpeedifySDK_DisconnectReason_toString(SpeedifySDK_DisconnectReason reason);
1229 
1232 SpeedifySDK_EXTERN typedef struct {
1237 
1238 
1241 SpeedifySDK_EXTERN typedef enum {
1255 SpeedifySDK_EXPORT const char* SpeedifySDK_LogLevel_toString(SpeedifySDK_LogLevel level);
1256 
1259 SpeedifySDK_EXTERN typedef struct {
1265  int32_t fileSize;
1277  int32_t totalFiles;
1285 
1286 
1289 SpeedifySDK_EXTERN typedef struct {
1300 
1303 SpeedifySDK_EXTERN typedef enum {
1321 #endif
Unknown.
Definition: types.h:290
uint16_t watchedDomainsCount
Number of watched domains.
Definition: types.h:1007
An invalid argument was supplied.
Definition: types.h:949
SpeedifySDK_AdapterUsageData dataUsage
Data usage and limit information for this adapter.
Definition: types.h:382
uint64_t packetWaits
Number of packet pool waits.
Definition: types.h:697
Always use websocket.
Definition: types.h:434
uint16_t dnsAddressCount
Number of configured dns addresses to forward.
Definition: types.h:554
SpeedifySDK_NetworkType type
Type of the adapter.
Definition: types.h:367
#define SPEEDIFYSDK_MAX_PROXY_DOMAINS
Maximum number of domains returned.
Definition: sdkdefines.h:54
TCP.
Definition: types.h:445
SpeedifySDK_AccountPaymentType
Information on an account's payment type.
Definition: types.h:200
const char * SpeedifySDK_ProxyMatchMode_toString(SpeedifySDK_ProxyMatchMode matchMode)
String representation of a SpeedifySDK_ProxyMatchMode.
Settings for the local proxy.
Definition: types.h:1021
#define SPEEDIFYSDK_MAX_ADAPTER_NAME
Adapter name length.
Definition: sdkdefines.h:33
int64_t bytesReceived
bytes received this period
Definition: types.h:765
SpeedifySDK_DisconnectReason
Reason for a disconnect.
Definition: types.h:1181
Always use TCP.
Definition: types.h:425
Contains stats regarding the TUN, for use in session stats.
Definition: types.h:679
const char * SpeedifySDK_FirewallMode_toString(SpeedifySDK_FirewallMode matchMode)
String representation of a SpeedifySDK_ProxyMatchMode.
bool sleeping
is sleeping. Used on Cellular connections to improve battery life.
Definition: types.h:590
Test complete.
Definition: types.h:842
Statistics about a connection.
Definition: types.h:574
#define SPEEDIFYSDK_MAX_CITY_LEN
City id.
Definition: sdkdefines.h:24
Synchronous call used from within asynchronous callback. Not supported.
Definition: types.h:964
uint16_t perConnectionEncryptionCount
Number of configured per-connection encryption settings.
Definition: types.h:510
uint64_t time
timestamp of the connection stats
Definition: types.h:668
Data on an account.
Definition: types.h:217
#define SPEEDIFYSDK_MAX_FIREWALL_PORTS
Maximum number of ports returned.
Definition: sdkdefines.h:69
SpeedifySDK_SafeBrowsingError
Safe browsing errors.
Definition: types.h:1303
Connected.
Definition: types.h:261
Automatic reconnect from setting change.
Definition: types.h:1220
bool encrypted
Whether all connections will be enabled.
Definition: types.h:486
Definition: types.h:1306
SpeedifySDK_AutoConnectMethod
Methods for automatic server selection.
Definition: types.h:102
double sendEstimateMbps
estimated maximum megabytes per second send.
Definition: types.h:654
Paid, yearly contract.
Definition: types.h:209
Definition: types.h:1312
SpeedifySDK_FirewallMode mode
How matches are handled.
Definition: types.h:1090
DNS timeout.
Definition: types.h:1223
Statistics for a single stream.
Definition: types.h:1123
Paid, monthly contract.
Definition: types.h:206
bool torrentAllowed
Whether this server allows bittorrent/P2P.
Definition: types.h:166
bool crashReports
If crash reporting is enabled.
Definition: types.h:550
uint16_t domainsCount
Number of domains.
Definition: types.h:1093
double overflowThreshold
Overflow threshold, in megabits per second.
Definition: types.h:516
const char * SpeedifySDK_Version_toString(SpeedifySDK_Version state)
String representation of a SpeedifySDK_Version.
Error.
Definition: types.h:1253
Software update.
Definition: types.h:1196
Firewall settings.
Definition: types.h:1087
int64_t bytesSent
bytes sent this period
Definition: types.h:768
uint64_t packetsOut
Number of packets written to TUN.
Definition: types.h:685
An error in the SDK.
Definition: types.h:943
int32_t minutesUsed
Minutes used this data period (typically a month) for this account.
Definition: types.h:238
UDP.
Definition: types.h:448
int64_t totalBps
bytes per second through this tunnel
Definition: types.h:638
Definition: types.h:1314
Timeout waiting for result.
Definition: types.h:946
uint64_t bytesOut
Number of bytes leaving packethandler (download)
Definition: types.h:720
Upload.
Definition: types.h:862
Combine for reliability.
Definition: types.h:411
#define SPEEDIFYSDK_MAX_PROXY_PORTS
Maximum number of ports returned.
Definition: sdkdefines.h:60
Connecting.
Definition: types.h:258
uint16_t minor
Minor version.
Definition: types.h:52
const char * SpeedifySDK_ServerInformation_toString(SpeedifySDK_ServerInformation server)
String representation of a SpeedifySDK_ServerInformation.
Definition: types.h:1304
Definition: types.h:1310
Cellular.
Definition: types.h:278
SpeedifySDK_ProxyMatchMode matchMode
How matches are handled.
Definition: types.h:1027
Transitional state as system automatically connects us to speed server.
Definition: types.h:79
Daemon stopped cleanly.
Definition: types.h:1211
Disconnected.
Definition: types.h:255
const char * SpeedifySDK_ServerInformationDetailed_toString(SpeedifySDK_ServerInformationDetailed server)
String representation of a SpeedifySDK_ServerInformationDetailed.
Tunnel timeout.
Definition: types.h:1217
Used while running a speed test. Internal only. Can not be set.
Definition: types.h:314
double maxDownloadSpeed
maximum download speed this period, megabits per second
Definition: types.h:777
An issue with the account being used.
Definition: types.h:928
uint32_t period
period the time period this stat covers, in hours, SPEEDIFYSDK_STAT_PERIOD_CURRENT for current,...
Definition: types.h:762
A grouping of ConnectionStats.
Definition: types.h:665
Ethernet.
Definition: types.h:275
Network related error.
Definition: types.h:916
SpeedifySDK_PortProtocol
Protocol for ports.
Definition: types.h:442
Speedify settings.
Definition: types.h:478
const char * SpeedifySDK_ConnectionState_toString(SpeedifySDK_ConnectionState state)
String representation of a SpeedifySDK_ConnectionState.
double averageDownloadSpeed
Average download speed of this stream, in megabits per second.
Definition: types.h:1150
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:346
int32_t num
Server number. Each specific server in an area is given a number unique to that region,...
Definition: types.h:143
bool perConnectionEncryptionEnabled
If per-connection encryption is being used.
Definition: types.h:507
uint64_t totalRedundantModeSaves
Total number of saves while in redundant mode.
Definition: types.h:748
uint64_t totalSpeedModeSaves
Total number of saves while in speed mode.
Definition: types.h:745
Info.
Definition: types.h:1247
uint16_t publicIPCount
How many public IPs are in the list.
Definition: types.h:169
Definition: types.h:1305
double maxUploadSpeed
maximum upload speed this period, megabits per second
Definition: types.h:780
Speedtest connection information.
Definition: types.h:870
int32_t filesPerDaemon
Number of log files allowed per SDK service instance.
Definition: types.h:1271
Definition: types.h:1317
bool isPrivate
Whether this is a private or public server.
Definition: types.h:163
SpeedifySDK_TransportMode
Transport Protocol modes.
Definition: types.h:422
int32_t num
Chosen server number, if connectMethod is ACM_COUNTRYCITYSERVER.
Definition: types.h:400
int64_t receiveBps
bytes per second received through this tunnel.
Definition: types.h:648
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:700
SpeedifySDK_BondingMode
Mode of the VPN tunnel.
Definition: types.h:405
SpeedifySDK_ConnectionPriority priority
Priority of connections over this adapter.
Definition: types.h:370
const char * SpeedifySDK_SpeedTestStatus_toString(SpeedifySDK_SpeedTestStatus status)
String representation of a SpeedifySDK_SpeedTestStatus.
Never use this connection.
Definition: types.h:317
SpeedifySDK_IPAddressString localIp
internet facing ip address of the adapter.
Definition: types.h:604
int64_t encryptedBytesSent
encrypted bytes sent this period
Definition: types.h:774
Unknown reason.
Definition: types.h:1184
Device reboot.
Definition: types.h:1193
Free/unpaid.
Definition: types.h:203
const char * SpeedifySDK_ServerInformation_GetCountryName(SpeedifySDK_ServerInformation server)
String representation of a SpeedifySDK_ServerInformation's country.
SpeedifySDK_AccountPaymentType paymentType
Payment status of this account.
Definition: types.h:241
Test not running or complete.
Definition: types.h:853
SpeedifySDK_BondingMode bondingMode
The current bonding mode.
Definition: types.h:492
#define SPEEDIFYSDK_MAX_FIREWALL_DOMAINS
Maximum number of domains returned.
Definition: sdkdefines.h:63
bool enabled
If the local proxy should be enabled.
Definition: types.h:1024
Bluetooth.
Definition: types.h:287
int32_t totalFiles
Total number of daemon log files to keep over all SDK service instances.
Definition: types.h:1277
int64_t bytesAvailable
Bytes allowed per data period (typically a month) for this account. -1 for unlimited.
Definition: types.h:226
int64_t usageMonthlyResetDay
Day of the month to reset monthly usage on. 0 for last 30 days.
Definition: types.h:337
uint64_t droppedIncoming
Number of incoming packets dropped.
Definition: types.h:703
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:536
No error.
Definition: types.h:913
int64_t retransBytes
bytes retransmitted this period
Definition: types.h:792
uint16_t port
Port number.
Definition: types.h:993
double stepProgress
Progress of current test step.
Definition: types.h:881
int64_t bytesUsed
Bytes used this data period (typically a month) for this account.
Definition: types.h:229
bool enableEsni
If ESNI is enabled for this domain.
Definition: types.h:1295
Domains and IP Addresses matched are sent over the VPN, all others are sent over the proxy @since 10....
Definition: types.h:978
Use this connection if others are unavailable.
Definition: types.h:311
uint16_t domainWatchlistItemsCount
Number of watchlist items.
Definition: types.h:1050
Transitional state as we log in.
Definition: types.h:73
#define SPEEDIFYSDK_MAX_DNS_COUNT
Maximum number of DNS addresses to configure.
Definition: sdkdefines.h:48
bool enableDefaultRoute
Whether the default route goes over the VPN tunnel.
Definition: types.h:522
Information about a network adapter.
Definition: types.h:352
uint64_t bufferWaits
Number of buffer full waits.
Definition: types.h:694
double rttMs
Tested rount trip time, milliseconds.
Definition: types.h:884
const char * SpeedifySDK_ConnectionPriority_toString(SpeedifySDK_ConnectionPriority priority)
String representation of a SpeedifySDK_ConnectionPriority.
Server that supports P2P/BitTorrent.
Definition: types.h:117
Definition: types.h:1316
int64_t encryptedBytesReceived
encrypted bytes received this period
Definition: types.h:771
double uploadSpeed
Current upload speed of this stream, in megabits per second.
Definition: types.h:1141
Test not running or cancelled.
Definition: types.h:836
uint16_t major
Major version.
Definition: types.h:49
#define SPEEDIFYSDK_MAX_WATCHLIST_ITEMS
Maximum number of domain watchlist items.
Definition: sdkdefines.h:72
Combine for speed.
Definition: types.h:408
SpeedifySDK_SpeedTestStatus status
Status of the test.
Definition: types.h:898
Intelligently choose between available protocols.
Definition: types.h:431
uint16_t domainsCount
Number of domains.
Definition: types.h:1030
uint64_t packetsIn
Number of packets going into packethandler (upload)
Definition: types.h:711
User initiated.
Definition: types.h:1205
#define SPEEDIFYSDK_MAX_EMAIL
Email length.
Definition: sdkdefines.h:30
uint64_t bytesIn
Number of bytes going into packethandler (upload)
Definition: types.h:717
uint64_t packetsIn
Number of packets read from TUN.
Definition: types.h:682
uint16_t port
Port number.
Definition: types.h:462
SpeedifySDK_SpeedTestStep
Test step over a connection.
Definition: types.h:850
uint64_t speedModeSaves
Number of saves while in speed mode.
Definition: types.h:1156
SpeedifySDK_DisconnectReason disconnectReason
Reason for the disconnect.
Definition: types.h:1235
#define SPEEDIFYSDK_MAX_WATCHLIST_TITLE
Maximum title length of domain watchlist item.
Definition: sdkdefines.h:75
Error opening or configuring the VPN adapter.
Definition: types.h:937
bool startupConnect
If Speedify will automatically connect when the daemon starts.
Definition: types.h:495
This account has been cut off, usually for quota issues.
Definition: types.h:91
A forwarded port.
Definition: types.h:456
Automatic server selection method settings.
Definition: types.h:388
Directory settings.
Definition: types.h:1289
Last server connected to.
Definition: types.h:114
Closest private server to user.
Definition: types.h:108
const char * SpeedifySDK_NetworkType_toString(SpeedifySDK_NetworkType type)
String representation of a SpeedifySDK_NetworkType.
const char * SpeedifySDK_ServerInformation_GetCityName(SpeedifySDK_ServerInformation server)
String representation of a SpeedifySDK_ServerInformation's city.
#define SPEEDIFYSDK_MAX_DIRECTORY_DOMAIN
Length of directory server domain.
Definition: sdkdefines.h:42
#define SPEEDIFYSDK_MAX_STREAMS
Maximum number of streams returns in a stats result.
Definition: sdkdefines.h:81
Transitional state as we connect to speed server.
Definition: types.h:82
bool isAutoAccount
If this account is an automatically generated account.
Definition: types.h:223
Closest public or private server to user.
Definition: types.h:105
bool connected
is connected
Definition: types.h:587
SpeedifySDK_NetworkType
Type of network adapter.
Definition: types.h:269
Fail open error.
Definition: types.h:1309
uint16_t bugfix
Bugfix version.
Definition: types.h:55
bool enabled
If the domains in this watchlist should be added to the local proxy filter.
Definition: types.h:1004
Completely disconnected and unathenticated. Need to login() to do anything.
Definition: types.h:70
double uploadBps
Tested upload speed, bytes per second.
Definition: types.h:890
int64_t usageDailyBoost
Extra Bytes allowed over this adapter today. This value resets to 0 every day.
Definition: types.h:343
VPN.
Definition: types.h:281
int64_t inFlight
bytes currently in flight
Definition: types.h:579
SpeedifySDK_ConnectionPriority
How a connection should be combined.
Definition: types.h:298
uint16_t ipv6Count
Number of IPv6 addresses.
Definition: types.h:1106
double mbpsUpBenefit
extra upload bandwidth acheived this period
Definition: types.h:804
Always use this connection.
Definition: types.h:303
uint64_t totalStreams
Total number of streams seen.
Definition: types.h:751
Setting locked by server configuration.
Definition: types.h:961
Streaming mode stats.
Definition: types.h:1165
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:498
SpeedifySDK_IPAddressString privateIp
local ip address of the adapter.
Definition: types.h:623
int64_t usageDailyLimit
Bytes allowed over this adapter in a single day. 0 for unlimited.
Definition: types.h:340
Transitional state as we disconnect from speed server.
Definition: types.h:85
SpeedifySDK_IPAddressString ip
IP address of the speedify daemon to connect to.
Definition: types.h:38
uint16_t ipv4Count
Number of IPv4 addresses.
Definition: types.h:1099
SpeedifySDK_ErrorType
Type classification for errors.
Definition: types.h:910
SpeedifySDK_ProxyMatchMode
How local proxy treats matches.
Definition: types.h:972
int64_t rateLimit
Speed limit, in bits per second. Or zero if unlimited.
Definition: types.h:379
int64_t periodStartTime
start time of this period, in seconds since epoch
Definition: types.h:795
int64_t usageDaily
Bytes used over this adapter today.
Definition: types.h:331
SpeedifySDK_TransportMode protocol
protocol used for the tunnel.
Definition: types.h:629
uint64_t startTime
Time this stream started, seconds since epoch.
Definition: types.h:1138
const char * SpeedifySDK_ErrorType_toString(SpeedifySDK_ErrorType error)
String representation of a SpeedifySDK_ErrorType.
#define SPEEDIFYSDK_MAX_STREAM_NAME_LEN
Maximum length of SpeedifySDK_StreamStats name field.
Definition: sdkdefines.h:84
SpeedifySDK_LogLevel logLevel
Minimim logging level to allow.
Definition: types.h:1283
A proxied port.
Definition: types.h:987
const char * SpeedifySDK_State_toString(SpeedifySDK_State state)
String representation of a SpeedifySDK_State.
Domains and IP Addresses matched are sent over the proxy, all others are sent over the VPN @since 10....
Definition: types.h:975
SpeedifySDK_LogLevel
Log levels in the SDK.
Definition: types.h:1241
int num
Server number. Each specific server in an area is given a number unique to that region,...
Definition: types.h:160
const char * SpeedifySDK_SpeedTestStep_toString(SpeedifySDK_SpeedTestStep step)
String representation of a SpeedifySDK_SpeedTestStep.
double receiveEstimateMbps
estimated maximum megabytes per second received.
Definition: types.h:660
Firewall is disabled.
Definition: types.h:1062
A forwarded port.
Definition: types.h:1076
Optimize for streaming.
Definition: types.h:414
const char * SpeedifySDK_BondingMode_toString(SpeedifySDK_BondingMode priority)
String representation of a SpeedifySDK_BondingMode.
bool jumboPackets
Whether to allow jumbo packets over the VPN tunnel.
Definition: types.h:481
uint16_t count
how many connections are in this group
Definition: types.h:671
Matches are allowed through the VPN, all others are dropped @since 10.2.
Definition: types.h:1065
SpeedifySDK_ConnectionState
State of Speedify on a given connection (network adapter).
Definition: types.h:252
uint16_t build
Build number.
Definition: types.h:58
#define SPEEDIFYSDK_MAX_COUNTRY_LEN
Country id length.
Definition: sdkdefines.h:21
Too many requests are being made by this device.
Definition: types.h:931
Verbose.
Definition: types.h:1244
uint16_t portsCount
Number of ports.
Definition: types.h:1113
uint64_t groupId
Group ID number of this stream.
Definition: types.h:1135
uint8_t periodCount
Number of stat periods.
Definition: types.h:825
const char * SpeedifySDK_LogLevel_toString(SpeedifySDK_LogLevel level)
uint64_t duration
Time, in seconds, this stream has been active.
Definition: types.h:1129
Timeout initializing the connection.
Definition: types.h:1214
Definition: types.h:1311
SpeedifySDK_PortProtocol protocol
Transport layer protocol.
Definition: types.h:990
uint64_t totalFailoverSaves
Total number of saves from a failover.
Definition: types.h:742
Statistics for sessions over various time periods.
Definition: types.h:822
#define SPEEDIFYSDK_MAX_FORWARD_PORTS
Forwarded ports supported.
Definition: sdkdefines.h:36
uint64_t bytesOut
Number of bytes written to TUN.
Definition: types.h:691
The provided OAUTH token is expired.
Definition: types.h:934
SpeedifySDK_FirewallMode
How firewall treats matches.
Definition: types.h:1059
uint64_t packetsOut
Number of packets leaving packethandler (download)
Definition: types.h:714
int64_t lossReceive
receive loss ratio (0.0-1.0)
Definition: types.h:609
No network connectivity.
Definition: types.h:1187
SpeedifySDK_SpeedTestStep step
Step currently being tested over this connection.
Definition: types.h:878
Connect by automatic connection method.
Definition: types.h:120
const char * SpeedifySDK_PortProtocol_toString(SpeedifySDK_PortProtocol portProto)
String representation of a SpeedifySDK_PortProtocol.
const char * SpeedifySDK_AccountPaymentType_toString(SpeedifySDK_AccountPaymentType paymentType)
String representation of a SpeedifySDK_AccountPaymentType.
const char * SpeedifySDK_DisconnectReason_toString(SpeedifySDK_DisconnectReason reason)
int32_t fileSize
Size of individual daemon log files, in bytes.
Definition: types.h:1265
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:708
A callback is required for this call.
Definition: types.h:952
Test running.
Definition: types.h:839
SpeedifySDK_AutoConnectMethod connectMethod
Type of automatic selection used.
Definition: types.h:391
SpeedifySDK_PortProtocol protocol
Transport layer protocol.
Definition: types.h:459
Local-proxy only connection.
Definition: types.h:126
Use this connection if others are full.
Definition: types.h:308
#define SPEEDIFYSDK_MAX_PROXY_IPS
Maximum number of IPs returned.
Definition: sdkdefines.h:57
Unable to connect to the local Speedify daemon.
Definition: types.h:94
SpeedifySDK_HandlerStats handlerStats
Contains stats regarding the packet handler this period.
Definition: types.h:810
SDK creation settings structure.
Definition: types.h:35
double averageUploadSpeed
Average upload speed of this stream, in megabits per second.
Definition: types.h:1147
Invalid credentials.
Definition: types.h:922
Privacy settings.
Definition: types.h:531
int64_t numSessions
total number of sessions this period
Definition: types.h:789
bool dnsleak
If DNS Leak protection is enabled.
Definition: types.h:541
Fully authenticated, but not using a speed server. Ready to connect()
Definition: types.h:76
Adapter setting for per-connection encryption.
Definition: types.h:467
uint16_t proxiedDomainsCount
Number of proxied domains.
Definition: types.h:1013
uint16_t portsCount
Number of ports.
Definition: types.h:1043
Closest public server to user.
Definition: types.h:111
Statistics for a period.
Definition: types.h:759
#define SPEEDIFYSDK_MAX_DOMAIN_LENGTH
Maximum length of domain to proxy.
Definition: sdkdefines.h:51
uint16_t port
Port number of the speedify daemon to connect to.
Definition: types.h:41
SpeedifySDK_BondingMode bondingMode
Bonding mode in use.
Definition: types.h:1168
uint16_t count
Number of connection results in this report.
Definition: types.h:901
SpeedifySDK_State
State of the VPN.
Definition: types.h:67
SpeedifySDK_ConnectionState state
State of the connection over this adapter.
Definition: types.h:364
int64_t inFlightWindow
inflight window, bytes
Definition: types.h:584
int64_t totalConnectedMinutes
minutes connected, this period
Definition: types.h:798
int64_t numFailovers
connection failovers this period
Definition: types.h:786
By specific country/city/server.
Definition: types.h:123
Definition: types.h:1315
bool ipleak
If IP Leak protection is enabled.
Definition: types.h:546
Contains stats regarding the captive portal.
Definition: types.h:728
Version structure.
Definition: types.h:46
bool isTeam
If this user is a teams member.
Definition: types.h:232
int64_t latencyMs
latency, milliseconds
Definition: types.h:617
uint16_t ipv4Count
Number of IPv4 addresses.
Definition: types.h:1036
#define SPEEDIFYSDK_MAX_WATCHLIST_DOMAINS
Maximum number of domains in a watchlist item.
Definition: sdkdefines.h:78
Information about a disconnect event.
Definition: types.h:1232
Contains session stats regarding streaming mode.
Definition: types.h:739
#define SPEEDIFYSDK_MAX_IP_STRING_LENGTH
IP string length.
Definition: sdkdefines.h:39
Result is an async call SDK. Not an error.
Definition: types.h:940
double downloadBps
Tested download speed, bytes per second.
Definition: types.h:887
char SpeedifySDK_DomainString[SPEEDIFYSDK_MAX_DOMAIN_LENGTH]
String representation of an IP address.
Definition: types.h:30
Really connected to a speed server.
Definition: types.h:88
SpeedifySDK_CaptivePortalStats captivePortalStats
Contains stats regarding captive portals this period.
Definition: types.h:813
Download.
Definition: types.h:859
Speedtest results.
Definition: types.h:895
int64_t sendBps
bytes per second sent through this tunnel.
Definition: types.h:643
Wi-Fi.
Definition: types.h:272
Device sleep.
Definition: types.h:1202
uint64_t id
ID number of this stream.
Definition: types.h:1132
Information about a server.
Definition: types.h:134
uint32_t streamsCount
Number of streams in this result.
Definition: types.h:1171
uint64_t uniqueSaves
Unique streams saved.
Definition: types.h:754
Airplane mode activated, or no networks available.
Definition: types.h:1190
#define SPEEDIFYSDK_MAX_FIREWALL_IPS
Maximum number of IPs returned.
Definition: sdkdefines.h:66
int32_t daysSinceFirst
days since first connection
Definition: types.h:783
Detailed information about a server.
Definition: types.h:151
#define SPEEDIFYSDK_MAX_IP_COUNT
Maximum number of IPs on a server.
Definition: sdkdefines.h:45
Always use UDP.
Definition: types.h:428
Definition: types.h:1313
#define SPEEDIFYSDK_MAX_STATS_PERIODS
Maximum number of stat periods requested.
Definition: sdkdefines.h:90
Round trip time.
Definition: types.h:856
bool headerCompression
Whether header compression is enabled.
Definition: types.h:525
SpeedifySDK_PortProtocol protocol
Transport layer protocol.
Definition: types.h:1079
int32_t minutesAvailable
Minutes allowed per data period (typically a month) for this account. -1 for unlimited.
Definition: types.h:235
Local proxy domain watchlist item.
Definition: types.h:998
int64_t usageMonthly
Bytes used over this adapter in current month period.
Definition: types.h:328
uint16_t portsCount
Number of configured ports to forward.
Definition: types.h:501
Platform does not support this call.
Definition: types.h:955
uint64_t detections
Captive portal detections.
Definition: types.h:731
uint64_t bytesIn
Number of bytes read from TUN.
Definition: types.h:688
double downloadSpeed
Current download speed of this stream, in megabits per second.
Definition: types.h:1144
int64_t lossSend
send loss ratio (0.0-1.0)
Definition: types.h:614
uint64_t redundantModeSaves
Number of saves while in redundant mode.
Definition: types.h:1153
uint64_t successes
Successful captive portal logins.
Definition: types.h:734
VPN tunnel blocked.
Definition: types.h:1226
bool allowChaChaEncryption
Whether the use of ChaCha is allowed for connection encryption.
Definition: types.h:489
double mbpsDownBenefit
extra download bandwidth acheived this period
Definition: types.h:801
An error occurred on the server.
Definition: types.h:919
Automatic disconnect from torrent activity.
Definition: types.h:1208
int64_t usageMonthlyLimit
Bytes allowed over this adapter in current month period. 0 for unlimited.
Definition: types.h:334
Warning.
Definition: types.h:1250
Information about the data usage and limits of a network adapter.
Definition: types.h:325
Matches are dropped, all others are allowed through the VPN @since 10.2.
Definition: types.h:1068
SpeedifySDK_StreamingSessionStats streamingStats
Contains stats regarding streaming mode this period.
Definition: types.h:816
bool doNotStoreCredentials
If credentials, including oauth tokens and passwords, are not stored locally.
Definition: types.h:565
Settings for logging in the daemon.
Definition: types.h:1259
Daemon crash.
Definition: types.h:1199
bool isPrivate
Whether this is a private or public server.
Definition: types.h:146
SpeedifySDK_TunStats tunStats
Contains stats regarding the TUN this period.
Definition: types.h:807
uint16_t port
Port number.
Definition: types.h:1082
bool active
If this stream is currently active.
Definition: types.h:1126
#define SPEEDIFYSDK_MAX_ADAPTERS
Simultaneous adapters supported.
Definition: sdkdefines.h:15
uint64_t retries
Number of packets retries.
Definition: types.h:723
Directory list was empty.
Definition: types.h:925
bool encrypted
If encryption is eanbled.
Definition: types.h:473
No connection to the Speedify daemon.
Definition: types.h:958
Loopback.
Definition: types.h:284
SpeedifySDK_SpeedTestStatus
Status of a speedtest.
Definition: types.h:833
bool packetAggregation
Whether packet aggregation is enabled.
Definition: types.h:519
SpeedifySDK_IPAddressString remoteIp
internet facing up address of the tunnel.
Definition: types.h:635
char SpeedifySDK_IPAddressString[SPEEDIFYSDK_MAX_IP_STRING_LENGTH]
String representation of an IP address.
Definition: types.h:25