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...
double	lossReceive
	receive loss ratio (0.0-1.0) More...
double	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...
uint32_t	numberOfSockets
	Number of active sockets for this connection. More...
SpeedifySDK_IPAddressString	remoteIp
	internet facing ip address of the tunnel. More...
int64_t	totalBps
	bits per second through this tunnel More...
int64_t	sendBps
	bits per second sent through this tunnel. More...
int64_t	receiveBps
	bits per second received through this tunnel. More...
double	sendEstimateMbps
	estimated maximum megabits per second send. More...
double	receiveEstimateMbps
	estimated maximum megabits per second received. More...
int32_t	jitterMs
	Jitter, in milliseconds. More...
float	mos
	Mean Opinion Score, 1-5. More...
uint64_t	sendBytes
	bytes sent More...
uint64_t	receiveBytes
	bytes 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

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

---

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

• include/speedifysdk/types.h