Speedify SDK for Desktop/Embedded 16.9.0
Loading...
Searching...
No Matches
results.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 "types.h"
6#include <stdbool.h>
7
19typedef uint64_t SpeedifySDK_EventID;
20
23#define SpeedifySDK_BaseResult_Header \
24 \
25bool isError;\
26 \
27SpeedifySDK_ErrorType errorCode;\
28 \
29char errorMessage[SPEEDIFYSDK_MAX_ERROR_STRING];\
30 \
31SpeedifySDK_EventID eventId;
32
33
36SpeedifySDK_EXTERN typedef struct {
37 SpeedifySDK_BaseResult_Header
39
42SpeedifySDK_EXTERN typedef struct {
43 SpeedifySDK_BaseResult_Header
48
51SpeedifySDK_EXTERN typedef struct {
52 SpeedifySDK_BaseResult_Header
57
60SpeedifySDK_EXTERN typedef struct {
61 SpeedifySDK_BaseResult_Header
66
69SpeedifySDK_EXTERN typedef struct {
70 SpeedifySDK_BaseResult_Header
73 uint32_t count;
78
81SpeedifySDK_EXTERN typedef struct {
82 SpeedifySDK_BaseResult_Header
87
90SpeedifySDK_EXTERN typedef struct {
91 SpeedifySDK_BaseResult_Header
96
99SpeedifySDK_EXTERN typedef struct {
100 SpeedifySDK_BaseResult_Header
103 uint32_t count;
108
109
112SpeedifySDK_EXTERN typedef struct {
113 SpeedifySDK_BaseResult_Header
118
124SpeedifySDK_EXTERN typedef struct {
125 SpeedifySDK_BaseResult_Header
131 uint32_t count;
136
139SpeedifySDK_EXTERN typedef struct {
140 SpeedifySDK_BaseResult_Header
145
148SpeedifySDK_EXTERN typedef struct {
149 SpeedifySDK_BaseResult_Header
154
157SpeedifySDK_EXTERN typedef struct {
158 SpeedifySDK_BaseResult_Header
163
166SpeedifySDK_EXTERN typedef struct {
167 SpeedifySDK_BaseResult_Header
172
173
176SpeedifySDK_EXTERN typedef struct {
177 SpeedifySDK_BaseResult_Header
185
200
204SpeedifySDK_EXTERN typedef struct {
205 SpeedifySDK_BaseResult_Header
213SpeedifySDK_EXTERN typedef struct {
214 SpeedifySDK_BaseResult_Header
216
220SpeedifySDK_EXTERN typedef struct {
221 SpeedifySDK_BaseResult_Header
223
226SpeedifySDK_EXTERN typedef struct {
227 SpeedifySDK_BaseResult_Header
232
235SpeedifySDK_EXTERN typedef struct {
236 SpeedifySDK_BaseResult_Header
239 uint32_t count;
244
247SpeedifySDK_EXTERN typedef struct {
248 SpeedifySDK_BaseResult_Header
256
259SpeedifySDK_EXTERN typedef struct {
260 SpeedifySDK_BaseResult_Header
265
268SpeedifySDK_EXTERN typedef struct {
269 SpeedifySDK_BaseResult_Header
274 const char* settingsJson;
276
279SpeedifySDK_EXTERN typedef struct {
280 SpeedifySDK_BaseResult_Header
285 const char* userData;
287
290SpeedifySDK_EXTERN typedef struct {
291 SpeedifySDK_BaseResult_Header
296
299SpeedifySDK_EXTERN typedef struct {
300 SpeedifySDK_BaseResult_Header
305
308SpeedifySDK_EXTERN typedef struct {
309 SpeedifySDK_BaseResult_Header
314
315
318SpeedifySDK_EXTERN typedef struct {
319 SpeedifySDK_BaseResult_Header
324
327#define SpeedifySDK_SafeBro_Error_Header \
328 \
329bool sbError;\
330 \
331SpeedifySDK_SafeBrowsingError sbErrorCode;\
332 \
333char sbErrorMessage[SPEEDIFYSDK_MAX_ERROR_STRING];
334
337SpeedifySDK_EXTERN typedef struct {
338 SpeedifySDK_BaseResult_Header
341
342
374
377SpeedifySDK_EXTERN typedef struct {
378 SpeedifySDK_BaseResult_Header
381 uint32_t minTime;
384 uint32_t maxTime;
387 uint32_t avgTime;
390 uint32_t numErrors;
393 uint32_t numBlocks;
403 uint64_t numLookups;
408
411SpeedifySDK_EXTERN typedef struct {
412 SpeedifySDK_BaseResult_Header
418
421SpeedifySDK_EXTERN typedef struct {
422 SpeedifySDK_BaseResult_Header
430
433SpeedifySDK_EXTERN typedef struct {
434 SpeedifySDK_BaseResult_Header
439
442SpeedifySDK_EXTERN typedef struct {
443 SpeedifySDK_BaseResult_Header
448
451SpeedifySDK_EXTERN typedef struct {
452 SpeedifySDK_BaseResult_Header
455 uint16_t resultsCount;
460
463SpeedifySDK_EXTERN typedef struct {
464 SpeedifySDK_BaseResult_Header
469
481
485SpeedifySDK_EXTERN typedef struct {
486 SpeedifySDK_BaseResult_Header
491
511
526
527
530SpeedifySDK_EXTERN typedef struct {
531 SpeedifySDK_BaseResult_Header
539
540
543SpeedifySDK_EXTERN typedef struct {
544 SpeedifySDK_BaseResult_Header
549
550
553SpeedifySDK_EXTERN typedef struct {
554 SpeedifySDK_BaseResult_Header
559
562SpeedifySDK_EXTERN typedef struct {
563 SpeedifySDK_BaseResult_Header
568 const char *rulesJson;
570
573SpeedifySDK_EXTERN typedef struct {
574 SpeedifySDK_BaseResult_Header
577
#define SPEEDIFYSDK_MAX_ISP_ACTIONS
Maximum number of ISP-stats actions advertised per adapter.
Definition sdkdefines.h:209
#define SPEEDIFYSDK_MAX_HOST_LEN
Maximum length of SpeedifySDK_SafeBrowsingErrorResult host field.
Definition sdkdefines.h:96
#define SPEEDIFYSDK_MAX_SPEED_TEST_RESULTS
Maximum speed test results returned.
Definition sdkdefines.h:129
#define SPEEDIFYSDK_MAX_WATCHLIST_TITLE
Maximum title length of domain watchlist item.
Definition sdkdefines.h:84
#define SPEEDIFYSDK_MAX_ACTIVATION_URL_LENGTH
Length of the activation url field.
Definition sdkdefines.h:158
#define SPEEDIFYSDK_MAX_SERVERS
Servers supported.
Definition sdkdefines.h:18
#define SPEEDIFYSDK_MAX_ADAPTER_NAME
Adapter name length.
Definition sdkdefines.h:33
#define SPEEDIFYSDK_MAX_TICKET_ID_LENGTH
Maximum ticket id length.
Definition sdkdefines.h:138
#define SPEEDIFYSDK_MAX_ADAPTERS
Simultaneous adapters supported.
Definition sdkdefines.h:15
#define SPEEDIFYSDK_MAX_NETWORK_SHARING_AVAILABLE_SHARES_RESULTS
Maximum number of discovery results.
Definition sdkdefines.h:148
#define SPEEDIFYSDK_MAX_ACTIVATION_CODE_LENGTH
Length of the activation code field.
Definition sdkdefines.h:155
#define SpeedifySDK_SafeBro_Error_Header
Common header fields of Safe Browsing results.
Definition results.h:327
uint64_t SpeedifySDK_EventID
Callback ID type.
Definition results.h:19
SpeedifySDK_NetworkType
Type of network adapter.
Definition types.h:345
SpeedifySDK_State
State of the VPN.
Definition types.h:86
char SpeedifySDK_DateTimeString[SPEEDIFYSDK_MAX_DATE_TIME_LENGTH]
String representation of a date and time.
Definition types.h:43
Account check result.
Definition results.h:204
bool accountExists
If the account exists.
Definition results.h:208
Account create result.
Definition results.h:213
Password change result.
Definition results.h:220
Data on an account.
Definition types.h:287
Accounting result.
Definition results.h:90
SpeedifySDK_AccountingData accounting
Information on the account.
Definition results.h:94
Activation code result.
Definition results.h:530
Information about a network adapter.
Definition types.h:462
Adapter Overlimit result.
Definition results.h:188
SpeedifySDK_NetworkType type
Type of the new adapter.
Definition results.h:195
SpeedifySDK_AdapterUsageData usageData
Current usage on the adapter.
Definition results.h:198
Information about the data usage and limits of a network adapter.
Definition types.h:407
Adapters result.
Definition results.h:99
uint32_t count
Number of adapters.
Definition results.h:103
Basic result.
Definition results.h:36
Captive portal check result.
Definition results.h:235
uint32_t count
Number of networks with detected captive portals.
Definition results.h:239
Captive portal login mode result.
Definition results.h:247
bool enabled
If the captive portal login mode is enabled.
Definition results.h:251
Connection result.
Definition results.h:60
SpeedifySDK_ServerInformation connectedServer
Connected server.
Definition results.h:64
A grouping of ConnectionStats.
Definition types.h:1055
Connection Stats result.
Definition results.h:157
SpeedifySDK_ConnectionStatsGroup connectionStats
A group of connection stats.
Definition results.h:161
DSCP settings.
Definition types.h:2188
DSCP settings result.
Definition results.h:553
SpeedifySDK_DSCPSettings settings
DSCP settings.
Definition results.h:557
Settings for logging in the daemon.
Definition types.h:1751
Directory result.
Definition results.h:69
uint32_t count
Number of servers.
Definition results.h:73
Directory settings.
Definition types.h:1781
Directory settings result.
Definition results.h:81
SpeedifySDK_DirectorySettings directorySettings
Current directory settings.
Definition results.h:85
Information about a disconnect event.
Definition types.h:1714
Disconnect event result.
Definition results.h:433
SpeedifySDK_DisconnectEvent lastDisconnectEvent
The last disconnect event.
Definition results.h:437
Firewall settings.
Definition types.h:1500
Firewall settings result.
Definition results.h:290
SpeedifySDK_FirewallSettings firewallSettings
Firewall settings.
Definition results.h:294
A single ISP-stats action descriptor advertised by an adapter. The id identifies the action and defin...
Definition types.h:622
ISP-stats actions result.
Definition results.h:124
uint32_t count
Number of action descriptors.
Definition results.h:131
Local proxy domain watchlist hit result.
Definition results.h:308
Settings for the local proxy.
Definition types.h:1395
Local proxy settings result.
Definition results.h:259
SpeedifySDK_LocalProxySettings localProxySettings
Local proxy settings.
Definition results.h:263
Log report result.
Definition results.h:543
Log file settings result.
Definition results.h:442
SpeedifySDK_DaemonLogSettings daemon
Daemon log file settings.
Definition results.h:446
Represents a network share peer.
Definition types.h:2103
Network Sharing Available Shares Results.
Definition results.h:472
uint16_t availableSharesCount
How many results are in the list.
Definition results.h:476
Network Sharing Connection Result Describes a new connection, a connection status change,...
Definition results.h:496
SpeedifySDK_NetworkSharingPeerRole role
The role of the peer.
Definition results.h:500
SpeedifySDK_NetworkSharingPeerStatus peerStatus
The status of the peer connection.
Definition results.h:506
SpeedifySDK_NetworkSharingPeerUuid uuid
The uuid of the peer.
Definition results.h:503
SpeedifySDK_NetworkSharingTunnelStatus tunnelStatus
The status of the tunnel connection.
Definition results.h:509
Network Sharing Discovery Result Indicates the result of a discovery request.
Definition results.h:485
bool discoveryActive
If discovery is currently active.
Definition results.h:489
The result of a pair request.
Definition results.h:514
SpeedifySDK_NetworkSharingPeerUuid uuid
The uuid of the peer.
Definition results.h:518
SpeedifySDK_NetworkSharingDisplayName displayName
The public display name for this device.
Definition results.h:521
bool haveAuthToken
If we have exchanged an auth token with the peer.
Definition results.h:524
Network sharing settings.
Definition types.h:1978
Network Sharing Settings.
Definition results.h:463
SpeedifySDK_NetworkSharingSettings settings
Network sharing settings.
Definition results.h:467
New Adapter result.
Definition results.h:176
SpeedifySDK_NetworkType type
Type of the new adapter.
Definition results.h:183
Privacy settings.
Definition types.h:853
Privacy Settings result.
Definition results.h:148
SpeedifySDK_PrivacySettings privacySettings
Privacy settings.
Definition results.h:152
Safe Browsing block.
Definition results.h:421
bool redirected
If the connection was redirected to a warning page vs blocked.
Definition results.h:425
Safe Browsing error on initialization.
Definition results.h:337
Safe Browsing error.
Definition results.h:411
Safe Browsing result.
Definition results.h:345
SpeedifySDK_DateTimeString lastReport
The timestamp of the last deduplication report.
Definition results.h:372
SpeedifySDK_SafeBro_Error_Header bool initialized
If Safe Browsing is initialized.
Definition results.h:350
SpeedifySDK_SafeBrowsingSafeNetworkOverride snOverride
Safe Network decision override.
Definition results.h:363
bool autoreport
If Safe Browsing auto reporting is enabled.
Definition results.h:366
bool configSet
If the additional config is set.
Definition results.h:354
SpeedifySDK_SafeBrowsingLogLevel logLevel
The Safe Browsing logging level.
Definition results.h:360
uint32_t autoreportIntervalSeconds
Minimum interval between auto reports (in seconds)
Definition results.h:369
bool enabled
If Safe Browsing is enabled.
Definition results.h:357
Safe Browsing Stats.
Definition results.h:377
uint32_t avgTime
The average lookup time (ms)
Definition results.h:387
double failureRate
The lookup failure rate.
Definition results.h:396
uint32_t minTime
The fastest lookup time (ms)
Definition results.h:381
uint32_t numBlocks
The number of safe browsing blocks.
Definition results.h:393
uint32_t numBlockResponses
The number of server responses requesting the SDK block or redirect the connection.
Definition results.h:400
uint32_t maxTime
The slowest lookup time (ms)
Definition results.h:384
uint32_t numErrors
The number of safe browsing errors.
Definition results.h:390
uint64_t numLookups
The number of completed requests to the safe browsing server.
Definition results.h:403
uint64_t numPacketsFiltered
The number of safe browsing filtered packets.
Definition results.h:406
Detailed information about a server.
Definition types.h:160
Automatic server selection method settings.
Definition types.h:525
Server Settings result.
Definition results.h:112
SpeedifySDK_ServerSettings serverSettings
Settings.
Definition results.h:116
Statistics for sessions over various time periods.
Definition types.h:1263
Session Stats result.
Definition results.h:166
SpeedifySDK_SessionStatPeriods sessionStats
Session stats.
Definition results.h:170
Speedify settings.
Definition types.h:723
Settings result.
Definition results.h:139
SpeedifySDK_Settings settings
Settings.
Definition results.h:143
Results of a speed test.
Definition types.h:1871
Speed test result.
Definition results.h:451
uint16_t resultsCount
How many results are in the list.
Definition results.h:455
State result.
Definition results.h:42
SpeedifySDK_State state
Current state.
Definition results.h:46
Settings for the priority streaming.
Definition types.h:1447
Streaming settings result.
Definition results.h:299
SpeedifySDK_StreamingSettings streamingSettings
Streaming settings.
Definition results.h:303
Streaming mode stats.
Definition types.h:1622
Streaming stats result.
Definition results.h:318
SpeedifySDK_StreamingStats streamingStats
Streaming stats.
Definition results.h:322
Definition types.h:2234
System data result.
Definition results.h:573
SpeedifySDK_SystemData systemData
Definition results.h:575
Torrent detection result.
Definition results.h:226
bool willDisconnect
If this detection will force a disconnect.
Definition results.h:230
Traffic rules result.
Definition results.h:562
const char * rulesJson
Traffic rules settings as a JSON string.
Definition results.h:568
Vendor settings result.
Definition results.h:268
const char * settingsJson
Settings json as a string.
Definition results.h:274
Vendor user data result.
Definition results.h:279
const char * userData
Settings json as a string.
Definition results.h:285
Version structure.
Definition types.h:65
Version result.
Definition results.h:51
SpeedifySDK_Version version
Definition results.h:55
SpeedifySDK_NetworkSharingPeerRole
peer role
Definition types.h:1928
char SpeedifySDK_NetworkSharingDisplayName[SPEEDIFYSDK_MAX_NETWORKSHARING_DISPLAY_NAME_LENGTH]
The public display name for this device.
Definition types.h:1921
char SpeedifySDK_NetworkSharingPeerUuid[SPEEDIFYSDK_NETWORKSHARING_PEER_UUID_LENGTH]
Peer UUID for network sharing peer data.
Definition types.h:1924
SpeedifySDK_NetworkSharingPeerStatus
Status of a NetworkSharing Peer Connection.
Definition types.h:2011
SpeedifySDK_SafeBrowsingSafeNetworkOverride
Override safe network decisions.
Definition types.h:1850
SpeedifySDK_SafeBrowsingLogLevel
Log levels in the SDK.
Definition types.h:1837
SpeedifySDK_NetworkSharingTunnelStatus
Status of a NetworkSharing tunnel.
Definition types.h:2029