/*
  This file is part of Ingen.
  Copyright 2007-2012 David Robillard <http://drobilla.net/>

  Ingen is free software: you can redistribute it and/or modify it under the
  terms of the GNU Affero General Public License as published by the Free
  Software Foundation, either version 3 of the License, or any later version.

  Ingen 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 Affero General Public License for details.

  You should have received a copy of the GNU Affero General Public License
  along with Ingen.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef INGEN_CLIENT_OSCENGINESENDER_HPP
#define INGEN_CLIENT_OSCENGINESENDER_HPP

#include <stddef.h>

#include <string>

#include <lo/lo.h>

#include "raul/Deletable.hpp"

#include "ingen/Interface.hpp"

#include "OSCSender.hpp"

namespace Ingen {

namespace Client {

/* OSC (via liblo) interface to the engine.
 *
 * Clients can use this opaquely as an Interface* to control the engine
 * over OSC (whether over a network or not, etc).
 *
 * \ingroup IngenClient
 */
class OSCEngineSender : public Interface, public Shared::OSCSender {
public:
	OSCEngineSender(const Raul::URI&           engine_url,
	                size_t                     max_packet_size,
	                SharedPtr<Raul::Deletable> receiver);

	~OSCEngineSender();

	Raul::URI uri() const { return _engine_url; }

	inline int32_t next_id() { return (_id == -1) ? -1 : _id++; }

	void set_response_id(int32_t id) { _id = id; }

	void attach(int32_t ping_id, bool block);

	/* *** ServerInterface implementation below here *** */

	void enable()  { _enabled = true; }
	void disable() { _enabled = false; }

	void bundle_begin()   { OSCSender::bundle_begin(); }
	void bundle_end()     { OSCSender::bundle_end(); }

	// Client registration
	void register_client(ClientInterface* client);
	void unregister_client(const Raul::URI& uri);

	// Object commands

	virtual void put(const Raul::URI&            path,
	                 const Resource::Properties& properties,
	                 Resource::Graph             ctx=Resource::DEFAULT);

	virtual void delta(const Raul::URI&            path,
	                   const Resource::Properties& remove,
	                   const Resource::Properties& add);

	virtual void del(const Raul::URI& uri);

	virtual void move(const Raul::Path& old_path,
	                  const Raul::Path& new_path);

	virtual void connect(const Raul::Path& src_port_path,
	                     const Raul::Path& dst_port_path);

	virtual void disconnect(const Raul::URI& src,
	                        const Raul::URI& dst);

	virtual void disconnect_all(const Raul::Path& parent_patch_path,
	                            const Raul::Path& path);

	virtual void set_property(const Raul::URI&  subject_path,
	                          const Raul::URI&  predicate,
	                          const Raul::Atom& value);

	// Requests //
	void ping();
	void get(const Raul::URI& uri);

protected:
	SharedPtr<Raul::Deletable> _receiver;

	const Raul::URI _engine_url;
	int             _client_port;
	int32_t         _id;
};

} // namespace Client
} // namespace Ingen

#endif // INGEN_CLIENT_OSCENGINESENDER_HPP