Speedify SDK for Desktop  10.7.0
Data Fields
SpeedifySDK_ConnectionStats Struct Reference

Detailed Description

Statistics about a connection.

There is one of these per socket that Speedify creates to make the VPN. Each one is bound to run over a single one of your internet connections. It's possible for there to be more than one on a single internet connection.

Since
7.5

#include <types.h>

Data Fields

int64_t inFlight
 bytes currently in flight More...
 
int64_t inFlightWindow
 inflight window, bytes More...
 
bool connected
 is connected More...
 
bool sleeping
 is sleeping. Used on Cellular connections to improve battery life. More...
 
char adapterID [SPEEDIFYSDK_MAX_ADAPTER_NAME]
 Adapter unique ID. More...
 
char connectionID [SPEEDIFYSDK_MAX_ADAPTER_NAME]
 Connection identifier. More...
 
SpeedifySDK_IPAddressString localIp
 internet facing ip address of the adapter. More...
 
int64_t lossReceive
 receive loss ratio (0.0-1.0) More...
 
int64_t lossSend
 send loss ratio (0.0-1.0) More...
 
int64_t latencyMs
 latency, milliseconds More...
 
SpeedifySDK_IPAddressString privateIp
 local ip address of the adapter. More...
 
SpeedifySDK_TransportMode protocol
 protocol used for the tunnel. More...
 
SpeedifySDK_IPAddressString remoteIp
 internet facing up address of the tunnel. More...
 
int64_t totalBps
 bytes per second through this tunnel More...
 
int64_t sendBps
 bytes per second sent through this tunnel. More...
 
int64_t receiveBps
 bytes per second received through this tunnel. More...
 
double sendEstimateMbps
 estimated maximum megabytes per second send. More...
 
double receiveEstimateMbps
 estimated maximum megabytes per second received. More...
 

Field Documentation

◆ adapterID

char SpeedifySDK_ConnectionStats::adapterID[SPEEDIFYSDK_MAX_ADAPTER_NAME]

Adapter unique ID.

Since
7.5

◆ connected

bool SpeedifySDK_ConnectionStats::connected

is connected

Since
7.5

◆ connectionID

char SpeedifySDK_ConnectionStats::connectionID[SPEEDIFYSDK_MAX_ADAPTER_NAME]

Connection identifier.

Not available on historic tunnel stat updates.

Since
7.5

◆ inFlight

int64_t SpeedifySDK_ConnectionStats::inFlight

bytes currently in flight

Not available on 'speedify' adapter.

Since
7.5

◆ inFlightWindow

int64_t SpeedifySDK_ConnectionStats::inFlightWindow

inflight window, bytes

Not available on 'speedify' adapter.

Since
7.5

◆ latencyMs

int64_t SpeedifySDK_ConnectionStats::latencyMs

latency, milliseconds

Since
7.5

◆ localIp

SpeedifySDK_IPAddressString SpeedifySDK_ConnectionStats::localIp

internet facing ip address of the adapter.

Not available on historic tunnel stat updates. Not available on 'speedify' adapter.

Since
7.5

◆ lossReceive

int64_t SpeedifySDK_ConnectionStats::lossReceive

receive loss ratio (0.0-1.0)

Not available on 'speedify' adapter.

Since
7.5

◆ lossSend

int64_t SpeedifySDK_ConnectionStats::lossSend

send loss ratio (0.0-1.0)

Not available on 'speedify' adapter.

Since
7.5

◆ privateIp

SpeedifySDK_IPAddressString SpeedifySDK_ConnectionStats::privateIp

local ip address of the adapter.

Not available on historic tunnel stat updates. Not available on 'speedify' adapter.

Since
7.5

◆ protocol

SpeedifySDK_TransportMode SpeedifySDK_ConnectionStats::protocol

protocol used for the tunnel.

Not available on historic tunnel stat updates. Not available on 'speedify' adapter.

Since
7.5

◆ receiveBps

int64_t SpeedifySDK_ConnectionStats::receiveBps

bytes per second received through this tunnel.

Not available on historic tunnel stat updates.

Since
7.5

◆ receiveEstimateMbps

double SpeedifySDK_ConnectionStats::receiveEstimateMbps

estimated maximum megabytes per second received.

Not available on historic tunnel stat updates. Not available on 'speedify' adapter.

Since
7.5

◆ remoteIp

SpeedifySDK_IPAddressString SpeedifySDK_ConnectionStats::remoteIp

internet facing up address of the tunnel.

Not available on historic tunnel stat updates. Not available on 'speedify' adapter.

Since
7.5

◆ sendBps

int64_t SpeedifySDK_ConnectionStats::sendBps

bytes per second sent through this tunnel.

Not available on historic tunnel stat updates.

Since
7.5

◆ sendEstimateMbps

double SpeedifySDK_ConnectionStats::sendEstimateMbps

estimated maximum megabytes per second send.

Not available on historic tunnel stat updates. Not available on 'speedify' adapter.

Since
7.5

◆ sleeping

bool SpeedifySDK_ConnectionStats::sleeping

is sleeping. Used on Cellular connections to improve battery life.

Since
7.5

◆ totalBps

int64_t SpeedifySDK_ConnectionStats::totalBps

bytes per second through this tunnel

Since
7.5

The documentation for this struct was generated from the following file: