1 files changed, 119 insertions, 0 deletions
diff --git a/python/src/tcf/services/locator.py b/python/src/tcf/services/locator.py
new file mode 100644
index 000000000..5c7f69c65
--- /dev/null
+++ b/python/src/tcf/services/locator.py
@@ -0,0 +1,119 @@
+# *******************************************************************************
+# * Copyright (c) 2011 Wind River Systems, Inc. and others.
+# * All rights reserved. This program and the accompanying materials
+# * are made available under the terms of the Eclipse Public License v1.0
+# * which accompanies this distribution, and is available at
+# * http://www.eclipse.org/legal/epl-v10.html
+# *
+# * Contributors:
+# *     Wind River Systems - initial API and implementation
+# *******************************************************************************
+
+import exceptions
+from tcf import services, protocol, channel
+
+"""
+Locator service uses transport layer to search for peers and to collect data about
+peer's attributes and capabilities (services). Discovery mechanism depends on transport protocol
+and is part of that protocol handler. Targets, known to other hosts, can be found through
+remote instances of Locator service. Automatically discovered targets require no further
+configuration. Additional targets can be configured manually.
+
+Clients should use protocol.getLocator() to obtain local instance of locator,
+then locator.getPeers() can be used to get list of available peers (hosts and targets).
+"""
+
+# Peer data retention period in milliseconds.
+DATA_RETENTION_PERIOD = 60 * 1000;
+
+# Auto-configuration protocol version.
+CONF_VERSION = '2'
+
+# Auto-configuration command and response codes.
+CONF_REQ_INFO = 1
+CONF_PEER_INFO = 2
+CONF_REQ_SLAVES = 3
+CONF_SLAVES_INFO = 4
+
+NAME = "Locator"
+
+_locator = None
+def getLocator():
+    global _locator
+    if _locator is None:
+        _locator = LocatorService()
+    services.addServiceProvider(LocatorServiceProvider())
+    return _locator
+
+class LocatorService(services.Service):
+    def getName(self):
+        return NAME
+    def getPeers(self):
+        """
+        Get map (ID -> IPeer) of available peers (hosts and targets).
+        The method return cached (currently known to the framework) list of peers.
+        The list is updated according to event received from transport layer
+        """
+        raise exceptions.NotImplementedError("Abstract method")
+    def redirect(self, peer, done):
+        """
+        Redirect this service channel to given peer using this service as a proxy.
+        @param peer - Peer ID or attributes map.
+        """
+        raise exceptions.NotImplementedError("Abstract method")
+    def sync(self, done):
+        """
+        Call back after TCF messages sent to this target up to this moment are delivered.
+        This method is intended for synchronization of messages
+        across multiple channels.
+        
+        Note: Cross channel synchronization can reduce performance and throughput.
+        Most clients don't need channel synchronization and should not call this method.
+        
+        @param done will be executed by dispatch thread after communication
+        messages are delivered to corresponding targets.
+        
+        This is internal API, TCF clients should use module 'tcf.protocol'.
+        """
+        raise exceptions.NotImplementedError("Abstract method")
+    def addListener(self, listener):
+        "Add a listener for Locator service events."
+        assert listener
+        assert protocol.isDispatchThread()
+        _listeners.append(listener)
+    def removeListener(self, listener):
+        "Remove a listener for Locator service events."
+        assert protocol.isDispatchThread()
+        _listeners.remove(listener)
+
+class LocatorServiceProvider(services.ServiceProvider):
+    def getLocalService(self, _channel):
+        class LocatorCommandServer(channel.CommandServer):
+            def command(self, token, name, data):
+                _locator.command(_channel, token, name, data)
+        _channel.addCommandServer(_locator, LocatorCommandServer())
+        return [_locator]
+    def getServiceProxy(self, channel, service_name):
+        return None
+
+class DoneRedirect(object):
+    def doneRedirect(self, token, error):
+        pass
+
+class DoneSync(object):
+    def doneSync(self, token):
+        pass
+
+class LocatorListener(object):
+    def peerAdded(self, peer):
+        pass
+    def peerChanged(self, peer):
+        pass
+    def peerRemoved(self, id):
+        pass
+    def peerHeartBeat(self, id):
+        pass
+
+_listeners = []
+def getListeners():
+    return _listeners