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 eadce7af2c.
PrevUpHomeNext
basic_stream::connect (8 of 10 overloads)

Establishes a connection by trying each endpoint in a sequence.

Synopsis
template<
    class EndpointSequence,
    class ConnectCondition>
Protocol::endpoint
connect(
    EndpointSequence const& endpoints,
    ConnectCondition connect_condition,
    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.

connect_condition

A function object that is called prior to each connection attempt. The signature of the function object must be:

bool connect_condition(
    error_code const& ec,
    typename Protocol::endpoint const& next);

The ec parameter contains the result from the most recent connect operation. Before the first connection attempt, ec is always set to indicate success. The next parameter is the next endpoint to be tried. The function object should return true if the next endpoint should be tried, and false if it should be skipped.

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.


PrevUpHomeNext