source: xplcommon/src/xplcommon/posix/LocalServerSocket.h@ 18:0490048f256d

// 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_LOCALSERVERSOCKET_H
#define XPLCOMMON_POSIX_LOCALSERVERSOCKET_H
//------------------------------------------------------------------------------

#include "ServerSocket.h"

#include "LocalAcceptor.h"

#include <sys/un.h>

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

namespace xplcommon { namespace posix {

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

/**
 * A server socket that works locally, i.e. a Unix socket.
 *
 * It is identified by a name that should be unique for the user. The
 * actual socket will be created with the name /tmp/<name>-<username>.
 */
class LocalServerSocket : public ServerSocket
{
public:
    /**
     * Fill in the path of the socket with the given name.
     */
    static void setupPath(struct sockaddr_un& addr, const char* name);

private:
    /**
     * Our address (to be used when deleting the file in the
     * destructor.
     */
    struct sockaddr_un sun;

    /**
     * The acceptor to use for accepting connections.
     */
    LocalAcceptor acceptor;

public:
    /**
     * Construct the socket with the given name.
     *
     * It will be bound to the name and able to listen for incoming
     * connections.
     *
     * @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 accept()
     * function of the Acceptor might block.
     */
    LocalServerSocket(const char* name, Waiter* waiter = 0);

    /**
     * Destroy the socket by deleting the file.
     */
    virtual ~LocalServerSocket();

    /**
     * Get the acceptor.
     */
    LocalAcceptor& getAcceptor();

protected:
    /**
     * Indicate if the waitable is ready, i.e. there is no need to
     * wait for it.
     */
    virtual bool isReady();

    /**
     * Handle the given events.
     */
    virtual void handleEvents(short events);

    friend class LocalAcceptor;
};

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

inline LocalAcceptor& LocalServerSocket::getAcceptor()
{
    return acceptor;
}

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

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

//------------------------------------------------------------------------------
#endif // XPLCOMMON_POSIX_LOCALSERVERSOCKET_H

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