src/client/PeekabotClient.hh

/*
 * Copyright Staffan Gimåker 2006-2010.
 *
 * ---
 *
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE_1_0.txt or copy at
 * http://www.boost.org/LICENSE_1_0.txt)
 */

#ifndef PEEKABOT_CLIENT_PEEKABOT_CLIENT_HH_INCLUDED
#define PEEKABOT_CLIENT_PEEKABOT_CLIENT_HH_INCLUDED


#include <stdexcept>
#include <string>
#include <boost/shared_ptr.hpp>
#include <boost/function.hpp>

#include "../Visibility.hh"
#include "DelayedDispatch.hh"
#include "OperationResult.hh"
#include "Recording.hh"


namespace peekabot
{
    class Action;

    namespace client
    {
        class ClientImpl;
        class PeekabotProxyBase;

        class PEEKABOT_API PeekabotClient
        {
            friend class PeekabotProxyBase;

        public:
            PeekabotClient();

            PeekabotClient(const PeekabotClient &client);

            virtual ~PeekabotClient();


            void connect(const std::string &hostname, unsigned int port = 5050);

            void disconnect();

            void flush();

            void sync();

            void start_recording(const std::string &filename);

            void stop_recording();


            void client_version(int &major, int &minor, int &rev) const;

            const std::string &client_version_str() const;

            bool is_connected() const;

            bool is_recording() const;

            DelayedDispatch noop();

            void begin_bundle();

            DelayedDispatch end_bundle();

            bool is_bundling() const;

            Recording open_recording(const std::string &filename);

            DelayedDispatch upload_file(const std::string &filename);

            DelayedDispatch remove_file(const std::string &filename);


        private:
            PEEKABOT_HIDDEN PeekabotClient(boost::shared_ptr<ClientImpl> impl);

            PEEKABOT_HIDDEN boost::shared_ptr<ClientImpl> get_impl();

            PEEKABOT_HIDDEN const boost::shared_ptr<ClientImpl> get_impl() const;

        private:
            boost::shared_ptr<ClientImpl> m_impl;
        };
    }
}


#endif // PEEKABOT_CLIENT_PEEKABOT_CLIENT_HH_INCLUDED