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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/*******************************************************************************
* Copyright (c) 2014 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
*******************************************************************************/
package org.eclipse.tcf.services;
import java.util.Map;
import org.eclipse.tcf.protocol.IPeer;
import org.eclipse.tcf.protocol.IService;
import org.eclipse.tcf.protocol.IToken;
/**
* ILocator 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 ILocator service. Automatically discovered targets require no further
* configuration. Additional targets can be configured manually.
*
* Clients should use Protocol.getLocator() to obtain local instance of ILocator,
* then ILocator.getPeers() can be used to get list of available peers (hosts and targets).
*
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ILocator extends IService {
static final String NAME = "Locator";
/**
* Peer data retention period in milliseconds.
*/
static final long DATA_RETENTION_PERIOD = 60 * 1000;
/**
* Auto-configuration protocol version.
*/
static char CONF_VERSION = '2';
/**
* Auto-configuration command and response codes.
*/
static final int
CONF_REQ_INFO = 1,
CONF_PEER_INFO = 2,
CONF_REQ_SLAVES = 3,
CONF_SLAVES_INFO = 4,
CONF_PEERS_REMOVED = 5;
/**
* @return Locator service name: "Locator"
*/
String getName();
/**
* 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
*/
Map<String,IPeer> getPeers();
/**
* Redirect this service channel to given peer using this service as a proxy.
* @param peer_id - Peer ID.
*/
IToken redirect(String peer_id, DoneRedirect done);
/**
* Redirect this service channel to given peer using this service as a proxy.
* @param peer - Peer attributes.
*/
IToken redirect(Map<String,String> peer, DoneRedirect done);
interface DoneRedirect {
void doneRedirect(IToken token, Exception error);
}
/**
* 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 {@code org.eclipse.tcf.protocol.Protocol}.
*/
IToken sync(DoneSync done);
interface DoneSync {
void doneSync(IToken token);
}
/**
* Get agent ID of the agent providing the locator service.
* <p>
* The agent ID can be used to identify the agent among all the peers
* returned by {@link #getPeers()}.
*/
IToken getAgentID(DoneGetAgentID done);
interface DoneGetAgentID {
void doneGetAgentID(IToken token, Exception error, String agentID);
}
/**
* Add a listener for ILocator service events.
*/
void addListener(LocatorListener listener);
/**
* Remove a listener for ILocator service events.
*/
void removeListener(LocatorListener listener);
interface LocatorListener {
/**
* A new peer is added into locator peer table.
* @param peer
*/
void peerAdded(IPeer peer);
/**
* Peer attributes have changed.
* @param peer
*/
void peerChanged(IPeer peer);
/**
* A peer is removed from locator peer table.
* @param id - peer ID
*/
void peerRemoved(String id);
/**
* Peer heart beat detected.
* @param id - peer ID
*/
void peerHeartBeat(String id);
}
}
|
