mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-25 18:05:33 +02:00
Code Issues Wiki Activity

[doc] Add tm.discovery.doc.isv contribution from Javier

Browse source
This commit is contained in:
Martin Oberhuber 2007-06-11 11:01:36 +00:00
parent c36fb42e09
commit f1fab01104
24 changed files with 567 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
discovery/org.eclipse.tm.discovery.doc.isv/.cvsignore Normal file
View file

@ -0,0 +1,7 @@
bin
index
build.xml
javadoc.link.location
temp.bin.log
temp.convert.txt
temp.options.txt

11
discovery/org.eclipse.tm.discovery.doc.isv/.project Normal file
View file

@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>org.eclipse.tm.discovery.doc.isv</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
</buildSpec>
<natures>
</natures>
</projectDescription>

8
discovery/org.eclipse.tm.discovery.doc.isv/META-INF/MANIFEST.MF Normal file
View file

@ -0,0 +1,8 @@
Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.tm.discovery.doc.isv;singleton:=true
Bundle-Version: 2.0.0.qualifier
Bundle-Localization: plugin
Eclipse-LazyStart: false
Bundle-Vendor: %providerName

112
discovery/org.eclipse.tm.discovery.doc.isv/book.css Normal file
View file

@ -0,0 +1,112 @@
P.Code {
display: block;
text-align: left;
text-indent: 0.00pt;
margin-top: 0.000000pt;
margin-bottom: 0.000000pt;
margin-right: 0.000000pt;
margin-left: 15pt;
font-size: 10.000000pt;
font-weight: normal;
font-style: normal;
color: #4444CC;
text-decoration: none;
vertical-align: baseline;
text-transform: none;
font-family: "Courier New", Courier, monospace;
}
H6.CaptionFigColumn {
display: block;
text-align: left;
text-indent: 0.000000pt;
margin-top: 3.000000pt;
margin-bottom: 11.000000pt;
margin-right: 0.000000pt;
margin-left: 0.000000pt;
font-size: 9.000000pt;
font-weight: bold;
font-style: Italic;
color: #000000;
text-decoration: none;
vertical-align: baseline;
text-transform: none;
}
P.Note {
display: block;
text-align: left;
text-indent: 0pt;
margin-top: 19.500000pt;
margin-bottom: 19.500000pt;
margin-right: 0.000000pt;
margin-left: 30pt;
font-size: 11.000000pt;
font-weight: normal;
font-style: Italic;
color: #000000;
text-decoration: none;
vertical-align: baseline;
text-transform: none;
}
EM.UILabel {
font-weight: Bold;
font-style: normal;
text-decoration: none;
vertical-align: baseline;
text-transform: none;
}
EM.CodeName {
font-weight: Bold;
font-style: normal;
text-decoration: none;
vertical-align: baseline;
text-transform: none;
font-family: "Courier New", Courier, monospace;
}
body, html { border: 0px }
/* following font face declarations need to be removed for DBCS */
body, h1, h2, h3, h4, h5, h6, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-family: Arial, Helvetica, sans-serif; color: #000000}
pre { font-family: "Courier New", Courier, monospace;}
/* end font face declarations */
/* following font size declarations should be OK for DBCS */
body, h1, h2, h3, h4, h5, h6, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-size: 10pt; }
pre { font-size: 10pt}
/* end font size declarations */
body { background: #FFFFFF; margin-bottom: 1em }
h1 { font-size: 18pt; margin-top: 5; margin-bottom: 1 }
h2 { font-size: 14pt; margin-top: 25; margin-bottom: 3 }
h3 { font-size: 11pt; margin-top: 20; margin-bottom: 3 }
h4 { font-size: 10pt; margin-top: 20; margin-bottom: 3; font-style: italic }
p { margin-top: 10px; margin-bottom: 10px }
pre { margin-left: 6; font-size: 9pt; color: #4444CC }
a:link { color: #0000FF }
a:hover { color: #000080 }
a:visited { text-decoration: underline }
ul { margin-top: 10px; margin-bottom: 10px; }
li { margin-top: 5px; margin-bottom: 5px; }
li p { margin-top: 5px; margin-bottom: 5px; }
ol { margin-top: 10px; margin-bottom: 10px; }
dl { margin-top: 10px; margin-bottom: 10px; }
dt { margin-top: 5px; margin-bottom: 5px; font-weight: bold; }
dd { margin-top: 5px; margin-bottom: 5px; }
strong { font-weight: bold}
em { font-style: italic}
var { font-style: italic}
div.revision { border-left-style: solid; border-left-width: thin;
border-left-color: #7B68EE; padding-left:5 }
th { font-weight: bold }
a.command-link {
}
a.command-link img {
border-width: 0px;
border-style: none;
vertical-align: middle;
}

25
discovery/org.eclipse.tm.discovery.doc.isv/guide/device.html Normal file
View file

@ -0,0 +1,25 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<meta name="copyright" content="Copyright (c) Symbian Software Ltd 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
<title>Device</title>
</head>
<body>
<h1>Device</h1>
<p>
Device represents a machine with a unique address in the network.<br/>
It can contain as well a name for easier identification.
A device contains a list of <a href="serviceType.html">service types</a>.
</p>
<p>
<h3>Attributes</h3>
<ul>
<li>Address</li>
<li>Name (optional)</li>
</ul>
</p>
</body>
</html>

BIN
discovery/org.eclipse.tm.discovery.doc.isv/guide/images/discovery.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 7.5 KiB

BIN
discovery/org.eclipse.tm.discovery.doc.isv/guide/images/discovery_model.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 7.5 KiB

BIN
discovery/org.eclipse.tm.discovery.doc.isv/guide/images/list.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 13 KiB

27
discovery/org.eclipse.tm.discovery.doc.isv/guide/model.html Normal file
View file

@ -0,0 +1,27 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<meta name="copyright" content="Copyright (c) Symbian Software Ltd 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
<title>Model</title>
</head>
<body>
<h1>Model</h1>
<p>
Service discovery stores the information in a EMF model as following:
</p>
<p>
<center>
<img src="./images/discovery_model.gif"/>
</center>
</p>
<p>
The service discovery engine will fill this model using the provided protocol and transport implementations, and can be accessed after using the standard EMF methods.
</p>
</body>
</html>

17
discovery/org.eclipse.tm.discovery.doc.isv/guide/network.html Normal file
View file

@ -0,0 +1,17 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<meta name="copyright" content="Copyright (c) Symbian Software Ltd 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
<title>Network</title>
</head>
<body>
<h1>Network</h1>
<p>
The Network is the top level or root of the discovered services model. <br/>
It contains a list of <a href="device.html">devices</a>
</p>
</body>
</html>

27
discovery/org.eclipse.tm.discovery.doc.isv/guide/overview.html Normal file
View file

@ -0,0 +1,27 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<meta name="copyright" content="Copyright (c) Symbian Software Ltd 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
<title>Overview</title>
</head>
<body>
<h1>Overview</h1>
<p>
<center>
<img src="./images/discovery.png"/>
</center>
</p>
<p>
<center>
<img src="./images/list.png"/>
</center>
</p>
</body>
</html>

27
discovery/org.eclipse.tm.discovery.doc.isv/guide/pair.html Normal file
View file

@ -0,0 +1,27 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<meta name="copyright" content="Copyright (c) Symbian Software Ltd 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
<title>Pair</title>
</head>
<body>
<h1>Pair</h1>
<p>
Each service can contain multiple pairs of keys and values to provide extra information about the service.<br/>
</p>
<p>
Using service discovery with the Remote System Explorer requires a "tranport" key matching the transport specified in org.eclipse.rse.core.subsystemConfigurations.
</p>
<p>
<h3>Attributes</h3>
<ul>
<li>Key</li>
<li>Value</li>
</ul>
</p>
</body>
</html>

26
discovery/org.eclipse.tm.discovery.doc.isv/guide/protocol.html Normal file
View file

@ -0,0 +1,26 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<meta name="copyright" content="Copyright (c) Symbian Software Ltd 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
<title>Protocol</title>
</head>
<body>
<h1>Protocol</h1>
<p>
It specifies the protocol that will be used to interact with the remote devices.<br/>
Protocols have to be specified as extensions of org.eclipse.tm.discovery.engine.discoveryProtocol.<br/>
</p>
<p>
Examples of discovery protocols are:
<ul>
<li>DNS Service Discovery (DNS-SD)</li>
<li>Service Location Protocol (SLP, srvloc)</li>
<li>Simple Service Discovery Protocol (SSDP)</li>
<li>...</li>
</ul>
</p>
</body>
</html>

23
discovery/org.eclipse.tm.discovery.doc.isv/guide/service.html Normal file
View file

@ -0,0 +1,23 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<meta name="copyright" content="Copyright (c) Symbian Software Ltd 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
<title>Service</title>
</head>
<body>
<h1>Service</h1>
<p>
Service represents a discovered service available in the remote device grouped under a common <a href="serviceType.html">service type</a>.<br/>
</p>
<p>
<h3>Attributes</h3>
<ul>
<li>Name</li>
</ul>
</p>
</body>
</html>

28
discovery/org.eclipse.tm.discovery.doc.isv/guide/servicetype.html Normal file
View file

@ -0,0 +1,28 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<meta name="copyright" content="Copyright (c) Symbian Software Ltd 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
<title>Service Type</title>
</head>
<body>
<h1>Service Type</h1>
<p>
A service type represents a group of services of the same kind discovered in the parent <a href="device.html">device</a>.<br/>
Service type names should follow <a href="http://www.iana.org/assignments/port-numbers">standard service names</a> whenever possible.
</p>
<p>
<h3>Attributes</h3>
<ul>
<li>Name</li>
</ul>
</p>
</body>
</html>

26
discovery/org.eclipse.tm.discovery.doc.isv/guide/transport.html Normal file
View file

@ -0,0 +1,26 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<meta name="copyright" content="Copyright (c) Symbian Software Ltd 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
<title>Transport</title>
</head>
<body>
<h1>Transport</h1>
<p>
Transport defines how the remote devices are accessed to be queried for available services.<br/>
Transports have to be specified as extensions of org.eclipse.tm.discovery.engine.discoveryTransport.<br/>
</p>
<p>
Examples of transport are:
<ul>
<li>UDP</li>
<li>TCP</li>
<li>serial</li>
<li>...</li>
</ul>
</p>
</body>
</html>

46
discovery/org.eclipse.tm.discovery.doc.isv/guide/usage.html Normal file
View file

@ -0,0 +1,46 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<meta name="copyright" content="Copyright (c) Symbian Software Ltd 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
<title>Programmatic usage</title>
</head>
<body>
<h1>Programmatic usage</h1>
<p>
Perform service discovery session:
</p>
<pre>
<samp>
int timeout = 500; // milliseconds
String query = "_services._dns-sd._udp.local."; //DNS-SD query
//instantiate protocol by name attribute
IProtocol protocol = ProtocolFactory.getProtocol("DNS-SD");
//instantiate transport by name attribute
ITransport transport = TransportFactory.getTransport("UDP", "224.0.0.251", timeout);
//get engine instance and kick off discovery
ServiceDiscoveryEngine serviceDiscoveryEngine = ServiceDiscoveryEngine.getInstance();
serviceDiscoveryEngine.doServiceDiscovery(query, protocol,transport);
</samp>
</pre>
<p>
Access EMF model:
</p>
<pre>
<samp>
//get engine instance
ServiceDiscoveryEngine serviceDiscoveryEngine = ServiceDiscoveryEngine.getInstance();
//access org.eclipse.emf.ecore.resource.Resource
Resource model = serviceDiscoveryEngine.getResource();
</samp>
</pre>
</body>
</html>

37
discovery/org.eclipse.tm.discovery.doc.isv/guide/view.html Normal file
View file

@ -0,0 +1,37 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<meta name="copyright" content="Copyright (c) Symbian Software Ltd 2007. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
<title>Discovery View</title>
</head>
<body>
<h1>Discovery View</h1>
<p>
The Discovery view can be used to test new extensions and discover available services using the existing protocol and transport implementations.<br/>
It can be accessed through the view "Service Discovery" -> "Service Discovery Properties".<br/>
<br/>
In the view, it's possible launching a wizard to select the protocol and transport to be used:
</p>
<p>
<center>
<img src="./images/discovery.png"/>
</center>
</p>
<p>
And inspect the discovered services and their attributes:</br>
</p>
<p>
<center>
<img src="./images/list.png"/>
</center>
</p>
<p>
Since the same model is used, launching multiple times the wizard adds new discovered services to the same model, even using different protocols and transports.
</p>
</body>
</html>

16
discovery/org.eclipse.tm.discovery.doc.isv/plugin.properties Normal file
View file

@ -0,0 +1,16 @@
###############################################################################
# Copyright (c) 2007 Symbian Software Ltd.
# 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:
# Javier Montalvo Orus - initial API and implementation
###############################################################################
# NLS_MESSAGEFORMAT_NONE
# NLS_ENCODING=UTF-8
pluginName=Service Discovery ISV Documentation
providerName=Eclipse.org

9
discovery/org.eclipse.tm.discovery.doc.isv/plugin.xml Normal file
View file

@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<plugin>
<extension point="org.eclipse.help.toc">
<toc file="toc.xml" primary="true" category="DSDP.TM"/>
<index path="index/"/>
</extension>
</plugin>

1
discovery/org.eclipse.tm.discovery.doc.isv/reference/.cvsignore Normal file
View file

@ -0,0 +1 @@
api

1
discovery/org.eclipse.tm.discovery.doc.isv/reference/extension-points/.cvsignore Normal file
View file

@ -0,0 +1 @@
org_eclipse_*.html

66
discovery/org.eclipse.tm.discovery.doc.isv/schema.css Normal file
View file

@ -0,0 +1,66 @@
H6.CaptionFigColumn#header {
font-size:16px;
display:inline
}
P.Note#copyright {
font-size: smaller;
font-style: normal;
color: #336699;
display:inline;
margin-top: 3.000000pt;
margin-bottom: 11.000000pt;
margin-right: 0.000000pt;
margin-left: 0.000000pt;
}
P.Code#dtd {
color: #800000;
margin-top: 0.000000pt;
margin-bottom: 0.000000pt;
margin-right: 0.000000pt;
margin-left: 10.000000pt;
}
P.Code#dtdAttlist {
color: #800000;
margin-top: 0.000000pt;
margin-bottom: 0.000000pt;
margin-right: 0.000000pt;
margin-left: 20.000000pt;
}
P.Code#tag {
color: #000080;
display:inline;
margin-top: 0.000000pt;
margin-bottom: 0.000000pt;
margin-right: 0.000000pt;
margin-left: 0.000000pt;
}
P.Code#cstring {
color: #008000;
display:inline;
margin-top: 0.000000pt;
margin-bottom: 0.000000pt;
margin-right: 0.000000pt;
margin-left: 0.000000pt;
}
.ConfigMarkup#elementDesc {
color: black;
margin-top: 0.000000pt;
margin-bottom: 0.000000pt;
margin-right: 0.000000pt;
margin-left: 10.000000pt;
}
.ConfigMarkup#attlistDesc {
color: black;
margin-top: 0.000000pt;
margin-bottom: 0.000000pt;
margin-right: 0.000000pt;
margin-left: 32.000000pt;
}

27
discovery/org.eclipse.tm.discovery.doc.isv/toc.xml Normal file
View file

@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>
<toc label="Service Discovery Developer Guide">
<topic label="Guide">
<topic label="Model" href="guide/model.html">
<topic label="Network" href="guide/network.html"/>
<topic label="Device" href="guide/device.html"/>
<topic label="Service Type" href="guide/servicetype.html"/>
<topic label="Service" href="guide/service.html"/>
<topic label="Pair" href="guide/pair.html"/>
</topic>
<topic label="Transport" href="guide/transport.html" />
<topic label="Protocol" href="guide/protocol.html" />
<topic label="Usage">
<topic label="Programmatically" href="guide/usage.html" />
<topic label="Service Discovery View" href="guide/view.html" />
</topic>
</topic>
<topic label="Reference">
<topic label="Extension Points Reference">
<topic label="org.eclipse.tm.discovery.engine.discoveryProtocol" href="reference/extension-points/org_eclipse_tm_discovery_engine_discoveryProtocol.html" />
<topic label="org.eclipse.tm.discovery.engine.discoveryTranport" href="reference/extension-points/org_eclipse_tm_discovery_engine_discoveryTransport.html" />
</topic>
</topic>
</toc>