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 an old version of Boost. Click here to view this page for the latest version.
PrevUpHomeNext
websocket::stream::write (2 of 2 overloads)

Write a message to the stream.

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

This function is used to synchronously write a message to the stream. The call blocks until one of the following conditions is met:

This operation is implemented in terms of one or more calls to the next layer's write_some function.

The current setting of the websocket::stream::binary option controls whether the message opcode is set to text or binary. If the websocket::stream::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 entire message payload. The implementation will make copies of this object as needed, but ownership of the underlying memory is not transferred. The caller is responsible for ensuring that the memory locations pointed to by buffers remains valid until the completion handler is called.

Return Value

The number of bytes written from the buffers. If an error occurred, this will be less than the sum of the buffer sizes.

Parameters

Name

Description

ec

Set to indicate what error occurred, if any.

Exceptions

Type

Thrown On

system_error

Thrown on failure.

Remarks

This function always sends an entire message. To send a message in fragments, use websocket::stream::write_some.


PrevUpHomeNext