Field

Value or Description

tx_over_timeout

The client transmit overflow timeout. This is the number of milliseconds the client waits when its transmit buffer is full before starting to drop transmit bytes. A value of 0 means no timeout.

Minimum value:  0

Maximum value: 65535

Default value: 0

tx_buf_timeout

The client transmit buffering timeout. This is the number of milliseconds the client waits for its transmit buffer to become full before sending its buffered transmit bytes. A value of 0 means that the client will transmit its data only when its buffer becomes full.

Minimum value: 0

Maximum value: 65535

Default value: 100

hb_interval

The client heartbeat interval, in milliseconds.

While a Storage Redirection session is open, the client periodically sends heartbeat messages to make sure that the library’s receive timeout does not expire. The value in this field is the number of milliseconds between heartbeat messages sent by the client. (For heartbeat messages sent in the other direction, from the library to the client, see the rx_timeout field below.)

If the value is non-zero, it should never be set to less than 100. Depending on network conditions, an even longer interval may be required. The recommended value is at least 1000 (one second).

Since a vPro Gateway server (MPS) has a 30-second heartbeat, redirection sessions over an MPS should have a heartbeat interval that is less than 30 seconds to avoid sessions halting prematurely.

A value of 0 in this field means that no heartbeat messages should be sent, in which case the library will send USB-R keep-alive ping messages to the client when there is no activity to determine if it is still alive.

Minimum value: 0

Maximum value: 65535

Default value: 5000

Note:

The library will set its receive timeout based on the value of the Timeout_Factor that you add to its .ini File. Timeout_Factor is the number of heartbeats that need to be missed in order for the timeout to trigger; in other words, the library’s receive timeout is determined by the following equation:

Library receive timeout = hb_interval * Timeout_Factor

The default value of the Timeout_Factor is 3, so the default library receive timeout is 15000 ms (thanks to the default hb_interval of 5000 ms).

fifo_rx_flush_timeout

The client’s FIFO receive flush timeout. This is the number of milliseconds the client waits when its receive FIFO is full before flushing its received data. A value of 0 means that the client never flushes its received data when it is not read by the operating system.

Minimum value:  0

Maximum value: 65535

Default value: 100

( Use of a value below 100 is not recommended.   Sometimes data loss from the library to client can be prevented by lowering this value, even below the default 100.  A value of 0 causes the client to not flush the received data. As a result, if the buffer overflows, the client will cancel the session.)

rx_timeout

The client receive timeout, in milliseconds.

This field determines the behavior of heartbeat messages going in the opposite direction of those handled in the hb_interval field above: from the library to the client, rather than the reverse.

If the client receives no messages (including heartbeat messages) from the library for the duration of this timeout, it will shut down the Storage Redirection session.

Minimum value: 10000

Maximum value: 65535

Default value: 10000

Note:

The frequency of the heartbeat messages is determined by the HB_Factor that you add to the library’s .ini File. HB_Factor is the number of heartbeats that need to be missed in order for this timeout to trigger; in other words, the interval between heartbeat messages sent from the library to the client is determined by the following equation:

Library heartbeat interval = rx_timeout / HB_Factor

The default value of the HB_Factor is 3, so the default interval between heartbeat messages is 3333.3 ms (thanks to the default timeout of 10000 ms).