source: xplcommon/src/xplcommon/win32/LocalServerSocketBase.h@ 22:d13fbc745959

// 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_LOCALSERVERSOCKETBASE_H
#define XPLCOMMON_WIN32_LOCALSERVERSOCKETBASE_H
//------------------------------------------------------------------------------

#include "Overlappable.h"

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

namespace xplcommon { namespace win32 {

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

class Overlapped;

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

/**
 * Base class for a local server socket. This is here only to allow
 * for a more efficient implementation of LocalAcceptor.
 */
class LocalServerSocketBase : public Overlappable
{
protected:
    /**
     * Construct the server socket base.
     */
    LocalServerSocketBase(Waiter* waiter);

    /**
     * Create a new named pipe with the proper settings. The handle of
     * this object will be set to the created handle.
     *
     * @param path the path of the pipe to create. It should be the
     * final path, not the user-given name.
     *
     * @return whether the pipe could be created
     */
    bool createNamedPipe(const char* path);

    /**
     * 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 connectNamedPipe(Overlapped* overlapped);

    /**
     * Get the handle and clear it.
     */
    HANDLE releaseHandle();

    friend class LocalAcceptor;
};

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

inline LocalServerSocketBase::LocalServerSocketBase(Waiter* waiter) :
    Overlappable(waiter)
{
}

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

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

//------------------------------------------------------------------------------
#endif // XPLCOMMON_WIN32_LOCALSERVERSOCKETBASE_H

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