diff options
Diffstat (limited to 'plugins/com.windriver.tcf.api/src/com/windriver/tcf/api/protocol/IPeer.java')
-rw-r--r-- | plugins/com.windriver.tcf.api/src/com/windriver/tcf/api/protocol/IPeer.java | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/plugins/com.windriver.tcf.api/src/com/windriver/tcf/api/protocol/IPeer.java b/plugins/com.windriver.tcf.api/src/com/windriver/tcf/api/protocol/IPeer.java new file mode 100644 index 000000000..7abc75e2c --- /dev/null +++ b/plugins/com.windriver.tcf.api/src/com/windriver/tcf/api/protocol/IPeer.java @@ -0,0 +1,70 @@ +/******************************************************************************* + * Copyright (c) 2007 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 com.windriver.tcf.api.protocol; + +import java.util.Map; + +/** + * Both hosts and targets are represented by objects + * implementing IPeer interface. A peer can act as host or + * target depending on services it implements. + * List of currently known peers can be retrieved by + * calling ILocator.getPeers() + */ +public interface IPeer { + + /** + * Peer property names. Implementation can define additional properties. + */ + static final String + ATTR_ID = "ID", + ATTR_NAME = "Name", + ATTR_OS_NAME = "OSName", + ATTR_TRANSPORT_NAME = "TransportName", + ATTR_IP_HOST = "Host", + ATTR_IP_ALIASES = "Aliases", + ATTR_IP_ADDRESSES = "Addresses", + ATTR_IP_PORT = "Port"; + + + /** + * @return map of peer attributes + */ + Map<String, String> getAttributes(); + + /** + * @return peer unique ID, same as getAttributes().get(ATTR_ID) + */ + String getID(); + + /** + * @return peer name, same as getAttributes().get(ATTR_NAME) + */ + String getName(); + + /** + * Same as getAttributes().get(ATTR_OS_NAME) + */ + String getOSName(); + + /** + * Same as getAttributes().get(ATTR_TRANSPORT_NAME) + */ + String getTransportName(); + + /** + * Open channel to communicate with this peer. + * Note: the channel is not fully open yet when this method returns. + * It’s state is IChannel.STATE_OPENNING. + * Protocol.Listener will be called when the channel will be opened or closed. + */ + IChannel openChannel(); +} |