Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 317636 - LocalPeer and RemotePeer needs javadoc
Summary: LocalPeer and RemotePeer needs javadoc
Status: RESOLVED FIXED
Alias: None
Product: TCF
Classification: Tools
Component: Core (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 0.4.0   Edit
Assignee: Project Inbox CLA
QA Contact: Martin Oberhuber CLA
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-06-22 16:06 EDT by John Cortell CLA
Modified: 2013-06-05 07:56 EDT (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description John Cortell CLA 2010-06-22 16:06:52 EDT
LocalPeer and RemotePeer are undocumented and it's not obvious what they represent. The most intuitive definition is that a local peer is one running on "this" machine, and a remote peer is running on "another" machine, but that is not, in fact, what they represent. "local" and "remote" are relative to the agent. If there are five agents running on a machine, each contributing a peer, then from the perspective of any one of those agents, there is one local peer and four remote ones. A peer running on another machine is equally a remote peer. 

Without documentation, I think most TCF newbies will confuse the meaning of these classes.
Comment 1 Eugene Tarassov CLA 2010-06-23 14:10:33 EDT
Fixed - I have added javadoc comments.
Comment 2 Doug Schaefer CLA 2011-05-17 10:50:13 EDT
Moving bugs to new home for IP log.
Comment 3 Martin Oberhuber CLA 2013-06-05 06:27:53 EDT
Bulk change: Marking all bugs from the TM era (until June 2011) target 0.3