source: xplcommon/src/xplcommon/posix/Connector.h@ 14:3caa1d3122db

// Copyright (c) 2012 by István Váradi

// This file is part of libxplcommon, a common utility library for
// development related to X-Plane

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:

// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// The views and conclusions contained in the software and documentation are those
// of the authors and should not be interpreted as representing official policies,
// either expressed or implied, of the FreeBSD Project.

#ifndef XPLCOMMON_POSIX_CONNECTOR_H
#define XPLCOMMON_POSIX_CONNECTOR_H
//------------------------------------------------------------------------------

#include "../Failable.h"

#include "ClientSocket.h"

#include <cstdlib>

//------------------------------------------------------------------------------

struct sockaddr;

//------------------------------------------------------------------------------

namespace xplcommon { namespace posix {

//------------------------------------------------------------------------------

/**
 * Class representing the creation of a connection to some remote
 * entity, like a socket or a pipe.
 */
class Connector : public FailableReference<Connector>
{
private:
    /**
     * The socket on behalf of which the connection is being
     * performed.
     */
    ClientSocket& socket;

    /**
     * Indicate that we are in the process of connecting.
     */
    bool connecting;

    /**
     * Indicate that we are connected.
     */
    bool connected;

protected:
    /**
     * Construct the connector.
     */
    Connector(ClientSocket* socket);

public:
    /**
     * Connect to an address properly set up.
     *
     * If the connection succeeds immediately, it indicates success.
     *
     * If the connection does not succeed, because it would block, it
     * sets up the socket to wait for the connection to succeed, and
     * returns failure.
     *
     * If the connection fails for another reason, the error code is
     * set, and false is returned.
     */
    bool connect();

protected:
    /**
     * Get the parameters for connecting.
     */
    virtual const struct sockaddr* getAddress(size_t& addrlen) = 0;

    /**
     * Handle the event that the socket is writable.
     *
     * If connection is in progress, this function returns
     * immediately.
     *
     * Otherwise it reads the error code using getsockopt(), and if it
     * indicates success, the connector is set to connected, otherwise
     * it is set to failed.
     */
    void handleWritable();

private:
    /**
     * Get the failable object.
     */
    const ::xplcommon::Failable& getFailable() const;

    /**
     * Get the failable object.
     */
    ::xplcommon::Failable& getFailable();

    friend class FailableReference<Connector>;
    friend class ClientSocket;
};

//------------------------------------------------------------------------------
// Inline definitions
//------------------------------------------------------------------------------

inline Connector::Connector(ClientSocket* socket) :
    socket(*socket),
    connecting(false),
    connected(false)
{
}

//------------------------------------------------------------------------------

inline const ::xplcommon::Failable& Connector::getFailable() const
{
    return socket;
}

//------------------------------------------------------------------------------

inline ::xplcommon::Failable& Connector::getFailable()
{
    return socket;
}

//------------------------------------------------------------------------------

} /* namespace xplcommon::posix */ } /* namespace xplcommon */

//------------------------------------------------------------------------------
#endif // XPLCOMMON_POSIX_CONNECTOR_H

// Local Variables:
// mode: C++
// c-basic-offset: 4
// indent-tabs-mode: nil
// End: