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 163ccb9650.

basic_stream::connect (4 of 10 overloads)

Establishes a connection by trying each endpoint in a sequence.

Synopsis

template<
    class EndpointSequence>
Protocol::endpoint
connect(
    EndpointSequence const& endpoints,
    error_code& ec);

Description

This function attempts to connect the stream to one of a sequence of endpoints by trying each endpoint until a connection is successfully established. The underlying socket is automatically opened if needed. An automatically opened socket is not returned to the closed state upon failure.

The algorithm, known as a composed operation, is implemented in terms of calls to the underlying socket's connect function.

Parameters

Name	Description
`endpoints`	A sequence of endpoints.
`ec`	Set to indicate what error occurred, if any. If the sequence is empty, set to `net::error::not_found`. Otherwise, contains the error from the last connection attempt.

Return Value

On success, the successfully connected endpoint. Otherwise, a default-constructed endpoint.