Speedify SDK for Desktop/Embedded 15.5.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
16
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
121SpeedifySDK_EXTERN typedef struct {
122 SpeedifySDK_BaseResult_Header
127
130SpeedifySDK_EXTERN typedef struct {
131 SpeedifySDK_BaseResult_Header
136
139SpeedifySDK_EXTERN typedef struct {
140 SpeedifySDK_BaseResult_Header
145
148SpeedifySDK_EXTERN typedef struct {
149 SpeedifySDK_BaseResult_Header
154
155
158SpeedifySDK_EXTERN typedef struct {
159 SpeedifySDK_BaseResult_Header
167
182
186SpeedifySDK_EXTERN typedef struct {
187 SpeedifySDK_BaseResult_Header
195SpeedifySDK_EXTERN typedef struct {
196 SpeedifySDK_BaseResult_Header
198
202SpeedifySDK_EXTERN typedef struct {
203 SpeedifySDK_BaseResult_Header
205
208SpeedifySDK_EXTERN typedef struct {
209 SpeedifySDK_BaseResult_Header
214
217SpeedifySDK_EXTERN typedef struct {
218 SpeedifySDK_BaseResult_Header
221 uint32_t count;
226
229SpeedifySDK_EXTERN typedef struct {
230 SpeedifySDK_BaseResult_Header
238
241SpeedifySDK_EXTERN typedef struct {
242 SpeedifySDK_BaseResult_Header
247
250SpeedifySDK_EXTERN typedef struct {
251 SpeedifySDK_BaseResult_Header
256 const char* settingsJson;
258
261SpeedifySDK_EXTERN typedef struct {
262 SpeedifySDK_BaseResult_Header
267 const char* userData;
269
272SpeedifySDK_EXTERN typedef struct {
273 SpeedifySDK_BaseResult_Header
278
281SpeedifySDK_EXTERN typedef struct {
282 SpeedifySDK_BaseResult_Header
287
290SpeedifySDK_EXTERN typedef struct {
291 SpeedifySDK_BaseResult_Header
296
297
300SpeedifySDK_EXTERN typedef struct {
301 SpeedifySDK_BaseResult_Header
306
309#define SpeedifySDK_SafeBro_Error_Header \
310 \
311bool sbError;\
312 \
313SpeedifySDK_SafeBrowsingError sbErrorCode;\
314 \
315char sbErrorMessage[SPEEDIFYSDK_MAX_ERROR_STRING];
316
319SpeedifySDK_EXTERN typedef struct {
320 SpeedifySDK_BaseResult_Header
323
324
346
349SpeedifySDK_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;
375 uint64_t numLookups;
380
383SpeedifySDK_EXTERN typedef struct {
384 SpeedifySDK_BaseResult_Header
390
393SpeedifySDK_EXTERN typedef struct {
394 SpeedifySDK_BaseResult_Header
402
405SpeedifySDK_EXTERN typedef struct {
406 SpeedifySDK_BaseResult_Header
411
414SpeedifySDK_EXTERN typedef struct {
415 SpeedifySDK_BaseResult_Header
420
423SpeedifySDK_EXTERN typedef struct {
424 SpeedifySDK_BaseResult_Header
427 uint16_t resultsCount;
432
435SpeedifySDK_EXTERN typedef struct {
436 SpeedifySDK_BaseResult_Header
441
453
457SpeedifySDK_EXTERN typedef struct {
458 SpeedifySDK_BaseResult_Header
463
483
498
499
502SpeedifySDK_EXTERN typedef struct {
503 SpeedifySDK_BaseResult_Header
511
512
515SpeedifySDK_EXTERN typedef struct {
516 SpeedifySDK_BaseResult_Header
521
522
525SpeedifySDK_EXTERN typedef struct {
526 SpeedifySDK_BaseResult_Header
531
#define SpeedifySDK_SafeBro_Error_Header
Common header fields of Safe Browsing results.
Definition results.h:309
uint64_t SpeedifySDK_EventID
Callback ID type.
Definition results.h:19
#define SPEEDIFYSDK_MAX_HOST_LEN
Maximum length of SpeedifySDK_SafeBrowsingErrorResult host field.
Definition sdkdefines.h:90
#define SPEEDIFYSDK_MAX_SPEED_TEST_RESULTS
Maximum speed test results returned.
Definition sdkdefines.h:123
#define SPEEDIFYSDK_MAX_WATCHLIST_TITLE
Maximum title length of domain watchlist item.
Definition sdkdefines.h:78
#define SPEEDIFYSDK_MAX_ACTIVATION_URL_LENGTH
Length of the activation url field.
Definition sdkdefines.h:152
#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:132
#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:142
#define SPEEDIFYSDK_MAX_ACTIVATION_CODE_LENGTH
Length of the activation code field.
Definition sdkdefines.h:149
Account check result.
Definition results.h:186
bool accountExists
If the account exists.
Definition results.h:190
Account create result.
Definition results.h:195
Password change result.
Definition results.h:202
Data on an account.
Definition types.h:264
Accounting result.
Definition results.h:90
SpeedifySDK_AccountingData accounting
Information on the account.
Definition results.h:94
Activation code result.
Definition results.h:502
Information about a network adapter.
Definition types.h:436
Adapter Overlimit result.
Definition results.h:170
SpeedifySDK_NetworkType type
Type of the new adapter.
Definition results.h:177
SpeedifySDK_AdapterUsageData usageData
Current usage on the adapter.
Definition results.h:180
Information about the data usage and limits of a network adapter.
Definition types.h:381
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:217
uint32_t count
Number of networks with detected captive portals.
Definition results.h:221
Captive portal login mode result.
Definition results.h:229
bool enabled
If the captive portal login mode is enabled.
Definition results.h:233
Connection result.
Definition results.h:60
SpeedifySDK_ServerInformation connectedServer
Connected server.
Definition results.h:64
A grouping of ConnectionStats.
Definition types.h:929
Connection Stats result.
Definition results.h:139
SpeedifySDK_ConnectionStatsGroup connectionStats
A group of connection stats.
Definition results.h:143
DSCP settings.
Definition types.h:2041
DSCP settings result.
Definition results.h:525
SpeedifySDK_DSCPSettings settings
DSCP settings.
Definition results.h:529
Settings for logging in the daemon.
Definition types.h:1614
Directory result.
Definition results.h:69
uint32_t count
Number of servers.
Definition results.h:73
Directory settings.
Definition types.h:1644
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:1580
Disconnect event result.
Definition results.h:405
SpeedifySDK_DisconnectEvent lastDisconnectEvent
The last disconnect event.
Definition results.h:409
Firewall settings.
Definition types.h:1369
Firewall settings result.
Definition results.h:272
SpeedifySDK_FirewallSettings firewallSettings
Firewall settings.
Definition results.h:276
Local proxy domain watchlist hit result.
Definition results.h:290
Settings for the local proxy.
Definition types.h:1264
Local proxy settings result.
Definition results.h:241
SpeedifySDK_LocalProxySettings localProxySettings
Local proxy settings.
Definition results.h:245
Log report result.
Definition results.h:515
Log file settings result.
Definition results.h:414
SpeedifySDK_DaemonLogSettings daemon
Daemon log file settings.
Definition results.h:418
Represents a network share peer.
Definition types.h:1963
Network Sharing Available Shares Results.
Definition results.h:444
uint16_t availableSharesCount
How many results are in the list.
Definition results.h:448
Network Sharing Connection Result Describes a new connection, a connection status change,...
Definition results.h:468
SpeedifySDK_NetworkSharingPeerRole role
The role of the peer.
Definition results.h:472
SpeedifySDK_NetworkSharingPeerStatus peerStatus
The status of the peer connection.
Definition results.h:478
SpeedifySDK_NetworkSharingPeerUuid uuid
The uuid of the peer.
Definition results.h:475
SpeedifySDK_NetworkSharingTunnelStatus tunnelStatus
The status of the tunnel connection.
Definition results.h:481
Network Sharing Discovery Result Indicates the result of a discovery request.
Definition results.h:457
bool discoveryActive
If discovery is currently active.
Definition results.h:461
The result of a pair request.
Definition results.h:486
SpeedifySDK_NetworkSharingPeerUuid uuid
The uuid of the peer.
Definition results.h:490
SpeedifySDK_NetworkSharingDisplayName displayName
The public display name for this device.
Definition results.h:493
bool haveAuthToken
If we have exchanged an auth token with the peer.
Definition results.h:496
Network sharing settings.
Definition types.h:1841
Network Sharing Settings.
Definition results.h:435
SpeedifySDK_NetworkSharingSettings settings
Network sharing settings.
Definition results.h:439
New Adapter result.
Definition results.h:158
SpeedifySDK_NetworkType type
Type of the new adapter.
Definition results.h:165
Privacy settings.
Definition types.h:750
Privacy Settings result.
Definition results.h:130
SpeedifySDK_PrivacySettings privacySettings
Privacy settings.
Definition results.h:134
Safe Browsing block.
Definition results.h:393
bool redirected
If the connection was redirected to a warning page vs blocked.
Definition results.h:397
Safe Browsing error on initialization.
Definition results.h:319
Safe Browsing error.
Definition results.h:383
Safe Browsing result.
Definition results.h:327
SpeedifySDK_SafeBro_Error_Header bool initialized
If Safe Browsing is initialized.
Definition results.h:332
SpeedifySDK_SafeBrowsingSafeNetworkOverride snOverride
Safe Network decision override.
Definition results.h:344
bool configSet
If the additional config is set.
Definition results.h:335
SpeedifySDK_SafeBrowsingLogLevel logLevel
The Safe Browsing logging level.
Definition results.h:341
bool enabled
If Safe Browsing is enabled.
Definition results.h:338
Safe Browsing Stats.
Definition results.h:349
uint32_t avgTime
The average lookup time (ms)
Definition results.h:359
double failureRate
The lookup failure rate.
Definition results.h:368
uint32_t minTime
The fastest lookup time (ms)
Definition results.h:353
uint32_t numBlocks
The number of safe browsing blocks.
Definition results.h:365
uint32_t numBlockResponses
The number of server responses requesting the SDK block or redirect the connection.
Definition results.h:372
uint32_t maxTime
The slowest lookup time (ms)
Definition results.h:356
uint32_t numErrors
The number of safe browsing errors.
Definition results.h:362
uint64_t numLookups
The number of completed requests to the safe browsing server.
Definition results.h:375
uint64_t numPacketsFiltered
The number of safe browsing filtered packets.
Definition results.h:378
Detailed information about a server.
Definition types.h:153
Automatic server selection method settings.
Definition types.h:493
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:1132
Session Stats result.
Definition results.h:148
SpeedifySDK_SessionStatPeriods sessionStats
Session stats.
Definition results.h:152
Speedify settings.
Definition types.h:644
Settings result.
Definition results.h:121
SpeedifySDK_Settings settings
Settings.
Definition results.h:125
Results of a speed test.
Definition types.h:1734
Speed test result.
Definition results.h:423
uint16_t resultsCount
How many results are in the list.
Definition results.h:427
State result.
Definition results.h:42
SpeedifySDK_State state
Current state.
Definition results.h:46
Settings for the priority streaming.
Definition types.h:1316
Streaming settings result.
Definition results.h:281
SpeedifySDK_StreamingSettings streamingSettings
Streaming settings.
Definition results.h:285
Streaming mode stats.
Definition types.h:1488
Streaming stats result.
Definition results.h:300
SpeedifySDK_StreamingStats streamingStats
Streaming stats.
Definition results.h:304
Torrent detection result.
Definition results.h:208
bool willDisconnect
If this detection will force a disconnect.
Definition results.h:212
Vendor settings result.
Definition results.h:250
const char * settingsJson
Settings json as a string.
Definition results.h:256
Vendor user data result.
Definition results.h:261
const char * userData
Settings json as a string.
Definition results.h:267
Version structure.
Definition types.h:58
Version result.
Definition results.h:51
SpeedifySDK_Version version
Definition results.h:55
SpeedifySDK_NetworkSharingPeerRole
peer role
Definition types.h:1791
SpeedifySDK_EXTERN typedef char SpeedifySDK_NetworkSharingDisplayName[SPEEDIFYSDK_MAX_NETWORKSHARING_DISPLAY_NAME_LENGTH]
The public display name for this device.
Definition types.h:1784
SpeedifySDK_NetworkType
Type of network adapter.
Definition types.h:319
SpeedifySDK_NetworkSharingPeerStatus
Status of a NetworkSharing Peer Connection.
Definition types.h:1871
SpeedifySDK_SafeBrowsingSafeNetworkOverride
Override safe network decisions.
Definition types.h:1713
SpeedifySDK_State
State of the VPN.
Definition types.h:79
SpeedifySDK_SafeBrowsingLogLevel
Log levels in the SDK.
Definition types.h:1700
SpeedifySDK_EXTERN typedef char SpeedifySDK_NetworkSharingPeerUuid[SPEEDIFYSDK_NETWORKSHARING_PEER_UUID_LENGTH]
Peer UUID for network sharing peer data.
Definition types.h:1787
SpeedifySDK_NetworkSharingTunnelStatus
Status of a NetworkSharing tunnel.
Definition types.h:1889