Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 8ffe42be24037bdf990dc89f76e584e9b214f455 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# *******************************************************************************
# * 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
# *******************************************************************************

"""
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).
"""

from tcf import services

# 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"

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 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 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 NotImplementedError("Abstract method")
    def addListener(self, listener):
        "Add a listener for Locator service events."
        raise NotImplementedError("Abstract method")
    def removeListener(self, listener):
        "Remove a listener for Locator service events."
        raise NotImplementedError("Abstract method")

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

Back to the top