source: xplcommon/src/xplcommon/win32/LocalSocket.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_LOCALSOCKET_H
#define XPLCOMMON_WIN32_LOCALSOCKET_H
//------------------------------------------------------------------------------

#include "BufferedStream.h"

#include "Overlapped.h"

#include <cstdio>

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

namespace xplcommon { namespace win32 {

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

/**
 * Basically a different name for a buffered stream.
 */
class LocalSocket : public BufferedStream
{
public:
    /**
     * Create a concrete pipe name from the given user-specified name.
     *
     * @param dest the destination buffer, which should be at least
     * 256 bytes long.
     */
    static void setupName(char* dest, const char* name);

    /**
     * Create a new named pipe with the proper settings. The handle
     * will be returned on successful creation.
     *
     * @param name the name of the pipe to create. It should be the
     * final name, not the user-given one.
     *
     * @return the handle if the pipe could be created.
     */
    static HANDLE createNamedPipe(const char* name, bool overlapped);

    /**
     * Connect the named pipe with the given handle.
     *
     * @return true if the connection is established. If overlapped is
     * 0 and false is returned, it has failed. If overlapped is not 0,
     * the failer status of the Failable associated with the
     * Overlapped instance provides failure information.
     */
    static bool connectNamedPipe(HANDLE handle, Overlapped* overlapped);

protected:
    /**
     * Construct the local socket
     */
    LocalSocket(Waiter* waiter = 0, HANDLE handle = 0,
                size_t readingCapacity = DEFAULT_CAPACITY,
                size_t writingCapacity = DEFAULT_CAPACITY);


protected:
    /**
     * Connect the named pipe with the current handle of this object.
     *
     * @return whether the connection succeeded. If not, it may be a
     * failure, which is then indicated, or it may be an overlapped
     * operation which needs to wait.
     */
    bool connect(Overlapped* overlapped);

    friend class LocalAcceptor;
    friend class LocalConnector;
};

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

inline void LocalSocket::setupName(char* dest, const char* name)
{
    snprintf(dest, 256, "\\\\.\\pipe\\%s", name);
}

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

inline bool LocalSocket::connectNamedPipe(HANDLE handle, Overlapped* overlapped)
{
    OVERLAPPED* ol = (overlapped==0) ? 0 : overlapped->get();
    bool result = ConnectNamedPipe(handle, ol);
    if (overlapped!=0) {
        DWORD dummy = 0;
        result = overlapped->getResult(dummy, handle);
    }
    return result;
}

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

inline LocalSocket::LocalSocket(Waiter* waiter, HANDLE handle,
                                size_t readingCapacity, size_t writingCapacity):
    BufferedStream(waiter, handle, readingCapacity, writingCapacity)
{
}

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

inline bool LocalSocket::connect(Overlapped* overlapped)
{
    bool result = connectNamedPipe(handle, overlapped);
    if (!result && overlapped==0) {
        setErrorCode(GetLastError());
    }
    return result;
}

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

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

//------------------------------------------------------------------------------
#endif // XPLCOMMON_WIN32_LOCALSOCKET_H

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