shill: Setup .Task RPC service for incoming VPN communication.
This will be used by OpenVPN, for example, to communicate back to shill
connection information (IP, DNS, etc.).
The RPC class model mostly follows the existing RPC adaptor classes (Manager,
Service, etc.).
Task is a bit overloaded and confusing in the context of shill so calling the
RPC object RPCTask instead. Also, the current intent is for this object to just
handle RPC service calls. Once the initial VPN implementation is in we may
decide to rename and refactor these objects.
BUG=chromium-os:26993
TEST=unit test
Change-Id: Ie294524b954c4a589c07ad285c7703cbbf9157d6
Reviewed-on: https://gerrit.chromium.org/gerrit/17047
Reviewed-by: Darin Petkov <petkov@chromium.org>
Tested-by: Darin Petkov <petkov@chromium.org>
Reviewed-by: Sam Leffler <sleffler@chromium.org>
Commit-Ready: Darin Petkov <petkov@chromium.org>
diff --git a/rpc_task.h b/rpc_task.h
new file mode 100644
index 0000000..13fe814
--- /dev/null
+++ b/rpc_task.h
@@ -0,0 +1,58 @@
+// Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef SHILL_RPC_TASK_
+#define SHILL_RPC_TASK_
+
+#include <map>
+#include <string>
+
+#include <base/basictypes.h>
+#include <base/memory/scoped_ptr.h>
+
+namespace shill {
+
+class ControlInterface;
+class RPCTaskAdaptorInterface;
+
+class RPCTaskDelegate {
+ public:
+ virtual ~RPCTaskDelegate() {}
+
+ virtual void Notify(const std::string &reason,
+ const std::map<std::string, std::string> &dict) = 0;
+};
+
+// RPC tasks are currently used by VPN drivers for communication with external
+// VPN processes. The RPC task should be owned by a single owner -- its
+// RPCTaskDelegate -- so no need to be reference counted.
+class RPCTask {
+ public:
+ // A constructor for the RPCTask object.
+ RPCTask(ControlInterface *control_interface, RPCTaskDelegate *delegate);
+ virtual ~RPCTask();
+
+ virtual void Notify(const std::string &reason,
+ const std::map<std::string, std::string> &dict);
+
+ // Returns a string that is guaranteed to uniquely identify this RPCTask
+ // instance.
+ const std::string &UniqueName() const { return unique_name_; }
+
+ std::string GetRpcIdentifier() const;
+ std::string GetRpcInterfaceIdentifier() const;
+ std::string GetRpcConnectionIdentifier() const;
+
+ private:
+ RPCTaskDelegate *delegate_;
+ static unsigned int serial_number_;
+ std::string unique_name_; // MUST be unique amongst RPC task instances
+ scoped_ptr<RPCTaskAdaptorInterface> adaptor_;
+
+ DISALLOW_COPY_AND_ASSIGN(RPCTask);
+};
+
+} // namespace shill
+
+#endif // SHILL_RPC_TASK_