Speedify SDK for Desktop/Embedded  15.0.1
Data Fields
SpeedifySDK_Settings Struct Reference

Detailed Description

Speedify settings.

Since
7.5

#include <types.h>

Data Fields

bool jumboPackets
 Whether to allow jumbo packets over the VPN tunnel. More...
 
bool encrypted
 Whether all connections will be enabled. More...
 
bool allowChaChaEncryption
 Whether the use of ChaCha is allowed for connection encryption. More...
 
SpeedifySDK_BondingMode bondingMode
 The current bonding mode. More...
 
bool startupConnect
 If Speedify will automatically connect when the daemon starts. More...
 
SpeedifySDK_TransportMode transportMode
 Currently used connection transport mode selection. More...
 
uint16_t portsCount
 Number of configured ports to forward. More...
 
SpeedifySDK_ForwardedPort forwardedPorts [SPEEDIFYSDK_MAX_FORWARD_PORTS]
 Ports to forward when connected to private servers. More...
 
uint16_t downstreamSubnetsCount
 Number of configured downstream subnets. More...
 
SpeedifySDK_Subnet downstreamSubnets [SPEEDIFYSDK_MAX_DOWNSTREAM_SUBNETS]
 downstream subnets available on this device. More...
 
bool perConnectionEncryptionEnabled
 If per-connection encryption is being used. More...
 
uint16_t perConnectionEncryptionCount
 Number of configured per-connection encryption settings. More...
 
SpeedifySDK_PerConnectionEncryption perConnectionEncryptionSettings [SPEEDIFYSDK_MAX_ADAPTERS]
 Per connection encryption settings. More...
 
uint16_t perConnectionExposeDscpCount
 Number of configured per-connection expose DSCP settings. Only supported on Linux. More...
 
SpeedifySDK_PerConnectionExposeDscp perConnectionExposeDscpSettings [SPEEDIFYSDK_MAX_ADAPTERS]
 Per connection expose DSCP settings. Only supported on Linux. More...
 
uint16_t perConnectionParallelSocketsCount
 Number of configured per-connection parallel socket settings. More...
 
SpeedifySDK_PerConnectionParallelSockets perConnectionParallelSockets [SPEEDIFYSDK_MAX_ADAPTERS]
 Per connection parallel sockets. More...
 
double overflowThreshold
 Overflow threshold, in megabits per second. More...
 
double priorityOverflowThreshold
 Priority overflow threshold, in megabits per second. More...
 
bool packetAggregation
 Whether packet aggregation is enabled. More...
 
bool enableDefaultRoute
 Whether the default route goes over the VPN tunnel. More...
 
bool headerCompression
 Whether header compression is enabled. More...
 
char language [SPEEDIFYSDK_MAX_LANGUAGE_LEN]
 2-character ISO language code used for error messages, ie: 'en'. More...
 
bool enableAutomaticPriority
 If automatic connection priorites are enabled. More...
 
unsigned long ulpReportIntervalSeconds
 Represents the ULP reporting interval in seconds. More...
 
uint32_t maxRedundant
 The maximum number of connections used to send redundant packets. More...
 
uint32_t maximumConnectRetry
 maximum time between login/connect retries, in seconds More...
 
uint32_t maximumTransportRetry
 maximum time between transport connection retries, in seconds More...
 
char packetPoolSize [SPEEDIFYSDK_MAX_PACKET_POOL_NAME_LENGTH]
 size of the packet pool More...
 
SpeedifySDK_TargetNumberOfConnections targetNumberOfConnections
 The target number of connections for the VPN tunnel. More...
 

Field Documentation

◆ allowChaChaEncryption

bool SpeedifySDK_Settings::allowChaChaEncryption

Whether the use of ChaCha is allowed for connection encryption.

Since
7.5

◆ bondingMode

SpeedifySDK_BondingMode SpeedifySDK_Settings::bondingMode

The current bonding mode.

Since
7.5

◆ downstreamSubnets

SpeedifySDK_Subnet SpeedifySDK_Settings::downstreamSubnets[SPEEDIFYSDK_MAX_DOWNSTREAM_SUBNETS]

downstream subnets available on this device.

Since
14.0

◆ downstreamSubnetsCount

uint16_t SpeedifySDK_Settings::downstreamSubnetsCount

Number of configured downstream subnets.

Since
14.0

◆ enableAutomaticPriority

bool SpeedifySDK_Settings::enableAutomaticPriority

If automatic connection priorites are enabled.

Since
12.4

◆ enableDefaultRoute

bool SpeedifySDK_Settings::enableDefaultRoute

Whether the default route goes over the VPN tunnel.

Since
9.4

◆ encrypted

bool SpeedifySDK_Settings::encrypted

Whether all connections will be enabled.

If false, individual connections may still be encrypted.

Since
7.5

◆ forwardedPorts

SpeedifySDK_ForwardedPort SpeedifySDK_Settings::forwardedPorts[SPEEDIFYSDK_MAX_FORWARD_PORTS]

Ports to forward when connected to private servers.

Since
7.5

◆ headerCompression

bool SpeedifySDK_Settings::headerCompression

Whether header compression is enabled.

Since
10.6

◆ jumboPackets

bool SpeedifySDK_Settings::jumboPackets

Whether to allow jumbo packets over the VPN tunnel.

Since
7.5

◆ language

char SpeedifySDK_Settings::language[SPEEDIFYSDK_MAX_LANGUAGE_LEN]

2-character ISO language code used for error messages, ie: 'en'.

Since
10.8

◆ maximumConnectRetry

uint32_t SpeedifySDK_Settings::maximumConnectRetry

maximum time between login/connect retries, in seconds

Since
14.6

◆ maximumTransportRetry

uint32_t SpeedifySDK_Settings::maximumTransportRetry

maximum time between transport connection retries, in seconds

Since
14.6

◆ maxRedundant

uint32_t SpeedifySDK_Settings::maxRedundant

The maximum number of connections used to send redundant packets.

Since
14.6

◆ overflowThreshold

double SpeedifySDK_Settings::overflowThreshold

Overflow threshold, in megabits per second.

Since
7.5

◆ packetAggregation

bool SpeedifySDK_Settings::packetAggregation

Whether packet aggregation is enabled.

Since
8.0

◆ packetPoolSize

char SpeedifySDK_Settings::packetPoolSize[SPEEDIFYSDK_MAX_PACKET_POOL_NAME_LENGTH]

size of the packet pool

Since
14.8.5

◆ perConnectionEncryptionCount

uint16_t SpeedifySDK_Settings::perConnectionEncryptionCount

Number of configured per-connection encryption settings.

Since
7.5

◆ perConnectionEncryptionEnabled

bool SpeedifySDK_Settings::perConnectionEncryptionEnabled

If per-connection encryption is being used.

Since
7.5

◆ perConnectionEncryptionSettings

SpeedifySDK_PerConnectionEncryption SpeedifySDK_Settings::perConnectionEncryptionSettings[SPEEDIFYSDK_MAX_ADAPTERS]

Per connection encryption settings.

Since
7.5

◆ perConnectionExposeDscpCount

uint16_t SpeedifySDK_Settings::perConnectionExposeDscpCount

Number of configured per-connection expose DSCP settings. Only supported on Linux.

Since
14.6

◆ perConnectionExposeDscpSettings

SpeedifySDK_PerConnectionExposeDscp SpeedifySDK_Settings::perConnectionExposeDscpSettings[SPEEDIFYSDK_MAX_ADAPTERS]

Per connection expose DSCP settings. Only supported on Linux.

Since
14.6

◆ perConnectionParallelSockets

SpeedifySDK_PerConnectionParallelSockets SpeedifySDK_Settings::perConnectionParallelSockets[SPEEDIFYSDK_MAX_ADAPTERS]

Per connection parallel sockets.

Since
10.9.5

◆ perConnectionParallelSocketsCount

uint16_t SpeedifySDK_Settings::perConnectionParallelSocketsCount

Number of configured per-connection parallel socket settings.

Since
10.9.5

◆ portsCount

uint16_t SpeedifySDK_Settings::portsCount

Number of configured ports to forward.

Since
7.5

◆ priorityOverflowThreshold

double SpeedifySDK_Settings::priorityOverflowThreshold

Priority overflow threshold, in megabits per second.

Since
12.0

◆ startupConnect

bool SpeedifySDK_Settings::startupConnect

If Speedify will automatically connect when the daemon starts.

Since
7.5

◆ targetNumberOfConnections

SpeedifySDK_TargetNumberOfConnections SpeedifySDK_Settings::targetNumberOfConnections

The target number of connections for the VPN tunnel.

Since
14.8.7

◆ transportMode

SpeedifySDK_TransportMode SpeedifySDK_Settings::transportMode

Currently used connection transport mode selection.

Since
7.5

◆ ulpReportIntervalSeconds

unsigned long SpeedifySDK_Settings::ulpReportIntervalSeconds

Represents the ULP reporting interval in seconds.

Since
12.8

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