Speedify SDK for Desktop/Embedded 15.5.0
Loading...
Searching...
No Matches
SpeedifySDK_ConnectionStats Struct Reference

Statistics about a connection. More...

#include <types.h>

Data Fields

int64_t inFlight
 bytes currently in flight
 
int64_t inFlightWindow
 inflight window, bytes
 
bool connected
 is connected
 
bool sleeping
 is sleeping. Used on Cellular connections to improve battery life.
 
char adapterID [SPEEDIFYSDK_MAX_ADAPTER_NAME]
 Adapter unique ID.
 
char connectionID [SPEEDIFYSDK_MAX_ADAPTER_NAME]
 Connection identifier.
 
SpeedifySDK_IPAddressString localIp
 internet facing ip address of the adapter.
 
double lossReceive
 receive loss ratio (0.0-1.0)
 
double lossSend
 send loss ratio (0.0-1.0)
 
int64_t latencyMs
 latency, milliseconds
 
SpeedifySDK_IPAddressString privateIp
 local ip address of the adapter.
 
SpeedifySDK_TransportMode protocol
 protocol used for the tunnel.
 
uint32_t numberOfSockets
 Number of active sockets for this connection.
 
SpeedifySDK_IPAddressString remoteIp
 internet facing ip address of the tunnel.
 
int64_t totalBps
 bits per second through this tunnel
 
int64_t sendBps
 bits per second sent through this tunnel.
 
int64_t receiveBps
 bits per second received through this tunnel.
 
double sendEstimateMbps
 estimated maximum megabits per second send.
 
double receiveEstimateMbps
 estimated maximum megabits per second received.
 
int32_t jitterMs
 Jitter, in milliseconds.
 
float mos
 Mean Opinion Score, 1-5.
 
uint64_t sendBytes
 bytes sent
 
uint64_t receiveBytes
 bytes received
 
bool congested
 True if the connection is upload or download congested.
 
bool uploadCongested
 True if the connection is congested in the upload direction.
 
bool downloadCongested
 True if the connection is congested in the download direction.
 

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

Field Documentation

◆ adapterID

char SpeedifySDK_ConnectionStats::adapterID[SPEEDIFYSDK_MAX_ADAPTER_NAME]

Adapter unique ID.

Since
7.5

◆ congested

bool SpeedifySDK_ConnectionStats::congested

True if the connection is upload or download congested.

Not available on historic tunnel stat updates.

Since
14.8.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

◆ downloadCongested

bool SpeedifySDK_ConnectionStats::downloadCongested

True if the connection is congested in the download direction.

Not available on historic tunnel stat updates.

Since
15.4

◆ 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

◆ jitterMs

int32_t SpeedifySDK_ConnectionStats::jitterMs

Jitter, in milliseconds.

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

Since
11.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

double SpeedifySDK_ConnectionStats::lossReceive

receive loss ratio (0.0-1.0)

Not available on 'speedify' adapter.

Since
7.5

◆ lossSend

double SpeedifySDK_ConnectionStats::lossSend

send loss ratio (0.0-1.0)

Not available on 'speedify' adapter.

Since
7.5

◆ mos

float SpeedifySDK_ConnectionStats::mos

Mean Opinion Score, 1-5.

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

Since
11.5

◆ numberOfSockets

uint32_t SpeedifySDK_ConnectionStats::numberOfSockets

Number of active sockets for this connection.

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

Since
10.9.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 'speedify' adapter.

Since
7.5

◆ receiveBps

int64_t SpeedifySDK_ConnectionStats::receiveBps

bits per second received through this tunnel.

Not available on historic tunnel stat updates.

Since
7.5

◆ receiveBytes

uint64_t SpeedifySDK_ConnectionStats::receiveBytes

bytes received

Not available on historic tunnel stat updates.

Since
14.0

◆ receiveEstimateMbps

double SpeedifySDK_ConnectionStats::receiveEstimateMbps

estimated maximum megabits 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 ip 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

bits per second sent through this tunnel.

Not available on historic tunnel stat updates.

Since
7.5

◆ sendBytes

uint64_t SpeedifySDK_ConnectionStats::sendBytes

bytes sent

Not available on historic tunnel stat updates.

Since
14.0

◆ sendEstimateMbps

double SpeedifySDK_ConnectionStats::sendEstimateMbps

estimated maximum megabits 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

bits per second through this tunnel

Since
7.5

◆ uploadCongested

bool SpeedifySDK_ConnectionStats::uploadCongested

True if the connection is congested in the upload direction.

Not available on historic tunnel stat updates.

Since
15.4

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