source: xplra/src/plugin/src/xplra/ListenThread.h@ 38:128b9ced9779

// Copyright (c) 2013 by István Váradi

// This file is part of XPLRA, a remote-access plugin for 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 XPLRA_LISTENTHREAD_H
#define XPLRA_LISTENTHREAD_H
//------------------------------------------------------------------------------

#include <hu/varadiistvan/scpl/Thread.h>

#include "RequestQueue.h"

#include <hu/varadiistvan/scpl/io/Waiter.h>
#include <hu/varadiistvan/scpl/io/WaitableEvent.h>

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

namespace xplra {

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

class MessageWindow;

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

/**
 * The thread that listens to incoming connections and starts the
 * client serving threads.
 *
 * This is a detached thread, to allow it to quit automatically.
 */
class ListenThread : public hu::varadiistvan::scpl::Thread
{
private:
    /**
     * The version of X-Plane.
     */
    int xplaneVersion;

    /**
     * The version of the XPLM library.
     */
    int xplmVersion;

    /**
     * The message window for showing messages.
     */
    MessageWindow& messageWindow;

    /**
     * The waiter used in the thread.
     */
    hu::varadiistvan::scpl::io::Waiter waiter;

    /**
     * The event that can be fired to notify the thread that it should
     * quit.
     */
    hu::varadiistvan::scpl::io::WaitableEvent quitEvent;

    /**
     * The queue for the requests.
     */
    RequestQueue requestQueue;

public:
    /**
     * Construct the thread.
     */
    ListenThread(int xplaneVersion, int xplmVersion,
                 MessageWindow& messageWindow);

    /**
     * Get the versions
     */
    void getVersions(int& xplane, int& xplm) const;

    /**
     * Get the message window.
     */
    MessageWindow& getMessageWindow();

    /**
     * Notify the thread to quit.
     */
    void quit();

    /**
     * Perform the thread's operation.
     */
    virtual void run();
};

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

inline ListenThread::ListenThread(int xplaneVersion, int xplmVersion,
                                  MessageWindow& messageWindow) :
    Thread(true),
    xplaneVersion(xplaneVersion),
    xplmVersion(xplmVersion),
    messageWindow(messageWindow),
    quitEvent(&waiter)
{
}

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

inline void ListenThread::getVersions(int& xplane, int& xplm) const
{
    xplane = xplaneVersion;
    xplm = xplmVersion;
}

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

inline MessageWindow& ListenThread::getMessageWindow()
{
    return messageWindow;
}

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

inline void ListenThread::quit()
{
    requestQueue.disable();
    quitEvent.fire();
}

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

} /* namespace xplra */

//------------------------------------------------------------------------------
#endif // XPLRA_LISTENTHREAD_H

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