set realport
Purpose
Configures and displays RealPort-related settings.
Required permissions
For Digi products with two or more users, permissions must be set to set permissions s-network=read to display settings, and set permissions s-network=rw to display and configure settings. See set permissions for details on setting user permissions for commands.
Syntax
Configure RealPort settings
set realport [keepalive={on|off}]
[exclusive={on|off}]
[authentication={on|off}]
[sharedsecret=string]
Display current RealPort settings
set realport
Options
keepalive={on|off}
Enables or disables sending of RealPort keepalives. RealPort keepalives are messages inside the RealPort protocol, sent approximately every 10 seconds, to tell whoever is connected that the connection is still alive. RealPort keepalives are different from TCP keepalives, which are done at the TCP layer, and configurable. The default is on.
As RealPort keepalives generate additional traffic--several bytes every 10 seconds--this option allows you to turn them off. RealPort keepalives may cause issues in environments that are metered for traffic, or that do not require this type of mechanism. In situations such as cellular/mobile wireless communications, when you are paying by the byte, such additional traffic is undesirable when a TCP keepalive can do the same job, and only when the connection is idle.
If you want to have the RealPort keepalive set to off, consider using a TCP keepalive instead. If the link is not closed properly, it could result with your port being “locked up” with a dead TCP session.
exclusive={on|off}
Enables or disables exclusive mode for RealPort connections. Exclusive mode allows the Digi device to close an existing RealPort connection and establish a new one immediately upon a new connection request from the same IP address. This mode is useful when using RealPort over wide area networks, which can be unstable and where you are charged by the byte (such as cellular or satellite), and you do not wish to incur costs for keep-alive traffic. Exclusive mode allows your application to retain continuity when temporary, unexpected interruptions in network connectivity occur.
authentication={on|off}
Enables or disables shared-secret authentication between the RealPort client and server.
sharedsecret=string
The shared secret is a 1-to-16-character password that is exchanged (in an encrypted form) between the RealPort client and server. If authentication is: Not enabled in both the client and server, not disabled in both, or the shared secret is not the same in both, communications cannot be established.
Example
#> set realport keepalive=on
See also
- revert: The revert realport command reverts the settings configured by this command.
- set autoconnect
- set dirp: This command configures Device-Initiated RealPort connections, where the Digi device initiates RealPort connections, rather than a driver running on Windows, Unix, or Linux initiating the connection.
- set network: The set network keepalive options (idle, probe_count, probe_interval, garbage_byte, and override_dhcp) should be configured for various services that are configured by “set service keepalive={on|off}, or clients such as autoconnect (set autoconnect keepalive={on|off}”).
- set service
- show: The show realport command shows the current RealPort settings in a Digi device.
- For ConnectPort X2 gateways, RealPort can be used to directly access the XBee RF module on a gateway. See Direct Access communication with the XBee RF module on ConnectPort X2 gateways.
PDF
