Speedify SDK for Desktop/Embedded 15.8.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
41
42
59
62SpeedifySDK_EXTERN typedef struct {
65 uint16_t major;
68 uint16_t minor;
71 uint16_t bugfix;
74 uint16_t build;
78SpeedifySDK_EXPORT const char* SpeedifySDK_Version_toString(SpeedifySDK_Version state);
79
80
114SpeedifySDK_EXPORT const char* SpeedifySDK_State_toString(SpeedifySDK_State state);
115
153
154
200
210
223
224
225
242
262
266#define AA_ACTIVATE_OR_PURCHASE_LICENCE AA_ACTIVATE_OR_PURCHASE_LICENSE
267
271
306
307
326
361
388
391SpeedifySDK_EXTERN typedef struct {
397 int64_t usageDaily;
414
428/* \brief String representation of a SpeedifySDK_ConnectionDirectionalMode
429 * @since 14.8.7 */
431
442
499
500
517
533SpeedifySDK_EXPORT const char* SpeedifySDK_BondingMode_toString(SpeedifySDK_BondingMode priority);
534
562SpeedifySDK_EXPORT const char* SpeedifySDK_TransportMode_toString(SpeedifySDK_TransportMode priority);
563
579SpeedifySDK_EXPORT const char* SpeedifySDK_PortProtocol_toString(SpeedifySDK_PortProtocol portProto);
580
583SpeedifySDK_EXTERN typedef struct {
589 uint16_t port;
592 uint16_t portRangeEnd;
594
598
599
602SpeedifySDK_EXTERN typedef struct {
610
613SpeedifySDK_EXTERN typedef struct {
621
624SpeedifySDK_EXTERN typedef struct {
632
635SpeedifySDK_EXTERN typedef struct {
641 uint16_t sockets;
643
646SpeedifySDK_EXTERN typedef struct {
649 int32_t upload;
652 int32_t download;
654
756
760
806
943
946SpeedifySDK_EXTERN typedef struct {
949 uint64_t time;
952 uint16_t count;
957
960SpeedifySDK_EXTERN typedef struct {
963 uint64_t packetsIn;
966 uint64_t packetsOut;
969 uint64_t bytesIn;
972 uint64_t bytesOut;
975 uint64_t bufferWaits;
978 uint64_t packetWaits;
981 uint64_t readQueue;
986
989SpeedifySDK_EXTERN typedef struct {
992 uint64_t packetsIn;
995 uint64_t packetsOut;
998 uint64_t bytesIn;
1001 uint64_t bytesOut;
1004 uint64_t retries;
1006
1009SpeedifySDK_EXTERN typedef struct {
1012 uint64_t detections;
1015 uint64_t successes;
1017
1020SpeedifySDK_EXTERN typedef struct {
1035 uint64_t uniqueSaves;
1037
1040SpeedifySDK_EXTERN typedef struct {
1043 uint8_t dscp;
1049 uint64_t bytesSent;
1052 double sendBps;
1069
1080
1146
1157
1158
1236SpeedifySDK_EXPORT const char* SpeedifySDK_ErrorType_toString(SpeedifySDK_ErrorType error);
1237
1240SpeedifySDK_EXTERN typedef enum {
1250SpeedifySDK_EXPORT const char* SpeedifySDK_ProxyMatchMode_toString(SpeedifySDK_ProxyMatchMode matchMode);
1251
1255
1278
1325
1326
1330
1362
1378SpeedifySDK_EXPORT const char* SpeedifySDK_FirewallMode_toString(SpeedifySDK_FirewallMode matchMode);
1379
1383
1418
1419
1422SpeedifySDK_EXTERN typedef enum {
1433 SH_GOOD
1438
1501
1502
1532
1533
1534
1594
1609
1610
1627SpeedifySDK_EXPORT const char* SpeedifySDK_LogLevel_toString(SpeedifySDK_LogLevel level);
1628
1631SpeedifySDK_EXTERN typedef struct {
1637 int32_t fileSize;
1649 int32_t totalFiles;
1657
1658
1661SpeedifySDK_EXTERN typedef struct {
1673
1676SpeedifySDK_EXTERN typedef enum {
1727
1735SpeedifySDK_EXPORT const char*
1737
1740SpeedifySDK_EXTERN typedef enum {
1744
1748
1795
1805
1808SpeedifySDK_EXTERN typedef enum {
1819
1833
1837
1851
1855
1885
1899
1903
1938
1942
1945SpeedifySDK_EXTERN typedef struct {
1948 uint64_t bytesToday;
1957 uint64_t bytesTotal;
1959
1960
1977
2006
2007
2023SpeedifySDK_EXPORT const char* SpeedifySDK_DSCPReplication_toString(SpeedifySDK_DSCPReplication replication);
2024
2040SpeedifySDK_EXPORT const char* SpeedifySDK_DSCPPriority_toString(SpeedifySDK_DSCPPriority priority);
2041
2058
2069
#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_DATE_TIME_LENGTH
Maximum length of the date and time string.
Definition sdkdefines.h:179
#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:274
SpeedifySDK_AccountAction action
If any actions should be taken on this account.
Definition types.h:304
SpeedifySDK_AccountPaymentType paymentType
Payment status of this account.
Definition types.h:298
int64_t bytesAvailable
Bytes allowed per data period (typically a month) for this account. -1 for unlimited.
Definition types.h:283
int32_t minutesAvailable
Minutes allowed per data period (typically a month) for this account. -1 for unlimited.
Definition types.h:292
int64_t bytesUsed
Bytes used this data period (typically a month) for this account.
Definition types.h:286
bool isAutoAccount
If this account is an automatically generated account.
Definition types.h:280
int32_t minutesUsed
Minutes used this data period (typically a month) for this account.
Definition types.h:295
bool isTeam
If this user is a teams member.
Definition types.h:289
Information about a network adapter.
Definition types.h:446
SpeedifySDK_ConnectionState state
State of the connection over this adapter.
Definition types.h:458
int64_t rateLimitUploadBps
Upload speed limit, in bits per second. Or zero if unlimited.
Definition types.h:480
int64_t rateLimitDownloadBps
Download speed limit, in bits per second. Or zero if unlimited.
Definition types.h:477
int64_t rateLimit
Upload speed limit, in bits per second. Or zero if unlimited. This is provided for backwards compatib...
Definition types.h:474
SpeedifySDK_NetworkType type
Type of the adapter.
Definition types.h:461
SpeedifySDK_AdapterUsageData dataUsage
Data usage and limit information for this adapter.
Definition types.h:483
SpeedifySDK_ConnectionPriority workingPriority
Effective priority of connections over this adapter.
Definition types.h:486
SpeedifySDK_ConnectionDirectionalSettings directionalSettings
Connection direction settings.
Definition types.h:497
SpeedifySDK_ConnectionPriority priority
Priority of connections over this adapter.
Definition types.h:464
cJSON ** ispStats
JSON object containing ISP data, if available The cJSON is valid until the next AdapterData update is...
Definition types.h:494
Information about the data usage and limits of a network adapter.
Definition types.h:391
int64_t usageMonthlyResetDay
Day of the month to reset monthly usage on. 0 for last 30 days.
Definition types.h:403
int64_t usageDaily
Bytes used over this adapter today.
Definition types.h:397
int64_t usageMonthly
Bytes used over this adapter in current month period.
Definition types.h:394
int64_t usageDailyBoost
Extra Bytes allowed over this adapter today. This value resets to 0 every day.
Definition types.h:409
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:412
int64_t usageMonthlyLimit
Bytes allowed over this adapter in current month period. 0 for unlimited.
Definition types.h:400
int64_t usageDailyLimit
Bytes allowed over this adapter in a single day. 0 for unlimited.
Definition types.h:406
Contains stats regarding the captive portal.
Definition types.h:1009
uint64_t successes
Successful captive portal logins.
Definition types.h:1015
uint64_t detections
Captive portal detections.
Definition types.h:1012
Directional settings for a connection.
Definition types.h:434
SpeedifySDK_ConnectionDirectionalMode upload
Upload mode.
Definition types.h:437
SpeedifySDK_ConnectionDirectionalMode download
Download mode.
Definition types.h:440
A grouping of ConnectionStats.
Definition types.h:946
uint16_t count
how many connections are in this group
Definition types.h:952
uint64_t time
timestamp of the connection stats
Definition types.h:949
Statistics about a connection.
Definition types.h:813
uint32_t numberOfSockets
Number of active sockets for this connection.
Definition types.h:873
int64_t totalBps
bits per second through this tunnel
Definition types.h:882
bool uploadCongested
True if the connection is congested in the upload direction.
Definition types.h:936
int64_t inFlight
bytes currently in flight
Definition types.h:818
double lossReceive
receive loss ratio (0.0-1.0)
Definition types.h:848
uint64_t sendBytes
bytes sent
Definition types.h:921
float mos
Mean Opinion Score, 1-5.
Definition types.h:916
double sendEstimateMbps
estimated maximum megabits per second send.
Definition types.h:898
bool connected
is connected
Definition types.h:826
SpeedifySDK_IPAddressString remoteIp
internet facing ip address of the tunnel.
Definition types.h:879
bool sleeping
is sleeping. Used on Cellular connections to improve battery life.
Definition types.h:829
bool congested
True if the connection is upload or download congested.
Definition types.h:931
uint64_t receiveBytes
bytes received
Definition types.h:926
int64_t inFlightWindow
inflight window, bytes
Definition types.h:823
SpeedifySDK_IPAddressString localIp
internet facing ip address of the adapter.
Definition types.h:843
SpeedifySDK_IPAddressString privateIp
local ip address of the adapter.
Definition types.h:862
int64_t latencyMs
latency, milliseconds
Definition types.h:856
int32_t jitterMs
Jitter, in milliseconds.
Definition types.h:910
double receiveEstimateMbps
estimated maximum megabits per second received.
Definition types.h:904
int64_t sendBps
bits per second sent through this tunnel.
Definition types.h:887
double lossSend
send loss ratio (0.0-1.0)
Definition types.h:853
int64_t receiveBps
bits per second received through this tunnel.
Definition types.h:892
bool downloadCongested
True if the connection is congested in the download direction.
Definition types.h:941
SpeedifySDK_TransportMode protocol
protocol used for the tunnel.
Definition types.h:867
SDK creation settings structure.
Definition types.h:45
SpeedifySDK_IPAddressString ip
IP address of the speedify daemon to connect to.
Definition types.h:51
uint16_t port
Port number of the speedify daemon to connect to.
Definition types.h:54
SpeedifySDK_AppNameString name
Name of the SDK app, used for auto accounts.
Definition types.h:48
DSCP queue configuration.
Definition types.h:2044
SpeedifySDK_DSCPReplication replication
DSCP replication setting.
Definition types.h:2053
uint8_t dscpValue
DSCP value.
Definition types.h:2047
SpeedifySDK_DSCPPriority priority
DSCP priority setting.
Definition types.h:2050
uint8_t retransmissionAttempts
Maximum number of retransmission attempts.
Definition types.h:2056
DSCP settings.
Definition types.h:2061
uint8_t numDscpQueues
The number of DSCP queue configurations.
Definition types.h:2064
Settings for logging in the daemon.
Definition types.h:1631
int32_t fileSize
Size of individual daemon log files, in bytes.
Definition types.h:1637
int32_t totalFiles
Total number of daemon log files to keep over all SDK service instances.
Definition types.h:1649
SpeedifySDK_LogLevel logLevel
Minimim logging level to allow.
Definition types.h:1655
int32_t filesPerDaemon
Number of log files allowed per SDK service instance.
Definition types.h:1643
Directory settings.
Definition types.h:1661
bool enableEsni
If ESNI is enabled for this domain.
Definition types.h:1668
Information about a disconnect event.
Definition types.h:1597
SpeedifySDK_DisconnectReason disconnectReason
Reason for the disconnect.
Definition types.h:1600
int64_t sessionEnd
Time of the disconnect, in seconds since epoch. If 0, there has been no disconnect event to report....
Definition types.h:1604
int64_t sessionLength
Length of the session in seconds.
Definition types.h:1607
Array of DSCP queue stats.
Definition types.h:1072
uint16_t count
the number of dscp queues
Definition types.h:1075
Contains stats for a defined DSCP queue.
Definition types.h:1040
uint64_t bytesSent
bytes sent through this queue
Definition types.h:1049
uint64_t transportBytesReceived
bytes received through this queue on transport connections, includes retransmissions and redundancy
Definition types.h:1058
uint64_t bytesReceived
bytes received through this queue
Definition types.h:1046
uint64_t transportBytesSent
bytes sent through this queue on transport connections, includes retransmissions and redundancy
Definition types.h:1061
double receiveBps
bits per second received through this queue
Definition types.h:1055
uint8_t dscp
dscp value for this queue
Definition types.h:1043
double sendBps
bits per second sent through this queue.
Definition types.h:1052
double transportSendBps
bits per second sent through this queue on transport connections, includes retransmissions and redund...
Definition types.h:1064
double transportReceiveBps
bits per second received through this queue on transport connections, includes retransmissions and re...
Definition types.h:1067
Firewall settings.
Definition types.h:1386
SpeedifySDK_FirewallMode mode
How matches are handled.
Definition types.h:1389
uint16_t portsCount
Number of ports.
Definition types.h:1412
uint16_t ipv4Count
Number of IPv4 addresses.
Definition types.h:1398
uint16_t domainsCount
Number of domains.
Definition types.h:1392
uint16_t ipv6Count
Number of IPv6 addresses.
Definition types.h:1405
Contains stats regarding the packet handler, for use in session stats.
Definition types.h:989
uint64_t bytesIn
Number of bytes going into packethandler (upload)
Definition types.h:998
uint64_t retries
Number of packets retries.
Definition types.h:1004
uint64_t bytesOut
Number of bytes leaving packethandler (download)
Definition types.h:1001
uint64_t packetsOut
Number of packets leaving packethandler (download)
Definition types.h:995
uint64_t packetsIn
Number of packets going into packethandler (upload)
Definition types.h:992
Local proxy domain watchlist item.
Definition types.h:1258
uint16_t proxiedDomainsCount
Number of proxied domains.
Definition types.h:1273
bool enabled
If the domains in this watchlist should be added to the local proxy filter.
Definition types.h:1264
uint16_t watchedDomainsCount
Number of watched domains.
Definition types.h:1267
Settings for the local proxy.
Definition types.h:1281
uint16_t portsCount
Number of ports.
Definition types.h:1313
bool domainWatchlistEnabled
Boolean to turn domain watchlist enablement on or off.
Definition types.h:1287
SpeedifySDK_ProxyMatchMode matchMode
How matches are handled.
Definition types.h:1290
bool enabled
If the local proxy should be enabled.
Definition types.h:1284
uint16_t domainsCount
Number of domains.
Definition types.h:1293
uint16_t ipv4Count
Number of IPv4 addresses.
Definition types.h:1299
uint16_t ipv6Count
Number of IPv6 addresses.
Definition types.h:1306
uint16_t domainWatchlistItemsCount
Number of watchlist items.
Definition types.h:1320
Represents a network share peer.
Definition types.h:1980
SpeedifySDK_NetworkSharingDisplayName appName
The application name for this peer.
Definition types.h:1998
bool haveAuthToken
If we have exchanged an auth token with the peer.
Definition types.h:1989
bool autoReconnect
If its peer will be automatically reconnected one seen on the network.
Definition types.h:1986
bool supportsHost
If this peer supports being a host.
Definition types.h:1992
SpeedifySDK_NetworkSharingDisplayName displayName
The public display name for this peer.
Definition types.h:1995
SpeedifySDK_NetworkSharingConnection peerAsHost
Status of the connection to the host peer.
Definition types.h:2004
SpeedifySDK_NetworkSharingConnection peerAsClient
Status of the connection to the client peer.
Definition types.h:2001
SpeedifySDK_NetworkSharingPeerUuid uuid
UUID of the peer.
Definition types.h:1983
Network sharing connection.
Definition types.h:1963
SpeedifySDK_NetworkSharingUsage usage
usage over this connection
Definition types.h:1975
SpeedifySDK_NetworkSharingTunnelStatus tunnelStatus
status of the tunnel connection with this peer
Definition types.h:1969
SpeedifySDK_NetworkSharingPeerStatus peerStatus
status of this pure connection
Definition types.h:1966
bool allowed
If this connection is allowed.
Definition types.h:1972
Network sharing settings.
Definition types.h:1858
SpeedifySDK_NetworkSharingPairRequestBehavior pairRequestBehavior
How pair requests are handled.
Definition types.h:1873
bool alwaysOnDiscovery
If discovery is always active.
Definition types.h:1880
bool sameUserAutoPair
If devices from the same user are automatically paired.
Definition types.h:1876
bool clientEnabled
if network sharing client is enabled
Definition types.h:1861
SpeedifySDK_NetworkSharingConnectCode hostConnectCode
json data used for clients to manually connect to this host
Definition types.h:1867
SpeedifySDK_NetworkSharingDisplayName displayName
The public display name for this device.
Definition types.h:1870
SpeedifySDK_NetworkSharingAutoPairBehavior autoPairBehavior
If devices from the same user and/or team are automatically paired.
Definition types.h:1883
bool hostEnabled
if network sharing host is enabled
Definition types.h:1864
Network sharing usage data.
Definition types.h:1945
uint64_t bytesLastMonth
bytes used this month
Definition types.h:1954
uint64_t bytesToday
bytes used today
Definition types.h:1948
uint64_t bytesLastWeek
bytes used this week
Definition types.h:1951
uint64_t bytesTotal
bytes used total
Definition types.h:1957
Adapter setting for per-connection encryption.
Definition types.h:613
bool encrypted
If encryption is enabled.
Definition types.h:619
Adapter setting for per-connection expose DSCP.
Definition types.h:624
bool exposed
If DSCP is exposed.
Definition types.h:630
Adapter setting for per-connection parallel sockets.
Definition types.h:635
uint16_t sockets
Number of parallel sockets.
Definition types.h:641
Privacy settings.
Definition types.h:763
bool ipLeakProtection
If IP Leak protection is enabled.
Definition types.h:778
bool doNotStoreCredentials
If credentials, including oauth tokens and passwords, are not stored locally.
Definition types.h:791
bool advancedIspStats
If advanced ISP stats are enabled.
Definition types.h:804
uint16_t dnsAddressCount
Number of configured dns addresses to forward to.
Definition types.h:782
bool killswitch
If Internet Killswitch is enabled.
Definition types.h:768
bool apiProtection
if API protection is enabled
Definition types.h:800
bool requestToDisableDoH
Whether DoH is requested to be disabled.
Definition types.h:796
bool dnsLeakProtection
If DNS Leak protection is enabled.
Definition types.h:773
A protocol/port pair.
Definition types.h:583
uint16_t portRangeEnd
End of port range. If this entry is a single port, then this is 0.
Definition types.h:592
uint16_t port
Port number, or 0 for any port.
Definition types.h:589
SpeedifySDK_PortProtocol protocol
Transport layer protocol.
Definition types.h:586
Detailed information about a server.
Definition types.h:157
uint16_t publicIPCount
How many public IPs are in the list. Only available on connected server calls.
Definition types.h:179
uint16_t dnsIPCount
How many DNS IPs are in the list. Only available on connected server calls.
Definition types.h:187
int num
Server number. Each specific server in an area is given a number unique to that region,...
Definition types.h:166
bool isPremium
Whether this is a premium-only server.
Definition types.h:172
bool torrentAllowed
Whether this server allows bittorrent/P2P.
Definition types.h:175
bool isPrivate
Whether this is a private or public server.
Definition types.h:169
Automatic server selection method settings.
Definition types.h:503
SpeedifySDK_AutoConnectMethod connectMethod
Type of automatic selection used.
Definition types.h:506
int32_t num
Chosen server number, if connectMethod is ACM_COUNTRYCITYSERVER or ACM_EXACT.
Definition types.h:515
Statistics for sessions over various time periods.
Definition types.h:1149
uint8_t periodCount
Number of stat periods.
Definition types.h:1152
Statistics for a period.
Definition types.h:1083
int64_t bytesReceived
bytes received this period
Definition types.h:1089
int64_t encryptedBytesReceived
encrypted bytes received this period
Definition types.h:1095
SpeedifySDK_DscpStatsArray dscpStats
Contains stats for DSCP queues this period.
Definition types.h:1143
double mbpsDownBenefit
extra download bandwidth acheived this period, in megabits per second
Definition types.h:1125
int32_t daysSinceFirst
days since first connection
Definition types.h:1107
SpeedifySDK_HandlerStats handlerStats
Contains stats regarding the packet handler this period.
Definition types.h:1134
int64_t numFailovers
connection failovers this period
Definition types.h:1110
double maxUploadSpeed
maximum upload speed this period, megabits per second
Definition types.h:1104
SpeedifySDK_TunStats tunStats
Contains stats regarding the TUN this period.
Definition types.h:1131
int64_t bytesSent
bytes sent this period
Definition types.h:1092
int64_t totalConnectedMinutes
minutes connected, this period
Definition types.h:1122
int64_t retransBytes
bytes retransmitted this period
Definition types.h:1116
int64_t periodStartTime
start time of this period, in seconds since epoch
Definition types.h:1119
uint32_t period
period the time period this stat covers, in hours, SPEEDIFYSDK_STAT_PERIOD_CURRENT for current,...
Definition types.h:1086
SpeedifySDK_CaptivePortalStats captivePortalStats
Contains stats regarding captive portals this period.
Definition types.h:1137
SpeedifySDK_StreamingSessionStats streamingStats
Contains stats regarding streaming mode this period.
Definition types.h:1140
double mbpsUpBenefit
extra upload bandwidth acheived this period, in megabits per second
Definition types.h:1128
double maxDownloadSpeed
maximum download speed this period, megabits per second
Definition types.h:1101
int64_t encryptedBytesSent
encrypted bytes sent this period
Definition types.h:1098
int64_t numSessions
total number of sessions this period
Definition types.h:1113
Speedify settings.
Definition types.h:657
bool perConnectionEncryptionEnabled
If per-connection encryption is being used.
Definition types.h:692
double overflowThreshold
Overflow threshold, in megabits per second.
Definition types.h:715
uint32_t maximumTransportRetry
maximum time between transport connection retries, in seconds
Definition types.h:745
bool headerCompression
Whether header compression is enabled.
Definition types.h:727
uint16_t perConnectionExposeDscpCount
Number of configured per-connection expose DSCP settings. Only supported on Linux.
Definition types.h:702
uint16_t downstreamSubnetsCount
Number of configured downstream subnets.
Definition types.h:686
SpeedifySDK_TargetNumberOfConnections targetNumberOfConnections
The target number of connections for the VPN tunnel.
Definition types.h:751
bool encrypted
Whether all connections will be enabled.
Definition types.h:665
uint32_t maxRedundant
The maximum number of connections used to send redundant packets.
Definition types.h:739
bool enableAutomaticPriority
If automatic connection priorites are enabled.
Definition types.h:733
bool enableDefaultRoute
Whether the default route goes over the VPN tunnel.
Definition types.h:724
bool allowChaChaEncryption
Whether the use of ChaCha is allowed for connection encryption.
Definition types.h:668
uint16_t portsCount
Number of configured ports to forward.
Definition types.h:680
bool startupConnect
If Speedify will automatically connect when the daemon starts.
Definition types.h:674
uint32_t fixedDelay
The delay in ms applied in each direction to select flows.
Definition types.h:754
bool packetAggregation
Whether packet aggregation is enabled.
Definition types.h:721
unsigned long ulpReportIntervalSeconds
Represents the ULP reporting interval in seconds.
Definition types.h:736
SpeedifySDK_TransportMode transportMode
Currently used connection transport mode selection.
Definition types.h:677
uint16_t perConnectionParallelSocketsCount
Number of configured per-connection parallel socket settings.
Definition types.h:709
uint32_t maximumConnectRetry
maximum time between login/connect retries, in seconds
Definition types.h:742
double priorityOverflowThreshold
Priority overflow threshold, in megabits per second.
Definition types.h:718
bool jumboPackets
Whether to allow jumbo packets over the VPN tunnel.
Definition types.h:660
SpeedifySDK_BondingMode bondingMode
The current bonding mode.
Definition types.h:671
uint16_t perConnectionEncryptionCount
Number of configured per-connection encryption settings.
Definition types.h:695
Results of a speed test.
Definition types.h:1751
uint16_t jitter
jitter during test in ms, only valid for streaming tests
Definition types.h:1787
int64_t testTime
time of the test, in seconds since epoch
Definition types.h:1754
double downloadSpeed
tested download speed, bits per second
Definition types.h:1766
bool isError
is this test errored
Definition types.h:1772
uint16_t numConnections
How many connections were used during this test.
Definition types.h:1763
uint16_t fps
supported streaming frames per second (fps), only valid for streaming tests
Definition types.h:1784
double uploadSpeed
tested upload speed, bits per second
Definition types.h:1769
uint16_t latency
baseline latency in ms
Definition types.h:1790
double loss
packet loss percent during test, only valid for streaming tests
Definition types.h:1793
SpeedifySDK_SpeedTestType testType
type of test
Definition types.h:1778
Statistics for a single stream.
Definition types.h:1441
double averageDownloadSpeed
Average download speed of this stream, in megabits per second.
Definition types.h:1468
uint8_t dscp
The dscp tag of this stream.
Definition types.h:1499
SpeedifySDK_HostnameString hostname
The hostname of the service that this stream is connected to.
Definition types.h:1496
uint64_t duration
Time, in seconds, this stream has been active.
Definition types.h:1447
SpeedifySDK_StreamHealth health
Stream health.
Definition types.h:1483
uint64_t groupId
Group ID number of this stream.
Definition types.h:1453
uint64_t speedModeSaves
Number of saves while in speed mode.
Definition types.h:1474
uint64_t startTime
Time this stream started, seconds since epoch.
Definition types.h:1456
uint64_t failoverSaves
Definition types.h:1477
uint16_t remotePort
The remote port that this stream is connected to.
Definition types.h:1489
bool active
If this stream is currently active.
Definition types.h:1444
SpeedifySDK_IPAddressString remoteIp
The remote ip that this stream is connected to.
Definition types.h:1486
double downloadSpeed
Current download speed of this stream, in megabits per second.
Definition types.h:1462
double averageUploadSpeed
Average upload speed of this stream, in megabits per second.
Definition types.h:1465
uint64_t id
ID number of this stream.
Definition types.h:1450
uint64_t redundantModeSaves
Number of saves while in redundant mode.
Definition types.h:1471
double uploadSpeed
Current upload speed of this stream, in megabits per second.
Definition types.h:1459
Contains session stats regarding streaming mode.
Definition types.h:1020
uint64_t uniqueSaves
Unique streams saved.
Definition types.h:1035
uint64_t totalStreams
Total number of streams seen.
Definition types.h:1032
uint64_t totalFailoverSaves
Total number of saves from a failover.
Definition types.h:1023
uint64_t totalRedundantModeSaves
Total number of saves while in redundant mode.
Definition types.h:1029
uint64_t totalSpeedModeSaves
Total number of saves while in speed mode.
Definition types.h:1026
Settings for the priority streaming.
Definition types.h:1333
uint16_t ipv4Count
Number of IPv4 addresses.
Definition types.h:1342
uint16_t ipv6Count
Number of IPv6 addresses.
Definition types.h:1349
uint16_t portsCount
Number of ports.
Definition types.h:1356
uint16_t domainsCount
Number of domains.
Definition types.h:1336
Streaming mode stats.
Definition types.h:1505
bool badMemory
Indicator of high memory usage on the system, greater than 90%. Only tracked while active streams are...
Definition types.h:1530
SpeedifySDK_BondingMode bondingMode
Bonding mode in use.
Definition types.h:1508
bool badLoss
Indicator of high loss, greater than 3%. Only tracked while active streams are running.
Definition types.h:1518
bool badCpu
Indicator of high CPU usage on the system, greater than 90%. Only tracked while active streams are ru...
Definition types.h:1526
uint32_t streamsCount
Number of streams in this result.
Definition types.h:1511
bool badLatency
Indicator of high latency, greater than 300ms. Only tracked while active streams are running.
Definition types.h:1522
A subnet.
Definition types.h:602
SpeedifySDK_IPAddressString address
IP address.
Definition types.h:605
uint8_t prefixLength
network prefix length
Definition types.h:608
Target number of connections for the VPN tunnel.
Definition types.h:646
int32_t upload
Target number of connections for upload.
Definition types.h:649
int32_t download
Target number of connections for download.
Definition types.h:652
Contains stats regarding the TUN, for use in session stats.
Definition types.h:960
uint64_t packetsIn
Number of packets read from TUN.
Definition types.h:963
uint64_t packetsOut
Number of packets written to TUN.
Definition types.h:966
uint64_t bufferWaits
Number of buffer full waits.
Definition types.h:975
uint64_t readQueue
Size of the read queue.
Definition types.h:981
uint64_t bytesOut
Number of bytes written to TUN.
Definition types.h:972
uint64_t droppedIncoming
Number of incoming packets dropped.
Definition types.h:984
uint64_t bytesIn
Number of bytes read from TUN.
Definition types.h:969
uint64_t packetWaits
Number of packet pool waits.
Definition types.h:978
Version structure.
Definition types.h:62
uint16_t major
Major version.
Definition types.h:65
uint16_t build
Build number.
Definition types.h:74
uint16_t bugfix
Bugfix version.
Definition types.h:71
uint16_t minor
Minor version.
Definition types.h:68
SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair SpeedifySDK_StreamingPort
A streaming port.
Definition types.h:1329
ENABLE_NETWORK_SHARING const char * SpeedifySDK_NetworkSharingPeerRole_toString(SpeedifySDK_NetworkSharingPeerRole role)
SpeedifySDK_DisconnectReason
Reason for a disconnect.
Definition types.h:1537
@ DR_UPDATE
Software update.
Definition types.h:1552
@ DR_SETTINGCHANGERECONNECT
Automatic reconnect from setting change.
Definition types.h:1576
@ DR_CONNECTIVITY
No network connectivity.
Definition types.h:1543
@ DR_REBOOT
Device reboot.
Definition types.h:1549
@ DR_NONE
Nothing to report.
Definition types.h:1591
@ DR_TORRENT
Automatic disconnect from torrent activity.
Definition types.h:1564
@ DR_OVERQUOTA
Account out of data.
Definition types.h:1585
@ DR_UNKNOWN
Unknown reason.
Definition types.h:1540
@ DR_TUNNELTIMEOUT
VPN tunnel blocked.
Definition types.h:1582
@ DR_USERINITIATED
User initiated.
Definition types.h:1561
@ DR_SERVICESTOP
Daemon stopped cleanly.
Definition types.h:1567
@ DR_SAFENETWORK
On a safe network, determined by safe browsing.
Definition types.h:1588
@ DR_DNSTIMEOUT
DNS timeout.
Definition types.h:1579
@ DR_SLEEP
Device sleep.
Definition types.h:1558
@ DR_STARTTIMEOUT
Timeout initializing the connection.
Definition types.h:1570
@ DR_INACTIVETIMEOUT
Tunnel timeout.
Definition types.h:1573
@ DR_AIRPLANE
Airplane mode activated, or no networks available.
Definition types.h:1546
@ DR_CRASH
Daemon crash.
Definition types.h:1555
SpeedifySDK_TransportMode
Transport Protocol modes.
Definition types.h:537
@ TMODE_PROXY
Proxy-only. This is not valid for SpeedifySDK_SetConnectionTransportMode.
Definition types.h:555
@ TMODE_SHARE
shared traffic. This is not valid for SpeedifySDK_SetConnectionTransportMode.
Definition types.h:558
@ TMODE_AUTO
Intelligently choose between available protocols.
Definition types.h:546
@ TMODE_TCP
Always use TCP.
Definition types.h:540
@ TMODE_UDP
Always use UDP.
Definition types.h:543
@ TMODE_MULTITCP
Always use Multi TCP.
Definition types.h:552
@ TMODE_HTTPS
Always use websocket.
Definition types.h:549
SpeedifySDK_NetworkSharingPeerRole
peer role
Definition types.h:1808
@ PR_CLIENT
client
Definition types.h:1811
@ PR_HOST
host
Definition types.h:1814
SpeedifySDK_EXTERN typedef char SpeedifySDK_NetworkSharingDisplayName[SPEEDIFYSDK_MAX_NETWORKSHARING_DISPLAY_NAME_LENGTH]
The public display name for this device.
Definition types.h:1801
SpeedifySDK_EXTERN typedef char SpeedifySDK_HostnameString[SPEEDIFYSDK_MAX_HOSTNAME_LENGTH]
String representation of an IP address.
Definition types.h:759
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:329
@ NETWORKTYPE_ETHERNET
Ethernet.
Definition types.h:335
@ NETWORKTYPE_VPN
VPN.
Definition types.h:341
@ NETWORKTYPE_NETWORKSHARE_CLIENT
Network Share Client.
Definition types.h:350
@ NETWORKTYPE_BLUETOOTH
Bluetooth.
Definition types.h:347
@ NETWORKTYPE_LOOPBACK
Loopback.
Definition types.h:344
@ NETWORKTYPE_WIFI
Wi-Fi.
Definition types.h:332
@ NETWORKTYPE_CELLULAR
Cellular.
Definition types.h:338
@ NETWORKTYPE_UNKNOWN
Unknown.
Definition types.h:356
@ NETWORKTYPE_NETWORKSHARE_HOST
Network Share Host.
Definition types.h:353
ENABLE_NETWORK_SHARING const char * SpeedifySDK_ServerInformationDetailed_GetCountryName(SpeedifySDK_ServerInformationDetailed server)
SpeedifySDK_ErrorType
Type classification for errors.
Definition types.h:1161
@ ET_SDK_CALLBACK_REQUIRED
A callback is required for this call.
Definition types.h:1215
@ ET_SDK_ASYNC
Result is an async call SDK. Not an error.
Definition types.h:1203
@ ET_SDK_SETTING_LOCKED_TEAM
Setting locked by server configuration.
Definition types.h:1228
@ ET_VPN_ADAPTER
Error opening or configuring the VPN adapter.
Definition types.h:1188
@ ET_NETWORK
Network related error.
Definition types.h:1167
@ ET_RATELIMITED
Too many requests are being made by this device.
Definition types.h:1182
@ ET_SDK_TIMEOUT
Timeout waiting for result.
Definition types.h:1209
@ ET_CREDENTIAL
Invalid credentials.
Definition types.h:1173
@ ET_SDK_NO_CONNECTION
No connection to the Speedify daemon.
Definition types.h:1221
@ ET_DIRECTORY
Directory list was empty.
Definition types.h:1176
@ ET_SDK_PLATFORM_NO_SUPPORT
Platform does not support this call.
Definition types.h:1218
@ ET_SDK_SYNC_FROM_ASYNC
Synchronous call used from within asynchronous callback. Not supported.
Definition types.h:1224
@ ET_SDK_INVALID_ARGUMENT
An invalid argument was supplied.
Definition types.h:1212
@ ET_TOKEN_EXPIRED
The provided OAUTH token is expired.
Definition types.h:1185
@ ET_DEVICE_LIMIT
The device limit has been reached.
Definition types.h:1191
@ ET_LOCK_ACCOUNT
Setting locked by account configuration.
Definition types.h:1197
@ ET_INVALID_ARGUMENT
An invalid argument was supplied.
Definition types.h:1200
@ ET_SERVER
An error occurred on the server.
Definition types.h:1170
@ ET_OK
No error.
Definition types.h:1164
@ ET_ACCOUNT
An issue with the account being used.
Definition types.h:1179
@ ET_LOCK_TEAM
Setting locked by server configuration.
Definition types.h:1194
@ ET_SDK_ERROR
An error in the SDK.
Definition types.h:1206
@ ET_SDK_SETTING_LOCKED_ACCOUNT
Setting locked by account configuration.
Definition types.h:1232
SpeedifySDK_EXTERN typedef char SpeedifySDK_NetworkSharingConnectCode[SPEEDIFYSDK_MAX_NETWORKSHARING_CONNECT_CODE_LENGTH]
Connect code for network sharing.
Definition types.h:1798
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:1422
@ SH_STOPPED
Stream has stopped.
Definition types.h:1427
@ SH_POOR
Stream may be encountering errors.
Definition types.h:1430
@ SH_GOOD
Stream is in good health.
Definition types.h:1433
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:1888
@ NPS_AUTHENTICATED
connected and authenticated
Definition types.h:1897
@ NPS_UNAUTHENTICATED
connected, but not authenticated
Definition types.h:1894
@ NPS_DISCONNECTED
The connection is disconnected.
Definition types.h:1891
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:1730
@ SN_OVERRIDE_NONE
Definition types.h:1731
@ SN_OVERRIDE_UNSAFE
Definition types.h:1732
@ SN_OVERRIDE_SAFE
Definition types.h:1733
SpeedifySDK_TrafficRuleChangeMethod
Traffic rules change method.
Definition types.h:2072
@ TRAFFIC_RULE_REMOVE
Remove an existing traffic rule.
Definition types.h:2081
@ TRAFFIC_RULE_UPDATE
Update an existing traffic rule, or add a new one if it doesn't exist.
Definition types.h:2075
@ TRAFFIC_RULE_REPLACE
Replace an existing traffic rule, or add a new one if it doesn't exist.
Definition types.h:2078
ENABLE_NETWORK_SHARING const char * SpeedifySDK_LogLevel_toString(SpeedifySDK_LogLevel level)
SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair SpeedifySDK_ForwardedPort
A forwarded port.
Definition types.h:597
SpeedifySDK_AccountAction
Actions that should be taken on an account.
Definition types.h:245
@ AA_ACTIVATE
No saved credentials/not previously activated. Activate the account.
Definition types.h:257
@ AA_NONE
No action needed.
Definition types.h:248
@ AA_ACTIVATE_OR_PURCHASE_LICENSE
Current account does not have a license usable on this device. Activate or purchase a license.
Definition types.h:260
@ AA_RETRY_LOGIN
A (possibly temporary) error occurred. Retry login.
Definition types.h:251
@ AA_CONNECT_INTERNET_AND_RETRY_LOGIN
Connect to the internet and retry login.
Definition types.h:254
SpeedifySDK_BondingMode
Mode of the VPN tunnel.
Definition types.h:520
@ BMODE_SPEED
Combine for speed.
Definition types.h:523
@ BMODE_STREAMING
Optimize for streaming.
Definition types.h:529
@ BMODE_REDUNDANT
Combine for reliability.
Definition types.h:526
SpeedifySDK_EXTERN typedef SpeedifySDK_ProtocolPortPair SpeedifySDK_LocalProxyPort
A proxied port.
Definition types.h:1254
ENABLE_NETWORK_SHARING const char * SpeedifySDK_Version_toString(SpeedifySDK_Version state)
SpeedifySDK_PortProtocol
Protocol for ports.
Definition types.h:566
@ PPROTO_ICMP
ICMP.
Definition types.h:575
@ PPROTO_TCP
TCP.
Definition types.h:569
@ PPROTO_UDP
UDP.
Definition types.h:572
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:417
@ CDM_STRICT_OFF
Always off.
Definition types.h:423
@ CDM_BACKUP_OFF
Off when not needed.
Definition types.h:426
@ CDM_ON
Always on.
Definition types.h:420
SpeedifySDK_EXTERN typedef SpeedifySDK_ServerInformation SpeedifySDK_ServerInformationDetailed
Information about a.
Definition types.h:199
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:2010
@ DSCP_REPLICATION_ON
DSCP replication is on.
Definition types.h:2016
@ DSCP_REPLICATION_AUTO
Speedify stream mode behavior.
Definition types.h:2013
@ DSCP_REPLICATION_OFF
DSCP replication is off.
Definition types.h:2019
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:1840
@ APB_MANUAL
no automatic pairing
Definition types.h:1843
@ APB_AUTO_USER_TEAM
Automatically pair with devices from the same user and/or team.
Definition types.h:1849
@ APB_AUTO_USER
Automatically pair with devices from the same user.
Definition types.h:1846
SpeedifySDK_EXTERN typedef char SpeedifySDK_DateTimeString[SPEEDIFYSDK_MAX_DATE_TIME_LENGTH]
String representation of a date and time.
Definition types.h:40
ENABLE_NETWORK_SHARING const char * SpeedifySDK_AccountAction_toString(SpeedifySDK_AccountAction action)
SpeedifySDK_FirewallMode
How firewall treats matches.
Definition types.h:1365
@ FWM_DENYLIST
Matches are dropped, all others are allowed through the VPN.
Definition types.h:1374
@ FWM_ALLOWLIST
Matches are allowed through the VPN, all others are dropped.
Definition types.h:1371
@ FWM_OFF
Firewall is disabled.
Definition types.h:1368
ENABLE_NETWORK_SHARING const char * SpeedifySDK_SpeedTestType_toString(SpeedifySDK_SpeedTestType type)
SpeedifySDK_State
State of the VPN.
Definition types.h:83
@ STATE_CONNECTING
Transitional state as we connect to speed server.
Definition types.h:98
@ STATE_DISCONNECTING
Transitional state as we disconnect from speed server.
Definition types.h:101
@ STATE_AUTO_CONNECTING
Transitional state as system automatically connects us to speed server.
Definition types.h:95
@ STATE_LOGGED_IN
Fully authenticated, but not using a speed server. Ready to connect()
Definition types.h:92
@ STATE_CONNECTED
Really connected to a speed server.
Definition types.h:104
@ STATE_UNKNOWN
Unable to connect to the local Speedify daemon.
Definition types.h:110
@ STATE_LOGGED_OUT
Completely disconnected and unathenticated. Need to login() to do anything.
Definition types.h:86
@ STATE_LOGGING_IN
Transitional state as we log in.
Definition types.h:89
@ STATE_OVERLIMIT
All available adapters are overlimit, VPN still in connected state.
Definition types.h:107
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:364
@ CP_ALWAYS
Always use this connection.
Definition types.h:369
@ CP_BACKUP
Use this connection if others are unavailable.
Definition types.h:377
@ CP_AUTOMATIC
Let Speedify manage the priority.
Definition types.h:383
@ CP_NEVER
Never use this connection.
Definition types.h:380
@ CP_SECONDARY
Use this connection if others are full.
Definition types.h:374
SpeedifySDK_AutoConnectMethod
Methods for automatic server selection.
Definition types.h:118
@ ACM_CLOSEST
Closest public or private server to user.
Definition types.h:121
@ ACM_BYSETTING
Connect by automatic connection method.
Definition types.h:136
@ ACM_CLOSESTPRIVATE
Closest private server to user.
Definition types.h:124
@ ACM_P2P
Server that supports P2P/BitTorrent.
Definition types.h:133
@ ACM_PROXY
Local-proxy only connection.
Definition types.h:145
@ ACM_IGNORELAST
Connect using the current selection setting, but choose a different server instance than the one last...
Definition types.h:148
@ ACM_COUNTRYCITYSERVER
By specific country/city/server.
Definition types.h:139
@ ACM_CLOSESTPUBLIC
Closest public server to user.
Definition types.h:127
@ ACM_LAST
Last server connected to.
Definition types.h:130
@ ACM_EXACT
By exact specific country/city/server.
Definition types.h:142
SpeedifySDK_ConnectionState
State of Speedify on a given connection (network adapter).
Definition types.h:312
@ CSTATE_DISCONNECTED
Disconnected.
Definition types.h:315
@ CSTATE_CONNECTING
Connecting.
Definition types.h:318
@ CSTATE_CONNECTED
Connected.
Definition types.h:321
ENABLE_NETWORK_SHARING const char * SpeedifySDK_SafeBrowsing_LogLevel_toString(SpeedifySDK_SafeBrowsingLogLevel level)
SpeedifySDK_ProxyMatchMode
How local proxy treats matches.
Definition types.h:1240
@ PMM_DENYLIST
Domains and IP Addresses matched are sent over the VPN, all others are sent over the proxy.
Definition types.h:1246
@ PMM_ALLOWLIST
Domains and IP Addresses matched are sent over the proxy, all others are sent over the VPN.
Definition types.h:1243
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:1382
SpeedifySDK_SafeBrowsingLogLevel
Log levels in the SDK.
Definition types.h:1717
@ CUJO_LOG_DEBUG
Definition types.h:1718
@ CUJO_LOG_TRACE
Definition types.h:1722
@ CUJO_LOG_INFO
Definition types.h:1719
@ CUJO_LOG_WARNING
Definition types.h:1724
@ CUJO_LOG_ERROR
Definition types.h:1720
SpeedifySDK_SafeBrowsingError
Safe browsing errors.
Definition types.h:1676
@ CUJO_ERR_BAD_FUNCTION_ARGUMENT
Definition types.h:1690
@ CUJO_ERR_PARSE_ERROR
Definition types.h:1691
@ CUJO_ERR_NOT_CONFIGURED
Definition types.h:1680
@ CUJO_ERR_CURL_INIT_FAILURE
Definition types.h:1693
@ CUJO_ERR_CURL_EASY_INIT_FAILURE
Definition types.h:1695
@ CUJO_ERR_NO_ENDPOINT_URL
Definition types.h:1679
@ CUJO_ERR_CURL_HEADER_APPEND_FAILURE
Definition types.h:1697
@ CUJO_ERR_CURL
Definition types.h:1688
@ CUJO_ERR_TIMED_OUT
Fail open error.
Definition types.h:1683
@ CUJO_ERR_INTERRUPTED_EVENT_LOOP
Definition types.h:1711
@ CUJO_OK
Definition types.h:1677
@ CUJO_ERR_JSON_SET_FAILURE
Definition types.h:1699
@ CUJO_ERR_NO_MEMORY
Definition types.h:1689
@ CUJO_ERR_HTTP_STATUS
Definition types.h:1686
@ CUJO_ERR_ALREADY_IN_PROGRESS
Definition types.h:1703
@ CUJO_ERR_INVALID_NSP_TOKEN
Definition types.h:1705
@ CUJO_ERR_RETRIABLE_SERVER_ERROR
Definition types.h:1684
@ CUJO_ERR_ON_PROTECTED_NETWORK
Definition types.h:1707
@ CUJO_ERR_ASYNC_INIT_FAILURE
Definition types.h:1709
@ CUJO_ERR_UV_LOOP_INIT_FAILURE
Definition types.h:1701
ENABLE_NETWORK_SHARING const char * SpeedifySDK_DisconnectReason_toString(SpeedifySDK_DisconnectReason reason)
SpeedifySDK_SpeedTestType
Internal speed test types.
Definition types.h:1740
@ TEST_STREAMING
Definition types.h:1742
@ TEST_SPEED
Definition types.h:1741
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:1613
@ LL_INFO
Info.
Definition types.h:1619
@ LL_ERROR
Error.
Definition types.h:1625
@ LL_WARN
Warning.
Definition types.h:1622
@ LL_VERBOSE
Verbose.
Definition types.h:1616
SpeedifySDK_EXTERN typedef char SpeedifySDK_NetworkSharingPeerUuid[SPEEDIFYSDK_NETWORKSHARING_PEER_UUID_LENGTH]
Peer UUID for network sharing peer data.
Definition types.h:1804
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:2027
@ DSCP_PRIORITY_OFF
DSCP priority is off.
Definition types.h:2036
@ DSCP_PRIORITY_ON
DSCP priority is on.
Definition types.h:2033
@ DSCP_PRIORITY_AUTO
Speedify stream detection.
Definition types.h:2030
SpeedifySDK_NetworkSharingPairRequestBehavior
pair request behavior types
Definition types.h:1822
@ PRB_ACCEPT
automatically accept
Definition types.h:1828
@ PRB_ASK
always ask
Definition types.h:1825
@ PRB_REJECT
automatically reject
Definition types.h:1831
SpeedifySDK_NetworkSharingTunnelStatus
Status of a NetworkSharing tunnel.
Definition types.h:1906
@ NTS_ACTIVE
active tunnels
Definition types.h:1912
@ NTS_DISABLED_ON_CLIENT
disallowed on client
Definition types.h:1915
@ NTS_TUNNEL_ERROR
general error
Definition types.h:1924
@ NTS_DISABLED_ON_HOST
disallowed on host
Definition types.h:1918
@ NTS_VPN_NOT_CONNECTED
Host's VPN not connected.
Definition types.h:1933
@ NTS_PAUSED
Active but paused.
Definition types.h:1936
@ NTS_INACTIVE
No active tunnels.
Definition types.h:1909
@ NTS_NOT_AUTHENTICATED
not authenticated
Definition types.h:1927
@ NTS_NETWORKS_OVERLIMIT
All networks are over data limit.
Definition types.h:1930
@ NTS_NO_NETWORKS
no networks available
Definition types.h:1921
SpeedifySDK_AccountPaymentType
Information on an account's payment type.
Definition types.h:228
@ APT_FREE
Free/unpaid.
Definition types.h:231
@ APT_MONTHLY
Paid, monthly contract.
Definition types.h:234
@ APT_YEARLY
Paid, yearly contract.
Definition types.h:237