Speedify SDK for Desktop/Embedded  15.2.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 
188 SpeedifySDK_EXTERN typedef struct {
189  SpeedifySDK_BaseResult_Header
195 SpeedifySDK_EXTERN typedef struct {
196  SpeedifySDK_BaseResult_Header
198 
202 SpeedifySDK_EXTERN typedef struct {
203  SpeedifySDK_BaseResult_Header
205 
208 SpeedifySDK_EXTERN typedef struct {
209  SpeedifySDK_BaseResult_Header
212 
215 SpeedifySDK_EXTERN typedef struct {
216  SpeedifySDK_BaseResult_Header
219  uint32_t count;
224 
227 SpeedifySDK_EXTERN typedef struct {
228  SpeedifySDK_BaseResult_Header
231  bool enabled;
236 
239 SpeedifySDK_EXTERN typedef struct {
240  SpeedifySDK_BaseResult_Header
245 
248 SpeedifySDK_EXTERN typedef struct {
249  SpeedifySDK_BaseResult_Header
254  const char* settingsJson;
256 
259 SpeedifySDK_EXTERN typedef struct {
260  SpeedifySDK_BaseResult_Header
265  const char* userData;
267 
270 SpeedifySDK_EXTERN typedef struct {
271  SpeedifySDK_BaseResult_Header
276 
279 SpeedifySDK_EXTERN typedef struct {
280  SpeedifySDK_BaseResult_Header
285 
288 SpeedifySDK_EXTERN typedef struct {
289  SpeedifySDK_BaseResult_Header
294 
295 
298 SpeedifySDK_EXTERN typedef struct {
299  SpeedifySDK_BaseResult_Header
304 
307 #define SpeedifySDK_SafeBro_Error_Header \
308  \
309 bool sbError;\
310  \
311 SpeedifySDK_SafeBrowsingError sbErrorCode;\
312  \
313 char sbErrorMessage[SPEEDIFYSDK_MAX_ERROR_STRING];
314 
317 SpeedifySDK_EXTERN typedef struct {
318  SpeedifySDK_BaseResult_Header
321 
322 
325 SpeedifySDK_EXTERN typedef struct {
326  SpeedifySDK_BaseResult_Header
333  bool configSet;
336  bool enabled;
344 
347 SpeedifySDK_EXTERN typedef struct {
348  SpeedifySDK_BaseResult_Header
351  uint32_t minTime;
354  uint32_t maxTime;
357  uint32_t avgTime;
360  uint32_t numErrors;
363  uint32_t numBlocks;
366  double failureRate;
373  uint64_t numLookups;
378 
381 SpeedifySDK_EXTERN typedef struct {
382  SpeedifySDK_BaseResult_Header
388 
391 SpeedifySDK_EXTERN typedef struct {
392  SpeedifySDK_BaseResult_Header
400 
403 SpeedifySDK_EXTERN typedef struct {
404  SpeedifySDK_BaseResult_Header
409 
412 SpeedifySDK_EXTERN typedef struct {
413  SpeedifySDK_BaseResult_Header
418 
421 SpeedifySDK_EXTERN typedef struct {
422  SpeedifySDK_BaseResult_Header
425  uint16_t resultsCount;
430 
433 SpeedifySDK_EXTERN typedef struct {
434  SpeedifySDK_BaseResult_Header
439 
442 SpeedifySDK_EXTERN typedef struct {
443  SpeedifySDK_BaseResult_Header
451 
455 SpeedifySDK_EXTERN typedef struct {
456  SpeedifySDK_BaseResult_Header
461 
466 SpeedifySDK_EXTERN typedef struct {
467  SpeedifySDK_BaseResult_Header
481 
484 SpeedifySDK_EXTERN typedef struct {
485  SpeedifySDK_BaseResult_Header
496 
497 
500 SpeedifySDK_EXTERN typedef struct {
501  SpeedifySDK_BaseResult_Header
509 
510 
513 SpeedifySDK_EXTERN typedef struct {
514  SpeedifySDK_BaseResult_Header
519 
520 
523 SpeedifySDK_EXTERN typedef struct {
524  SpeedifySDK_BaseResult_Header
529 
532 #endif
uint64_t SpeedifySDK_EventID
Callback ID type.
Definition: results.h:21
Account create result.
Definition: results.h:195
bool haveAuthToken
If we have exchanged an auth token with the peer.
Definition: results.h:494
SpeedifySDK_DisconnectEvent lastDisconnectEvent
The last disconnect event.
Definition: results.h:407
Network Sharing Discovery Result Indicates the result of a discovery request.
Definition: results.h:455
SpeedifySDK_NetworkSharingPeerRole
peer role
Definition: types.h:1770
SpeedifySDK_NetworkType type
Type of the new adapter.
Definition: results.h:167
Settings for the local proxy.
Definition: types.h:1243
Password change result.
Definition: results.h:202
#define SPEEDIFYSDK_MAX_ADAPTER_NAME
Adapter name length.
Definition: sdkdefines.h:35
Network sharing settings.
Definition: types.h:1820
Speed test result.
Definition: results.h:421
Adapters result.
Definition: results.h:101
Log report result.
Definition: results.h:513
bool accountExists
Definition: results.h:190
SpeedifySDK_NetworkSharingTunnelStatus
Status of a NetworkSharing tunnel.
Definition: types.h:1868
SpeedifySDK_ConnectionStatsGroup connectionStats
A group of connection stats.
Definition: results.h:145
Data on an account.
Definition: types.h:265
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:412
double failureRate
The lookup failure rate.
Definition: results.h:366
bool willDisconnect
Definition: results.h:210
SpeedifySDK_LocalProxySettings localProxySettings
Local proxy settings.
Definition: results.h:243
Firewall settings.
Definition: types.h:1348
SpeedifySDK_State state
Current state.
Definition: results.h:48
#define SpeedifySDK_SafeBro_Error_Header
Common header fields of Safe Browsing results.
Definition: results.h:307
SpeedifySDK_NetworkSharingPeerStatus peerStatus
The status of the peer connection.
Definition: results.h:476
uint32_t count
Number of networks with detected captive portals.
Definition: results.h:219
uint64_t numLookups
The number of completed requests to the safe browsing server.
Definition: results.h:373
Captive portal check result.
Definition: results.h:215
Firewall settings result.
Definition: results.h:270
Basic result.
Definition: results.h:38
Connection result.
Definition: results.h:62
The result of a pair request.
Definition: results.h:484
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:283
Network Sharing Settings.
Definition: results.h:433
SpeedifySDK_AccountingData accounting
Information on the account.
Definition: results.h:96
A grouping of ConnectionStats.
Definition: types.h:908
uint16_t resultsCount
How many results are in the list.
Definition: results.h:425
Speedify settings.
Definition: types.h:633
SpeedifySDK_NetworkSharingDisplayName displayName
The public display name for this device.
Definition: results.h:491
Safe Browsing Stats.
Definition: results.h:347
Directory settings result.
Definition: results.h:83
DSCP settings.
Definition: types.h:2020
SpeedifySDK_DaemonLogSettings daemon
Daemon log file settings.
Definition: results.h:416
Local proxy settings result.
Definition: results.h:239
uint32_t numErrors
The number of safe browsing errors.
Definition: results.h:360
Network Sharing Connection Result Describes a new connection, a connection status change,...
Definition: results.h:466
SpeedifySDK_NetworkSharingPeerUuid uuid
The uuid of the peer.
Definition: results.h:473
Captive portal login mode result.
Definition: results.h:227
SpeedifySDK_NetworkType type
Type of the new adapter.
Definition: results.h:179
Safe Browsing error.
Definition: results.h:381
SpeedifySDK_Settings settings
Settings.
Definition: results.h:127
Network Sharing Available Shares Results.
Definition: results.h:442
#define SPEEDIFYSDK_MAX_SERVERS
Servers supported.
Definition: sdkdefines.h:20
Information about a network adapter.
Definition: types.h:437
uint64_t numPacketsFiltered
The number of safe browsing filtered packets.
Definition: results.h:376
uint32_t numBlocks
The number of safe browsing blocks.
Definition: results.h:363
Privacy Settings result.
Definition: results.h:132
uint32_t minTime
The fastest lookup time (ms)
Definition: results.h:351
Local proxy domain watchlist hit result.
Definition: results.h:288
Safe Browsing block.
Definition: results.h:391
SpeedifySDK_SafeBrowsingLogLevel
Log levels in the SDK.
Definition: types.h:1679
uint32_t maxTime
The slowest lookup time (ms)
Definition: results.h:354
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:482
Directory settings.
Definition: types.h:1623
char SpeedifySDK_NetworkSharingDisplayName[SPEEDIFYSDK_MAX_NETWORKSHARING_DISPLAY_NAME_LENGTH]
The public display name for this device.
Definition: types.h:1763
Streaming stats result.
Definition: results.h:298
#define SPEEDIFYSDK_MAX_NETWORK_SHARING_AVAILABLE_SHARES_RESULTS
Maximum number of discovery results.
Definition: sdkdefines.h:144
uint32_t numBlockResponses
The number of server responses requesting the SDK block or redirect the connection.
Definition: results.h:370
const char * userData
Settings json as a string.
Definition: results.h:265
SpeedifySDK_StreamingStats streamingStats
Streaming stats.
Definition: results.h:302
SpeedifySDK_NetworkType
Type of network adapter.
Definition: types.h:320
SpeedifySDK_SafeBrowsingSafeNetworkOverride
Override safe network decisions.
Definition: types.h:1692
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:151
Streaming mode stats.
Definition: types.h:1467
SpeedifySDK_NetworkSharingPeerStatus
Status of a NetworkSharing Peer Connection.
Definition: types.h:1850
uint32_t avgTime
The average lookup time (ms)
Definition: results.h:357
Disconnect event result.
Definition: results.h:403
char SpeedifySDK_NetworkSharingPeerUuid[SPEEDIFYSDK_NETWORKSHARING_PEER_UUID_LENGTH]
Peer UUID for network sharing peer data.
Definition: types.h:1766
#define SPEEDIFYSDK_MAX_ACTIVATION_URL_LENGTH
Length of the activation url field.
Definition: sdkdefines.h:154
Torrent detection result.
Definition: results.h:208
SpeedifySDK_NetworkSharingSettings settings
Network sharing settings.
Definition: results.h:437
SpeedifySDK_NetworkSharingPeerRole role
The role of the peer.
Definition: results.h:470
bool configSet
If the additional config is set.
Definition: results.h:333
State result.
Definition: results.h:44
Statistics for sessions over various time periods.
Definition: types.h:1111
bool discoveryActive
If discovery is currently active.
Definition: results.h:459
Safe Browsing result.
Definition: results.h:325
Activation code result.
Definition: results.h:500
SpeedifySDK_NetworkSharingPeerUuid uuid
The uuid of the peer.
Definition: results.h:488
uint16_t availableSharesCount
How many results are in the list.
Definition: results.h:446
uint32_t count
Number of adapters.
Definition: results.h:105
SpeedifySDK_DSCPSettings settings
DSCP settings.
Definition: results.h:527
Vendor settings result.
Definition: results.h:248
New Adapter result.
Definition: results.h:160
Safe Browsing error on initialization.
Definition: results.h:317
Privacy settings.
Definition: types.h:739
uint32_t count
Number of servers.
Definition: results.h:75
SpeedifySDK_FirewallSettings firewallSettings
Firewall settings.
Definition: results.h:274
SpeedifySDK_State
State of the VPN.
Definition: types.h:80
bool enabled
If the captive portal login mode is enabled.
Definition: results.h:231
Adapter Overlimit result.
Definition: results.h:172
Version structure.
Definition: types.h:59
const char * settingsJson
Settings json as a string.
Definition: results.h:254
bool enabled
If Safe Browsing is enabled.
Definition: results.h:336
Version result.
Definition: results.h:53
Streaming settings result.
Definition: results.h:279
SpeedifySDK_SafeBrowsingLogLevel logLevel
The Safe Browsing logging level.
Definition: results.h:339
Information about a disconnect event.
Definition: types.h:1559
Vendor user data result.
Definition: results.h:259
DSCP settings result.
Definition: results.h:523
SpeedifySDK_ServerSettings serverSettings
Settings.
Definition: results.h:118
SpeedifySDK_SafeBro_Error_Header bool initialized
If Safe Browsing is initialized.
Definition: results.h:330
Settings for the priority streaming.
Definition: types.h:1295
Detailed information about a server.
Definition: types.h:154
Results of a speed test.
Definition: types.h:1713
SpeedifySDK_PrivacySettings privacySettings
Privacy settings.
Definition: results.h:136
#define SPEEDIFYSDK_MAX_TICKET_ID_LENGTH
Maximum ticket id length.
Definition: sdkdefines.h:134
SpeedifySDK_NetworkSharingTunnelStatus tunnelStatus
The status of the tunnel connection.
Definition: results.h:479
bool redirected
If the connection was redirected to a warning page vs blocked.
Definition: results.h:395
SpeedifySDK_SafeBrowsingSafeNetworkOverride snOverride
Safe Network decision override.
Definition: results.h:342
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:188
Settings result.
Definition: results.h:123
Information about the data usage and limits of a network adapter.
Definition: types.h:382
Represents a network share peer.
Definition: types.h:1942
Settings for logging in the daemon.
Definition: types.h:1593
#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