client.h

/* Copyright (c) 2005-2017, Stefan Eilemann <eile@equalizergraphics.com>
 *                          Daniel Nachbaur <danielnachbaur@gmail.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQ_CLIENT_H
#define EQ_CLIENT_H

#include <eq/api.h>
#include <eq/commandQueue.h>  // member
#include <eq/fabric/client.h> // base class
#include <eq/types.h>         // basic types

namespace eq
{
namespace detail
{
class Client;
}

class Client : public fabric::Client
{
public:
    EQ_API Client();

    EQ_API bool connectServer(ServerPtr server);

    EQ_API bool disconnectServer(ServerPtr server);

    EQ_API static std::string getHelp();

    EQ_API bool initLocal(const int argc, char** argv) override;

    EQ_API bool exitLocal() override;

    EQ_API bool hasCommands();

    EQ_API bool isRunning() const;

    EQ_API co::CommandQueue* getMainThreadQueue() override;

    void interruptMainThread();

    EQ_API void setName(const std::string& name);

    EQ_API const std::string& getName() const;

    EQ_API void addActiveLayout(const std::string& activeLayout);

    const Strings& getActiveLayouts() const;

    const std::string& getGPUFilter() const;

    float getModelUnit() const;

protected:
    EQ_API virtual ~Client();

    EQ_API virtual void clientLoop();

    EQ_API virtual void exitClient();

private:
    detail::Client* const _impl;

    EQ_API co::NodePtr createNode(const uint32_t type) override;

    EQ_API void notifyDisconnect(co::NodePtr node) override;

    bool _setupClient(const std::string& clientArgs);

    bool _cmdExit(co::ICommand& command);
    bool _cmdInterrupt(co::ICommand& command);
};
}

#endif // EQ_CLIENT_H