Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the develop branch, built from commit 7b2e2ccfed.
PrevUpHomeNext
websocket::stream::write (1 of 2 overloads)

Write a complete message.

Synopsis
template<
    class ConstBufferSequence>
std::size_t
write(
    ConstBufferSequence const& buffers);
Description

This function is used to write a complete message. The call blocks until one of the following is true:

The algorithm, known as a composed operation, is implemented in terms of calls to the next layer's write_some function. The current setting of the binary option controls whether the message opcode is set to text or binary. If the auto_fragment option is set, the message will be split into one or more frames as necessary. The actual payload contents sent may be transformed as per the WebSocket protocol settings.

Parameters

Name

Description

buffers

The buffers containing the message to send.

Return Value

The number of bytes sent from the buffers.

Exceptions

Type

Thrown On

system_error

Thrown on failure.


PrevUpHomeNext