Speedify SDK for Desktop  14.8.0
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  \
31 char errorMessage[SPEEDIFYSDK_MAX_ERROR_STRING];\
32  \
33 SpeedifySDK_EventID eventId;
34 
35 
38 SpeedifySDK_EXTERN typedef struct {
39  SpeedifySDK_BaseResult_Header
41 
44 SpeedifySDK_EXTERN typedef struct {
45  SpeedifySDK_BaseResult_Header
50 
53 SpeedifySDK_EXTERN typedef struct {
54  SpeedifySDK_BaseResult_Header
59 
62 SpeedifySDK_EXTERN typedef struct {
63  SpeedifySDK_BaseResult_Header
68 
71 SpeedifySDK_EXTERN typedef struct {
72  SpeedifySDK_BaseResult_Header
75  uint32_t count;
80 
83 SpeedifySDK_EXTERN typedef struct {
84  SpeedifySDK_BaseResult_Header
89 
92 SpeedifySDK_EXTERN typedef struct {
93  SpeedifySDK_BaseResult_Header
98 
101 SpeedifySDK_EXTERN typedef struct {
102  SpeedifySDK_BaseResult_Header
105  uint32_t count;
110 
111 
114 SpeedifySDK_EXTERN typedef struct {
115  SpeedifySDK_BaseResult_Header
120 
123 SpeedifySDK_EXTERN typedef struct {
124  SpeedifySDK_BaseResult_Header
129 
132 SpeedifySDK_EXTERN typedef struct {
133  SpeedifySDK_BaseResult_Header
138 
141 SpeedifySDK_EXTERN typedef struct {
142  SpeedifySDK_BaseResult_Header
147 
150 SpeedifySDK_EXTERN typedef struct {
151  SpeedifySDK_BaseResult_Header
156 
157 
160 SpeedifySDK_EXTERN typedef struct {
161  SpeedifySDK_BaseResult_Header
169 
172 SpeedifySDK_EXTERN typedef struct {
173  SpeedifySDK_BaseResult_Header
184 
187 SpeedifySDK_EXTERN typedef struct {
188  SpeedifySDK_BaseResult_Header
193 SpeedifySDK_EXTERN typedef struct {
194  SpeedifySDK_BaseResult_Header
196 
199 SpeedifySDK_EXTERN typedef struct {
200  SpeedifySDK_BaseResult_Header
202 
205 SpeedifySDK_EXTERN typedef struct {
206  SpeedifySDK_BaseResult_Header
209 
212 SpeedifySDK_EXTERN typedef struct {
213  SpeedifySDK_BaseResult_Header
216  uint32_t count;
221 
224 SpeedifySDK_EXTERN typedef struct {
225  SpeedifySDK_BaseResult_Header
228  bool enabled;
233 
236 SpeedifySDK_EXTERN typedef struct {
237  SpeedifySDK_BaseResult_Header
242 
245 SpeedifySDK_EXTERN typedef struct {
246  SpeedifySDK_BaseResult_Header
251  const char* settingsJson;
253 
256 SpeedifySDK_EXTERN typedef struct {
257  SpeedifySDK_BaseResult_Header
262  const char* userData;
264 
267 SpeedifySDK_EXTERN typedef struct {
268  SpeedifySDK_BaseResult_Header
273 
276 SpeedifySDK_EXTERN typedef struct {
277  SpeedifySDK_BaseResult_Header
282 
285 SpeedifySDK_EXTERN typedef struct {
286  SpeedifySDK_BaseResult_Header
291 
292 
295 SpeedifySDK_EXTERN typedef struct {
296  SpeedifySDK_BaseResult_Header
301 
304 #define SpeedifySDK_SafeBro_Error_Header \
305  \
306 bool sbError;\
307  \
308 SpeedifySDK_SafeBrowsingError sbErrorCode;\
309  \
310 char sbErrorMessage[SPEEDIFYSDK_MAX_ERROR_STRING];
311 
314 SpeedifySDK_EXTERN typedef struct {
315  SpeedifySDK_BaseResult_Header
318 
319 
322 SpeedifySDK_EXTERN typedef struct {
323  SpeedifySDK_BaseResult_Header
330  bool configSet;
333  bool enabled;
341 
344 SpeedifySDK_EXTERN typedef struct {
345  SpeedifySDK_BaseResult_Header
348  uint32_t minTime;
351  uint32_t maxTime;
354  uint32_t avgTime;
357  uint32_t numErrors;
360  uint32_t numBlocks;
363  double failureRate;
370  uint64_t numLookups;
375 
378 SpeedifySDK_EXTERN typedef struct {
379  SpeedifySDK_BaseResult_Header
385 
388 SpeedifySDK_EXTERN typedef struct {
389  SpeedifySDK_BaseResult_Header
397 
400 SpeedifySDK_EXTERN typedef struct {
401  SpeedifySDK_BaseResult_Header
406 
409 SpeedifySDK_EXTERN typedef struct {
410  SpeedifySDK_BaseResult_Header
415 
418 SpeedifySDK_EXTERN typedef struct {
419  SpeedifySDK_BaseResult_Header
422  uint16_t resultsCount;
427 
430 SpeedifySDK_EXTERN typedef struct {
431  SpeedifySDK_BaseResult_Header
436 
439 SpeedifySDK_EXTERN typedef struct {
440  SpeedifySDK_BaseResult_Header
448 
452 SpeedifySDK_EXTERN typedef struct {
453  SpeedifySDK_BaseResult_Header
458 
463 SpeedifySDK_EXTERN typedef struct {
464  SpeedifySDK_BaseResult_Header
478 
481 SpeedifySDK_EXTERN typedef struct {
482  SpeedifySDK_BaseResult_Header
493 
494 
497 SpeedifySDK_EXTERN typedef struct {
498  SpeedifySDK_BaseResult_Header
506 
509 #endif
uint64_t SpeedifySDK_EventID
Callback ID type.
Definition: results.h:21
Account create result.
Definition: results.h:193
bool haveAuthToken
If we have exchanged an auth token with the peer.
Definition: results.h:491
SpeedifySDK_DisconnectEvent lastDisconnectEvent
The last disconnect event.
Definition: results.h:404
Network Sharing Discovery Result Indicates the result of a discovery request.
Definition: results.h:452
SpeedifySDK_NetworkSharingPeerRole
peer role
Definition: types.h:1629
SpeedifySDK_NetworkType type
Type of the new adapter.
Definition: results.h:167
Settings for the local proxy.
Definition: types.h:1105
Password change result.
Definition: results.h:199
#define SPEEDIFYSDK_MAX_ADAPTER_NAME
Adapter name length.
Definition: sdkdefines.h:35
Network sharing settings.
Definition: types.h:1679
Speed test result.
Definition: results.h:418
Adapters result.
Definition: results.h:101
bool accountExists
Definition: results.h:189
SpeedifySDK_NetworkSharingTunnelStatus
Status of a NetworkSharing tunnel.
Definition: types.h:1727
SpeedifySDK_ConnectionStatsGroup connectionStats
A group of connection stats.
Definition: results.h:145
Data on an account.
Definition: types.h:234
SpeedifySDK_SessionStatPeriods sessionStats
Session stats.
Definition: results.h:154
Accounting result.
Definition: results.h:92
Session Stats result.
Definition: results.h:150
Log file settings result.
Definition: results.h:409
double failureRate
The lookup failure rate.
Definition: results.h:363
bool willDisconnect
Definition: results.h:207
SpeedifySDK_LocalProxySettings localProxySettings
Local proxy settings.
Definition: results.h:240
Firewall settings.
Definition: types.h:1210
SpeedifySDK_State state
Current state.
Definition: results.h:48
#define SpeedifySDK_SafeBro_Error_Header
Common header fields of Safe Browsing results.
Definition: results.h:304
SpeedifySDK_NetworkSharingPeerStatus peerStatus
The status of the peer connection.
Definition: results.h:473
uint32_t count
Number of networks with detected captive portals.
Definition: results.h:216
uint64_t numLookups
The number of completed requests to the safe browsing server.
Definition: results.h:370
Captive portal check result.
Definition: results.h:212
Firewall settings result.
Definition: results.h:267
Basic result.
Definition: results.h:38
Connection result.
Definition: results.h:62
The result of a pair request.
Definition: results.h:481
Connection Stats result.
Definition: results.h:141
SpeedifySDK_DirectorySettings directorySettings
Current directory settings.
Definition: results.h:87
SpeedifySDK_StreamingSettings streamingSettings
Streaming settings.
Definition: results.h:280
Network Sharing Settings.
Definition: results.h:430
SpeedifySDK_AccountingData accounting
Information on the account.
Definition: results.h:96
A grouping of ConnectionStats.
Definition: types.h:816
uint16_t resultsCount
How many results are in the list.
Definition: results.h:422
Speedify settings.
Definition: types.h:557
SpeedifySDK_NetworkSharingDisplayName displayName
The public display name for this device.
Definition: results.h:488
Safe Browsing Stats.
Definition: results.h:344
Directory settings result.
Definition: results.h:83
SpeedifySDK_DaemonLogSettings daemon
Daemon log file settings.
Definition: results.h:413
Local proxy settings result.
Definition: results.h:236
uint32_t numErrors
The number of safe browsing errors.
Definition: results.h:357
Network Sharing Connection Result Describes a new connection, a connection status change,...
Definition: results.h:463
SpeedifySDK_NetworkSharingPeerUuid uuid
The uuid of the peer.
Definition: results.h:470
Captive portal login mode result.
Definition: results.h:224
SpeedifySDK_NetworkType type
Type of the new adapter.
Definition: results.h:179
Safe Browsing error.
Definition: results.h:378
SpeedifySDK_Settings settings
Settings.
Definition: results.h:127
Network Sharing Available Shares Results.
Definition: results.h:439
#define SPEEDIFYSDK_MAX_SERVERS
Servers supported.
Definition: sdkdefines.h:20
Information about a network adapter.
Definition: types.h:375
uint64_t numPacketsFiltered
The number of safe browsing filtered packets.
Definition: results.h:373
uint32_t numBlocks
The number of safe browsing blocks.
Definition: results.h:360
Privacy Settings result.
Definition: results.h:132
uint32_t minTime
The fastest lookup time (ms)
Definition: results.h:348
Local proxy domain watchlist hit result.
Definition: results.h:285
Safe Browsing block.
Definition: results.h:388
SpeedifySDK_SafeBrowsingLogLevel
Log levels in the SDK.
Definition: types.h:1538
uint32_t maxTime
The slowest lookup time (ms)
Definition: results.h:351
Directory result.
Definition: results.h:71
#define SPEEDIFYSDK_MAX_WATCHLIST_TITLE
Maximum title length of domain watchlist item.
Definition: sdkdefines.h:80
SpeedifySDK_AdapterUsageData usageData
Current usage on the adapter.
Definition: results.h:182
Automatic server selection method settings.
Definition: types.h:417
Directory settings.
Definition: types.h:1482
char SpeedifySDK_NetworkSharingDisplayName[SPEEDIFYSDK_MAX_NETWORKSHARING_DISPLAY_NAME_LENGTH]
The public display name for this device.
Definition: types.h:1622
Streaming stats result.
Definition: results.h:295
#define SPEEDIFYSDK_MAX_NETWORK_SHARING_AVAILABLE_SHARES_RESULTS
Maximum number of discovery results.
Definition: sdkdefines.h:141
uint32_t numBlockResponses
The number of server responses requesting the SDK block or redirect the connection.
Definition: results.h:367
const char * userData
Settings json as a string.
Definition: results.h:262
SpeedifySDK_StreamingStats streamingStats
Streaming stats.
Definition: results.h:299
SpeedifySDK_NetworkType
Type of network adapter.
Definition: types.h:286
SpeedifySDK_SafeBrowsingSafeNetworkOverride
Override safe network decisions.
Definition: types.h:1551
SpeedifySDK_ServerInformation connectedServer
Connected server.
Definition: results.h:66
Server Settings result.
Definition: results.h:114
#define SPEEDIFYSDK_MAX_ACTIVATION_CODE_LENGTH
Length of the activation code field.
Definition: sdkdefines.h:148
Streaming mode stats.
Definition: types.h:1326
SpeedifySDK_NetworkSharingPeerStatus
Status of a NetworkSharing Peer Connection.
Definition: types.h:1709
uint32_t avgTime
The average lookup time (ms)
Definition: results.h:354
Disconnect event result.
Definition: results.h:400
char SpeedifySDK_NetworkSharingPeerUuid[SPEEDIFYSDK_NETWORKSHARING_PEER_UUID_LENGTH]
Peer UUID for network sharing peer data.
Definition: types.h:1625
#define SPEEDIFYSDK_MAX_ACTIVATION_URL_LENGTH
Length of the activation url field.
Definition: sdkdefines.h:151
Torrent detection result.
Definition: results.h:205
SpeedifySDK_NetworkSharingSettings settings
Network sharing settings.
Definition: results.h:434
SpeedifySDK_NetworkSharingPeerRole role
The role of the peer.
Definition: results.h:467
bool configSet
If the additional config is set.
Definition: results.h:330
State result.
Definition: results.h:44
Statistics for sessions over various time periods.
Definition: types.h:973
bool discoveryActive
If discovery is currently active.
Definition: results.h:456
Safe Browsing result.
Definition: results.h:322
Activation code result.
Definition: results.h:497
SpeedifySDK_NetworkSharingPeerUuid uuid
The uuid of the peer.
Definition: results.h:485
uint16_t availableSharesCount
How many results are in the list.
Definition: results.h:443
uint32_t count
Number of adapters.
Definition: results.h:105
Vendor settings result.
Definition: results.h:245
New Adapter result.
Definition: results.h:160
Safe Browsing error on initialization.
Definition: results.h:314
Privacy settings.
Definition: types.h:654
uint32_t count
Number of servers.
Definition: results.h:75
SpeedifySDK_FirewallSettings firewallSettings
Firewall settings.
Definition: results.h:271
SpeedifySDK_State
State of the VPN.
Definition: types.h:80
bool enabled
If the captive portal login mode is enabled.
Definition: results.h:228
Adapter Overlimit result.
Definition: results.h:172
Version structure.
Definition: types.h:59
const char * settingsJson
Settings json as a string.
Definition: results.h:251
bool enabled
If Safe Browsing is enabled.
Definition: results.h:333
Version result.
Definition: results.h:53
Streaming settings result.
Definition: results.h:276
SpeedifySDK_SafeBrowsingLogLevel logLevel
The Safe Browsing logging level.
Definition: results.h:336
Information about a disconnect event.
Definition: types.h:1418
Vendor user data result.
Definition: results.h:256
SpeedifySDK_ServerSettings serverSettings
Settings.
Definition: results.h:118
SpeedifySDK_SafeBro_Error_Header bool initialized
If Safe Browsing is initialized.
Definition: results.h:327
Settings for the priority streaming.
Definition: types.h:1157
Detailed information about a server.
Definition: types.h:154
Results of a speed test.
Definition: types.h:1572
SpeedifySDK_PrivacySettings privacySettings
Privacy settings.
Definition: results.h:136
SpeedifySDK_NetworkSharingTunnelStatus tunnelStatus
The status of the tunnel connection.
Definition: results.h:476
bool redirected
If the connection was redirected to a warning page vs blocked.
Definition: results.h:392
SpeedifySDK_SafeBrowsingSafeNetworkOverride snOverride
Safe Network decision override.
Definition: results.h:339
SpeedifySDK_Version version
Definition: results.h:57
#define SPEEDIFYSDK_MAX_HOST_LEN
Maximum length of SpeedifySDK_SafeBrowsingErrorResult host field.
Definition: sdkdefines.h:92
Account check result.
Definition: results.h:187
Settings result.
Definition: results.h:123
Information about the data usage and limits of a network adapter.
Definition: types.h:348
Represents a network share peer.
Definition: types.h:1801
Settings for logging in the daemon.
Definition: types.h:1452
#define SPEEDIFYSDK_MAX_SPEED_TEST_RESULTS
Maximum speed test results returned.
Definition: sdkdefines.h:125
#define SPEEDIFYSDK_MAX_ADAPTERS
Simultaneous adapters supported.
Definition: sdkdefines.h:17