1 files changed, 63 insertions, 0 deletions
diff --git a/src/engine/Responder.h b/src/engine/Responder.h
new file mode 100644
index 00000000..cf16a20a
--- /dev/null
+++ b/src/engine/Responder.h
@@ -0,0 +1,63 @@
+/* This file is part of Om.  Copyright (C) 2006 Dave Robillard.
+ * 
+ * Om is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU General Public License as published by the Free Software
+ * Foundation; either version 2 of the License, or (at your option) any later
+ * version.
+ * 
+ * Om 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 General Public License for details.
+ * 
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#ifndef RESPONDER_H
+#define RESPONDER_H
+
+#include <inttypes.h>
+#include <string>
+#include "util/CountedPtr.h"
+#include "interface/ClientInterface.h"
+using std::string;
+
+namespace Om {
+
+using Shared::ClientInterface;
+
+
+/** Class to handle responding to clients.
+ *
+ * This is an abstract base class to fully abstract the details of client
+ * communication from the internals of the engine.
+ *
+ * Note that this class only handles sending responses to commands from
+ * clients, (ie OK or an error), <b>not</b> notifications (ie new node,
+ * disconnection) - that's what ClientInterface is for.  If a command is
+ * a request, \ref find_client can find the corresponding ClientInterface
+ * for this client to send the reply to.
+ *
+ * ClientInterface and Responder are seperate because responding might not
+ * actually get exposed to the client interface (eg in simulated blocking
+ * interfaces that wait for responses before returning).
+ */
+class Responder
+{
+public:
+	Responder() {}
+	virtual ~Responder() {}
+
+	virtual CountedPtr<Shared::ClientInterface> find_client()
+	{ return CountedPtr<Shared::ClientInterface>(NULL); }
+
+	virtual void respond_ok() {}
+	virtual void respond_error(const string& msg) {}
+};
+
+
+} // namespace Om
+
+#endif // RESPONDER_H
+