SOLTout

This structure is used to pass time-out parameters when establishing an SOL session.

 Note:

   The parameters in this structure determine when either Intel AMT or the console will drop an SOL session because of a timeout. You will have to balance a quick response when a session should be dropped with allowing enough time for a response under slow network conditions. If timeouts do occur, you may need to extend the default values to a higher value.

   The redirection library uses the values in this structure to define an interval for heartbeats that it sends to Intel AMT and for a receive timeout. These parameters are:

library heartbeat interval = rx_timeout / 2

library receive timeout = hb_interval × 2

 

typedef struct {

unsigned short tx_over_timeout;

unsigned short tx_buf_timeout;

unsigned short hb_interval;

unsigned short fifo_rx_flush_timeout;

unsigned short rx_timeout;

} SOLTout;

 

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. This is the number of milliseconds the client waits between sending heartbeat messages to the library, indicating that the client is active. A value of 0 means that no heartbeats are sent. In this case, the library will not monitor the receive activity from the client to determine if it is active.

If the value is non-zero, it should never be set to less than 100, as the client may not have time to respond and the library will close the session prematurely. 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.

Minimum value: 0

Maximum value: 65535

Default value: 5000

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’s receive timeout. If this number of milliseconds passes before receiving any messages from the library, the client shuts down the SOL session. When an SOL session is open, the library periodically sends heartbeat messages to make sure that the client receive timeout does not expire (the interval between library heartbeat messages is based on the client receive timeout).

Minimum value: 10000

Maximum value: 65535

Default value: 10000

Copyright © 2006-2013, Intel Corporation. All rights reserved.