source: xplcommon/src/xplcommon/LocalClientSocket.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_LOCALCLIENTSOCKET_H
#define XPLCOMMON_LOCALCLIENTSOCKET_H
//------------------------------------------------------------------------------

#include "BufferedStream.h"

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

#if 0 // The public interface of a socket that can be connected to a local, named access point provided by a LocalServerSocket

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

namespace xplcommon {

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

class LocalConnector;

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

/**
 * Client socket that connects to a server socket locally. On Linux it
 * is a Unix socket, on Windows it is a named pipe.
 *
 * The server socket's name should be given.
 */
class LocalClientSocket : public BufferedStream
{
public:
    /**
     * Construct the client socket with the given name.
     *
     * @param waiter the waiter to use for waiting a possible event
     * occuring on the socket. If given, the socket will be
     * non-blocking. Otherwise, it will be blocking, and the connect()
     * function of the Connector might block as well as the reading
     * and writing buffers.
     */
    LocalClientSocket(const char* name, Waiter* waiter = 0,
                      size_t readingCapacity = DEFAULT_CAPACITY,
                      size_t writingCapacity = DEFAULT_CAPACITY);

    /**
     * Get the connector. Use this object to connect to another socket.
     */
    LocalConnector& getConnector();
};

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

} /* namespace xplcommon */

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

#endif // 0, // The public interface of a socket that can be connected to a local, named access point provided by a LocalServerSocket

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

#include "config.h"

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

#if TARGET_API_WIN32

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

#include "win32/LocalClientSocket.h"

namespace xplcommon { typedef win32::LocalClientSocket LocalClientSocket; }

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

#else // TARGET_API_WIN32

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

#include "posix/LocalClientSocket.h"

namespace xplcommon { typedef posix::LocalClientSocket LocalClientSocket; }

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

#endif // TARGET_API_WIN32

//------------------------------------------------------------------------------
#endif // XPLCOMMON_LOCALCLIENTSOCKET_H

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