Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEike Stepper2011-05-27 12:02:25 +0000
committerEike Stepper2011-05-27 12:02:25 +0000
commitbda4b2aa715a7f6d91c9d44f7d9b971b0b12df6f (patch)
tree65188bfc7ce2d3ef52b434a1e4b8d7c5e2a75127 /plugins/org.eclipse.net4j
parentb02b5b78ba1739a2e249ffa8d6f0a6a8213df53a (diff)
downloadcdo-bda4b2aa715a7f6d91c9d44f7d9b971b0b12df6f.tar.gz
cdo-bda4b2aa715a7f6d91c9d44f7d9b971b0b12df6f.tar.xz
cdo-bda4b2aa715a7f6d91c9d44f7d9b971b0b12df6f.zip
docs
Diffstat (limited to 'plugins/org.eclipse.net4j')
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/acceptor/package.html23
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/buffer/package.html23
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/channel/package.html23
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/connector/package.html23
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/package.html33
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/protocol/package.html23
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/heartbeat/package.html23
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html20
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/wrapping/package.html23
-rw-r--r--plugins/org.eclipse.net4j/src/org/eclipse/spi/net4j/package.html23
10 files changed, 192 insertions, 45 deletions
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/acceptor/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/acceptor/package.html
new file mode 100644
index 0000000000..059c33dd4a
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/acceptor/package.html
@@ -0,0 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) 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:
+ Eike Stepper - initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+The Net4j transport layer concepts for dealing with acceptors.
+<p>
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/buffer/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/buffer/package.html
new file mode 100644
index 0000000000..ba7ebd94a1
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/buffer/package.html
@@ -0,0 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) 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:
+ Eike Stepper - initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+The Net4j transport layer concepts for dealing with buffers.
+<p>
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/channel/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/channel/package.html
new file mode 100644
index 0000000000..7f9e933970
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/channel/package.html
@@ -0,0 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) 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:
+ Eike Stepper - initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+The Net4j transport layer concepts for dealing with channels.
+<p>
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/connector/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/connector/package.html
new file mode 100644
index 0000000000..791e56caf7
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/connector/package.html
@@ -0,0 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) 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:
+ Eike Stepper - initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+The Net4j transport layer concepts for dealing with connectors.
+<p>
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/package.html
index 0cb54543ff..a06661ad72 100644
--- a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/package.html
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/package.html
@@ -17,11 +17,14 @@
<body bgcolor="white">
The Net4j transport layer.
-The four main interfaces of the transport layer are
-{@link org.eclipse.net4j.buffer.IBuffer},
-{@link org.eclipse.net4j.channel.IChannel},
-{@link org.eclipse.net4j.connector.IConnector} and
-{@link org.eclipse.net4j.protocol.IProtocol}.
+The five main interfaces of the transport layer are:
+ <ul>
+ <li>{@link org.eclipse.net4j.buffer.IBuffer}</li>
+ <li>{@link org.eclipse.net4j.channel.IChannel}</li>
+ <li>{@link org.eclipse.net4j.acceptor.IAcceptor}</li>
+ <li>{@link org.eclipse.net4j.connector.IConnector}</li>
+ <li>{@link org.eclipse.net4j.protocol.IProtocol}</li>
+ </ul>
<p>
<dt><b>Sequence Diagram: Communication Process</b></dt>
@@ -37,25 +40,5 @@ usemap="#CommunicationProcess.jpg"/></dd>
</MAP>
-<!--
-
-<h2>Package Specification</h2>
-
-##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
-<ul>
- <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
-</ul>
-
-<h2>Related Documentation</h2>
-
-For overviews, tutorials, examples, guides, and tool documentation, please see:
-<ul>
- <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
-</ul>
-
--->
-
-<!-- Put @see and @since tags down here. -->
-
</body>
</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/protocol/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/protocol/package.html
new file mode 100644
index 0000000000..885d5ae309
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/protocol/package.html
@@ -0,0 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) 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:
+ Eike Stepper - initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+The Net4j transport layer concepts for dealing with protocols.
+<p>
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/heartbeat/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/heartbeat/package.html
new file mode 100644
index 0000000000..bcb187ea1a
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/heartbeat/package.html
@@ -0,0 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) 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:
+ Eike Stepper - initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+A signal protocol implementation that realizes a configurable heart beat protocol.
+<p>
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html
index 647ba83923..764cb80162 100644
--- a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/package.html
@@ -20,25 +20,5 @@ A framework for request/response based communication on top of
the Net4j transport layer.
<p>
-<!--
-
-<h2>Package Specification</h2>
-
-##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
-<ul>
- <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
-</ul>
-
-<h2>Related Documentation</h2>
-
-For overviews, tutorials, examples, guides, and tool documentation, please see:
-<ul>
- <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
-</ul>
-
--->
-
-<!-- Put @see and @since tags down here. -->
-
</body>
</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/wrapping/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/wrapping/package.html
new file mode 100644
index 0000000000..53c5da3146
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/net4j/signal/wrapping/package.html
@@ -0,0 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) 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:
+ Eike Stepper - initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+Some container injectors for use with signal protocols.
+<p>
+
+</body>
+</html>
diff --git a/plugins/org.eclipse.net4j/src/org/eclipse/spi/net4j/package.html b/plugins/org.eclipse.net4j/src/org/eclipse/spi/net4j/package.html
new file mode 100644
index 0000000000..355f56f364
--- /dev/null
+++ b/plugins/org.eclipse.net4j/src/org/eclipse/spi/net4j/package.html
@@ -0,0 +1,23 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+ Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) 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:
+ Eike Stepper - initial API and implementation
+
+-->
+</head>
+<body bgcolor="white">
+
+Server service provider interfaces and useful base implementations for the Net4j transport layer.
+<p>
+
+</body>
+</html>

Back to the top