source: xplcommon/src/xplcommon/win32/LocalConnector.h@ 21:eb59943050c9

// 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_WIN32_LOCALCONNECTOR_H
#define XPLCOMMON_WIN32_LOCALCONNECTOR_H
//------------------------------------------------------------------------------

#include "Completer.h"

#include "LocalSocket.h"

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

namespace xplcommon { namespace win32 {

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

class LocalConnector : public FailableReference<LocalConnector>
{
private:
    /**
     * The local socket to connect on behalf of which (it should
     * actually be a LocalClientSocket.
     */
    LocalSocket& socket;

    /**
     * The name of the pipe to connect to.
     */
    char name[256];

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

protected:
    /**
     * Construct the connector.
     */
    LocalConnector(LocalSocket* socket, const char* name);

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();

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

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

    friend class FailableReference<LocalConnector>;
    friend class LocalClientSocket;
};

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

inline LocalConnector::LocalConnector(LocalSocket* socket, const char* name) :
    socket(*socket),
    connected(false)
{
    LocalSocket::setupName(this->name, name);
}

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

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

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

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

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

} /* namespace xplcommon::win32 */ } /* namespace xplcommon */

//------------------------------------------------------------------------------
#endif // XPLCOMMON_WIN32_LOCALCONNECTOR_H

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