TCP Client

tcp.client.auto_interface

Abbreviationtc c i
Accessget/set

Description

Interface to auto-start TCP client connection.

Arguments

default

Default

<default/wlan/softap>

Properties

Supported Platforms

Get example

> get tcp.client.auto_interface
default

Set example

> set tc c i wlan
Set OK

tcp.client.auto_retries

Abbreviationtc c e
Accessget/set

Description

Determines number of attempts to reconnect after remote server disconnects client.

To control how the client connects to the server, use tcp.client.retries, tcp.client.connect_timeout and tcp.client.retry_period.

Arguments

<0-255>

Default

0

Properties

Supported Platforms

Get example

> get tcp.client.auto_retries
0

Set example

set tc c e 20
Set OK

tcp.client.auto_start

Abbreviationtc c a
Accessget/set

Description

Enable/disable TCP client auto-start feature. If enabled, TCP client automatically connects to remote server when interface is brought up.

To enable TLS, see tcp.client.tls_enabled.

Arguments

<0/1>

Default

0

Supported Platforms

Get example

> get tcp.client.auto_start
0

Set example

> set tc c a 1
Set OK

tcp.client.connect_timeout

Abbreviationtc c t
Accessget/set

Description

TCP client connect timeout in milliseconds.

This variable controls timeout for the following commands:

Arguments

<milliseconds>

Default

5000

Properties

Supported Platforms

Get example

> get tc c t
R000006
5000

Set example

> set tc c t 6500
R000008
Set OK

tcp.client.local_port

Abbreviationtc c p
Accessget/set

Description

TCP client local port. 0 = automatic.

If you set this value, the first connection is made using the specified local port.

Subsequent additional TCP client connections determine the port by incrementing the last port used. If the specified port is X, the first subsequent connection uses port X+1. The next TCP client connection uses port X+2, and so on.

To reset the local port back to X, reboot the client.

Arguments

<port>

Default

0

Properties

Supported Platforms

Get example

> get tc c p
R000003
0

Set example

> set tc c p 30009
R000008
Set OK

tcp.client.remote_host

Abbreviationtc c h
Accessget/set

Description

Domain or IP address of remote tcp server to auto connect.

Arguments

<domain/ip address>

Default

null

Supported Platforms

Get example

> get tcp.client.remote_host
mydomain.com

Set example

> set tc c h mydomain.com
Set OK

tcp.client.remote_port

Abbreviationtc c o
Accessget/set

Description

Port of remote tcp server to auto connect.

Arguments

<port>

Default

3000

Supported Platforms

Get example

> get tcp.client.remote_port

Set example

> set tc c o 5000
Set OK

tcp.client.retries

Abbreviationtc c r
Accessget/set

Description

Maximum TCP client connection retry attempts.

Arguments

<max #retries>

Default

3

Properties

Supported Platforms

Get example

> get tc c r
R000003
3

Set example

> set tc c r 5
R000008
Set OK

tcp.client.retry_period

Abbreviationtc c w
Accessget/set

Description

TCP client wait time between connection retry attempts

Arguments

<milliseconds>

Default

1000

Properties

Supported Platforms

Get example

> get tc c w
R000006
1000

Set example

> set tc c w 2000
R000008
Set OK

tcp.client.tls_enabled

Abbreviationtc c s
Accessget/set

Supported Platforms

Description

Enables TLS for the tcp.client.auto_start feature.

The TLS certs are configured with the following variables:

Arguments

<0/1> where

Default

0

Get example

> get tc c s
0

Set example

> set tc c s 1
Set OK