Speedify SDK for Desktop  11.1.1
results.h
Go to the documentation of this file.
1 // Copyright 2019, Connectify, Inc. All Rights Reserved
2 
3 #ifndef SPEEDIFYSDK_RESULTS
4 #define SPEEDIFYSDK_RESULTS
5 
6 #include "sdkdefines.h"
7 #include "types.h"
8 #include <stdbool.h>
9 
18 
21 typedef uint64_t SpeedifySDK_EventID;
22 
25 #define SpeedifySDK_BaseResult_Header \
26  \
27 bool isError;\
28  \
29 SpeedifySDK_ErrorType errorCode;\
30  \
33 char errorMessage[SPEEDIFYSDK_MAX_ERROR_STRING];\
34  \
35 SpeedifySDK_EventID eventId;
36 
37 
40 SpeedifySDK_EXTERN typedef struct {
41  SpeedifySDK_BaseResult_Header
43 
46 SpeedifySDK_EXTERN typedef struct {
47  SpeedifySDK_BaseResult_Header
52 
55 SpeedifySDK_EXTERN typedef struct {
56  SpeedifySDK_BaseResult_Header
61 
64 SpeedifySDK_EXTERN typedef struct {
65  SpeedifySDK_BaseResult_Header
70 
73 SpeedifySDK_EXTERN typedef struct {
74  SpeedifySDK_BaseResult_Header
77  uint32_t count;
82 
85 SpeedifySDK_EXTERN typedef struct {
86  SpeedifySDK_BaseResult_Header
93 #define SpeedifySDK_DirectoryDomainResult SpeedifySDK_DirectorySettingsResult
94 
97 SpeedifySDK_EXTERN typedef struct {
98  SpeedifySDK_BaseResult_Header
103 
106 SpeedifySDK_EXTERN typedef struct {
107  SpeedifySDK_BaseResult_Header
110  uint32_t count;
115 
116 
119 SpeedifySDK_EXTERN typedef struct {
120  SpeedifySDK_BaseResult_Header
125 
128 SpeedifySDK_EXTERN typedef struct {
129  SpeedifySDK_BaseResult_Header
134 
137 SpeedifySDK_EXTERN typedef struct {
138  SpeedifySDK_BaseResult_Header
143 
146 SpeedifySDK_EXTERN typedef struct {
147  SpeedifySDK_BaseResult_Header
152 
155 SpeedifySDK_EXTERN typedef struct {
156  SpeedifySDK_BaseResult_Header
161 
162 
165 SpeedifySDK_EXTERN typedef struct {
166  SpeedifySDK_BaseResult_Header
174 
177 SpeedifySDK_EXTERN typedef struct {
178  SpeedifySDK_BaseResult_Header
189 
192 SpeedifySDK_EXTERN typedef struct {
193  SpeedifySDK_BaseResult_Header
198 SpeedifySDK_EXTERN typedef struct {
199  SpeedifySDK_BaseResult_Header
201 
204 SpeedifySDK_EXTERN typedef struct {
205  SpeedifySDK_BaseResult_Header
207 
210 SpeedifySDK_EXTERN typedef struct {
211  SpeedifySDK_BaseResult_Header
214 
217 SpeedifySDK_EXTERN typedef struct {
218  SpeedifySDK_BaseResult_Header
221  uint32_t count;
226 
229 SpeedifySDK_EXTERN typedef struct {
230  SpeedifySDK_BaseResult_Header
233  bool enabled;
238 
241 SpeedifySDK_EXTERN typedef struct {
242  SpeedifySDK_BaseResult_Header
247 
250 SpeedifySDK_EXTERN typedef struct {
251  SpeedifySDK_BaseResult_Header
256  const char* settingsJson;
258 
261 SpeedifySDK_EXTERN typedef struct {
262  SpeedifySDK_BaseResult_Header
267  const char* userData;
269 
272 SpeedifySDK_EXTERN typedef struct {
273  SpeedifySDK_BaseResult_Header
278 
281 SpeedifySDK_EXTERN typedef struct {
282  SpeedifySDK_BaseResult_Header
287 
290 SpeedifySDK_EXTERN typedef struct {
291  SpeedifySDK_BaseResult_Header
296 
297 
300 SpeedifySDK_EXTERN typedef struct {
301  SpeedifySDK_BaseResult_Header
306 
309 #define SpeedifySDK_SafeBro_Error_Header \
310  \
311 bool sbError;\
312  \
313 SpeedifySDK_SafeBrowsingError sbErrorCode;\
314  \
315 char sbErrorMessage[SPEEDIFYSDK_MAX_ERROR_STRING];
316 
319 SpeedifySDK_EXTERN typedef struct {
320  SpeedifySDK_BaseResult_Header
323 
324 
327 SpeedifySDK_EXTERN typedef struct {
328  SpeedifySDK_BaseResult_Header
335  bool configSet;
338  bool enabled;
346 
349 SpeedifySDK_EXTERN typedef struct {
350  SpeedifySDK_BaseResult_Header
353  uint32_t minTime;
356  uint32_t maxTime;
359  uint32_t avgTime;
362  uint32_t numErrors;
365  uint32_t numBlocks;
368  double failureRate;
375  uint64_t numLookups;
380 
383 SpeedifySDK_EXTERN typedef struct {
384  SpeedifySDK_BaseResult_Header
390 
393 SpeedifySDK_EXTERN typedef struct {
394  SpeedifySDK_BaseResult_Header
402 
405 SpeedifySDK_EXTERN typedef struct {
406  SpeedifySDK_BaseResult_Header
411 
414 SpeedifySDK_EXTERN typedef struct {
415  SpeedifySDK_BaseResult_Header
420 
423 SpeedifySDK_EXTERN typedef struct {
424  SpeedifySDK_BaseResult_Header
427  uint16_t resultsCount;
434 #endif
uint64_t SpeedifySDK_EventID
Callback ID type.
Definition: results.h:21
Account create result.
Definition: results.h:198
SpeedifySDK_DisconnectEvent lastDisconnectEvent
The last disconnect event.
Definition: results.h:409
SpeedifySDK_NetworkType type
Type of the new adapter.
Definition: results.h:172
Settings for the local proxy.
Definition: types.h:969
Password change result.
Definition: results.h:204
#define SPEEDIFYSDK_MAX_ADAPTER_NAME
Adapter name length.
Definition: sdkdefines.h:35
Speed test result.
Definition: results.h:423
Adapters result.
Definition: results.h:106
bool accountExists
Definition: results.h:194
SpeedifySDK_ConnectionStatsGroup connectionStats
A group of connection stats.
Definition: results.h:150
Data on an account.
Definition: types.h:219
SpeedifySDK_SessionStatPeriods sessionStats
Session stats.
Definition: results.h:159
Accounting result.
Definition: results.h:97
Session Stats result.
Definition: results.h:155
Log file settings result.
Definition: results.h:414
double failureRate
The lookup failure rate.
Definition: results.h:368
bool willDisconnect
Definition: results.h:212
SpeedifySDK_LocalProxySettings localProxySettings
Local proxy settings.
Definition: results.h:245
Firewall settings.
Definition: types.h:1064
SpeedifySDK_State state
Current state.
Definition: results.h:50
#define SpeedifySDK_SafeBro_Error_Header
Common header fields of Safe Browsing results.
Definition: results.h:309
uint32_t count
Number of networks with detected captive portals.
Definition: results.h:221
uint64_t numLookups
The number of completed requests to the safe browsing server.
Definition: results.h:375
Captive portal check result.
Definition: results.h:217
Firewall settings result.
Definition: results.h:272
Basic result.
Definition: results.h:40
Connection result.
Definition: results.h:64
Connection Stats result.
Definition: results.h:146
SpeedifySDK_DirectorySettings directorySettings
Current directory settings.
Definition: results.h:89
SpeedifySDK_StreamingSettings streamingSettings
Streaming settings.
Definition: results.h:285
SpeedifySDK_AccountingData accounting
Information on the account.
Definition: results.h:101
A grouping of ConnectionStats.
Definition: types.h:697
uint16_t resultsCount
How many results are in the list.
Definition: results.h:427
Speedify settings.
Definition: types.h:495
Safe Browsing Stats.
Definition: results.h:349
Directory settings result.
Definition: results.h:85
SpeedifySDK_DaemonLogSettings daemon
Daemon log file settings.
Definition: results.h:418
Local proxy settings result.
Definition: results.h:241
uint32_t numErrors
The number of safe browsing errors.
Definition: results.h:362
Captive portal login mode result.
Definition: results.h:229
SpeedifySDK_NetworkType type
Type of the new adapter.
Definition: results.h:184
Safe Browsing error.
Definition: results.h:383
SpeedifySDK_Settings settings
Settings.
Definition: results.h:132
#define SPEEDIFYSDK_MAX_SERVERS
Servers supported.
Definition: sdkdefines.h:20
Information about a network adapter.
Definition: types.h:351
uint64_t numPacketsFiltered
The number of safe browsing filtered packets.
Definition: results.h:378
uint32_t numBlocks
The number of safe browsing blocks.
Definition: results.h:365
Privacy Settings result.
Definition: results.h:137
uint32_t minTime
The fastest lookup time (ms)
Definition: results.h:353
Local proxy domain watchlist hit result.
Definition: results.h:290
Safe Browsing block.
Definition: results.h:393
SpeedifySDK_SafeBrowsingLogLevel
Log levels in the SDK.
Definition: types.h:1345
uint32_t maxTime
The slowest lookup time (ms)
Definition: results.h:356
Directory result.
Definition: results.h:73
#define SPEEDIFYSDK_MAX_WATCHLIST_TITLE
Maximum title length of domain watchlist item.
Definition: sdkdefines.h:77
SpeedifySDK_AdapterUsageData usageData
Current usage on the adapter.
Definition: results.h:187
Automatic server selection method settings.
Definition: types.h:387
Directory settings.
Definition: types.h:1272
Streaming stats result.
Definition: results.h:300
uint32_t numBlockResponses
The number of server responses requesting the SDK block or redirect the connection.
Definition: results.h:372
const char * userData
Settings json as a string.
Definition: results.h:267
SpeedifySDK_StreamingStats streamingStats
Streaming stats.
Definition: results.h:304
SpeedifySDK_NetworkType
Type of network adapter.
Definition: types.h:271
SpeedifySDK_SafeBrowsingSafeNetworkOverride
Override safe network decisions.
Definition: types.h:1354
Server Settings result.
Definition: results.h:119
SpeedifySDK_ServerInformationDetailed connectedServer
Connected server.
Definition: results.h:68
Streaming mode stats.
Definition: types.h:1142
uint32_t avgTime
The average lookup time (ms)
Definition: results.h:359
Disconnect event result.
Definition: results.h:405
Torrent detection result.
Definition: results.h:210
bool configSet
If the additional config is set.
Definition: results.h:335
State result.
Definition: results.h:46
Statistics for sessions over various time periods.
Definition: types.h:854
Safe Browsing result.
Definition: results.h:327
uint32_t count
Number of adapters.
Definition: results.h:110
Vendor settings result.
Definition: results.h:250
New Adapter result.
Definition: results.h:165
Safe Browsing error on initialization.
Definition: results.h:319
Privacy settings.
Definition: types.h:557
uint32_t count
Number of servers.
Definition: results.h:77
SpeedifySDK_FirewallSettings firewallSettings
Firewall settings.
Definition: results.h:276
SpeedifySDK_State
State of the VPN.
Definition: types.h:69
bool enabled
If the captive portal login mode is enabled.
Definition: results.h:233
Adapter Overlimit result.
Definition: results.h:177
Version structure.
Definition: types.h:48
const char * settingsJson
Settings json as a string.
Definition: results.h:256
bool enabled
If Safe Browsing is enabled.
Definition: results.h:338
Version result.
Definition: results.h:55
Streaming settings result.
Definition: results.h:281
SpeedifySDK_SafeBrowsingLogLevel logLevel
The Safe Browsing logging level.
Definition: results.h:341
Information about a disconnect event.
Definition: types.h:1215
Vendor user data result.
Definition: results.h:261
SpeedifySDK_ServerSettings serverSettings
Settings.
Definition: results.h:123
SpeedifySDK_SafeBro_Error_Header bool initialized
If Safe Browsing is initialized.
Definition: results.h:332
Settings for the priority streaming.
Definition: types.h:1011
Information about a server.
Definition: types.h:136
Results of a speed test.
Definition: types.h:1364
SpeedifySDK_PrivacySettings privacySettings
Privacy settings.
Definition: results.h:141
Detailed information about a server.
Definition: types.h:153
bool redirected
If the connection was redirected to a warning page vs blocked.
Definition: results.h:397
SpeedifySDK_SafeBrowsingSafeNetworkOverride snOverride
Safe Network decision override.
Definition: results.h:344
SpeedifySDK_Version version
Definition: results.h:59
#define SPEEDIFYSDK_MAX_HOST_LEN
Maximum length of SpeedifySDK_SafeBrowsingErrorResult host field.
Definition: sdkdefines.h:89
Account check result.
Definition: results.h:192
Settings result.
Definition: results.h:128
Information about the data usage and limits of a network adapter.
Definition: types.h:324
Settings for logging in the daemon.
Definition: types.h:1242
#define SPEEDIFYSDK_MAX_SPEED_TEST_RESULTS
Maximum speed test results returned.
Definition: sdkdefines.h:122
#define SPEEDIFYSDK_MAX_ADAPTERS
Simultaneous adapters supported.
Definition: sdkdefines.h:17