Speedify SDK for Desktop/Embedded 15.4.1
Loading...
Searching...
No Matches
SpeedifySDK_AdapterData Struct Reference

Information about a network adapter. More...

#include <types.h>

Data Fields

char adapterID [SPEEDIFYSDK_MAX_ADAPTER_NAME]
 Unique ID of the adapter.
 
char name [SPEEDIFYSDK_MAX_ADAPTER_NAME]
 Common name of the adapter.
 
char description [SPEEDIFYSDK_MAX_ADAPTER_NAME]
 Descriptive name of the adapter.
 
SpeedifySDK_ConnectionState state
 State of the connection over this adapter.
 
SpeedifySDK_NetworkType type
 Type of the adapter.
 
SpeedifySDK_ConnectionPriority priority
 Priority of connections over this adapter.
 
char connectedNetworkName [SPEEDIFYSDK_MAX_ADAPTER_NAME]
 Name of the connected network (Wi-Fi and Cellular only)
 
char connectedNetworkBSSID [SPEEDIFYSDK_MAX_ADAPTER_NAME]
 BSSID of the connected network (Wi-Fi only)
 
int64_t rateLimit
 Upload speed limit, in bits per second. Or zero if unlimited. This is provided for backwards compatibility, use rateLimitDownloadBps and rateLimitUploadBps instead.
 
int64_t rateLimitDownloadBps
 Download speed limit, in bits per second. Or zero if unlimited.
 
int64_t rateLimitUploadBps
 Upload speed limit, in bits per second. Or zero if unlimited.
 
SpeedifySDK_AdapterUsageData dataUsage
 Data usage and limit information for this adapter.
 
SpeedifySDK_ConnectionPriority workingPriority
 Effective priority of connections over this adapter.
 
char isp [SPEEDIFYSDK_MAX_ADAPTER_NAME]
 Internet Service Provider, if available.
 
SpeedifySDK_ConnectionDirectionalSettings directionalSettings
 Connection direction settings.
 

Detailed Description

Information about a network adapter.

Since
7.5

Field Documentation

◆ adapterID

char SpeedifySDK_AdapterData::adapterID[SPEEDIFYSDK_MAX_ADAPTER_NAME]

Unique ID of the adapter.

Since
7.5

◆ connectedNetworkBSSID

char SpeedifySDK_AdapterData::connectedNetworkBSSID[SPEEDIFYSDK_MAX_ADAPTER_NAME]

BSSID of the connected network (Wi-Fi only)

Since
7.5

◆ connectedNetworkName

char SpeedifySDK_AdapterData::connectedNetworkName[SPEEDIFYSDK_MAX_ADAPTER_NAME]

Name of the connected network (Wi-Fi and Cellular only)

Since
7.5

◆ dataUsage

SpeedifySDK_AdapterUsageData SpeedifySDK_AdapterData::dataUsage

Data usage and limit information for this adapter.

Since
7.5

◆ description

char SpeedifySDK_AdapterData::description[SPEEDIFYSDK_MAX_ADAPTER_NAME]

Descriptive name of the adapter.

Since
7.5

◆ directionalSettings

SpeedifySDK_ConnectionDirectionalSettings SpeedifySDK_AdapterData::directionalSettings

Connection direction settings.

Since
14.8.7

◆ isp

char SpeedifySDK_AdapterData::isp[SPEEDIFYSDK_MAX_ADAPTER_NAME]

Internet Service Provider, if available.

Since
12.4

◆ name

char SpeedifySDK_AdapterData::name[SPEEDIFYSDK_MAX_ADAPTER_NAME]

Common name of the adapter.

Since
7.5

◆ priority

SpeedifySDK_ConnectionPriority SpeedifySDK_AdapterData::priority

Priority of connections over this adapter.

Since
7.5

◆ rateLimit

int64_t SpeedifySDK_AdapterData::rateLimit

Upload speed limit, in bits per second. Or zero if unlimited. This is provided for backwards compatibility, use rateLimitDownloadBps and rateLimitUploadBps instead.

Since
7.5
Deprecated
As of future. Use rateLimitDownloadBps and rateLimitUploadBps instead.

◆ rateLimitDownloadBps

int64_t SpeedifySDK_AdapterData::rateLimitDownloadBps

Download speed limit, in bits per second. Or zero if unlimited.

Since
15.4

◆ rateLimitUploadBps

int64_t SpeedifySDK_AdapterData::rateLimitUploadBps

Upload speed limit, in bits per second. Or zero if unlimited.

Since
15.4

◆ state

SpeedifySDK_ConnectionState SpeedifySDK_AdapterData::state

State of the connection over this adapter.

Since
7.5

◆ type

SpeedifySDK_NetworkType SpeedifySDK_AdapterData::type

Type of the adapter.

Since
7.5

◆ workingPriority

SpeedifySDK_ConnectionPriority SpeedifySDK_AdapterData::workingPriority

Effective priority of connections over this adapter.

Since
12.4

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