Timeouts

While [link beast.ref.boost__beast__basic_stream `basic_stream`] and [link beast.ref.boost__beast__basic_stream `tcp_stream`] support timeouts on general logical operations, the websocket stream has a more sophisticated timeout mechanism built-in which may be enabled and configured. The timeout features of the TCP or basic stream should not be used when working with a websocket stream. The interface to these timeout features is shown in this table.

WebSocket Timeout Interface

Name

Description

[link beast.ref.boost__beast__websocket__stream_base__timeout `stream_base::timeout`]

This represents configured timeout settings for a websocket stream.

[link beast.ref.boost__beast__websocket__stream_base__timeout.suggested `stream_base::timeout::suggested`]

This function returns the suggested timeout settings for a given role (client or server).

[link beast.ref.boost__beast__websocket__stream.set_option `stream::set_option`]

This function sets timeout and other options on the stream.

There are three timeout settings which may be set independently on the stream:

WebSocket Timeout Interface (2)

Name

Type

Description

[link beast.ref.boost__beast__websocket__stream_base__timeout.handshake_timeout `timeout::handshake_timeout`]

`duration`

This is the amount of time after which a handshake will time out. The handshake timeout applies to client handshakes, server handshakes, as well as the websocket closing handshake performed when either end of the connection wish to shut down. The value returned by [link beast.ref.boost__beast__websocket__stream_base.none `stream_base::none()`] may be assigned to disable this timeout.

[link beast.ref.boost__beast__websocket__stream_base__timeout.idle_timeout `timeout::idle_timeout`]