Skip to content

Commit

Permalink
polish docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tobias Oberstein committed Mar 20, 2012
1 parent f7087a0 commit 93bc483
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 21 deletions.
2 changes: 1 addition & 1 deletion Autobahn/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NUMBER =
# for a project that appears at the top of each page and should give viewer
# a quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF = "WebSockets and RPC/PubSub for Android"
PROJECT_BRIEF = "WebSocket and WAMP (RPC/PubSub) for Android"

# With the PROJECT_LOGO tag one can specify an logo or icon that is
# included in the documentation. The maximum height of the logo should not
Expand Down
47 changes: 27 additions & 20 deletions Autobahn/src/de/tavendo/autobahn/Autobahn.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,48 +25,55 @@
\mainpage
\section intro_sec Introduction
<a href="http://www.tavendo.de/autobahn">Autobahn WebSockets for Android</a> provides a Java client library implementing
the <a href="http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol">WebSockets protocol</a>.
<a href="http://autobahn.ws">AutobahnAndroid</a> provides a Java client library implementing
<a href="http://tools.ietf.org/html/rfc6455">The WebSocket Protocol</a> and
<a href="http://wamp.ws">The WebSocket Application Messaging Protocol</a> for use
in native Android apps.
It features:
\li very good standards conformance
\section websocket_features WebSocket Support
<a href="http://autobahn.ws">AutobahnAndroid</a> implements the WebSocket protocol
with a couple of distinct features:
\li full RFC6455 and Draft Hybi-10 to -17 support
\li very good <a href="http://autobahn.ws/testsuite/reports/mobileclients/">standards conformance</a>
\li performant
\li easy to use API
\li designed to work with Android UI applications
\li <a href="https://github.com/oberstet/AutobahnAndroid">Open-source</a> (Apache 2 license)
\li Open-Source, licensed under the Apache 2.0 license
The implementation supports the WebSockets protocol (Hybi-10 to -17) and
passes all (over 280) tests from the
<a href="http://www.tavendo.de/autobahn/testsuite.html">Autobahn WebSockets Test Suite</a>.
The implementation passes all (nearly 300) tests from the
<a href="http://autobahn.ws/testsuite">AutobahnTestSuite</a>.
The basic API is modeled after the WebSockets JavaScript API for
The basic API is modeled after the WebSocket JavaScript API for
ease of use and familarity.
The API enables the use of common Android idioms for event handling (using
anonymous inner classes) and integrates with Android UI applications (by
communicating via messages and message loops between the UI thread and back-
ground reader/writer threads).
ground reader/writer threads and by avoiding _any_ network activity on the
UI thread).
The implementation uses Java NIO to reduce network processing overhead and
is on-par or faster performance-wise compared to Firefox 8 Mobile, a C++
implementation of WebSockets.
\section rpc_pubsub RPC/PubSub
\section rpc_pubsub WAMP (RPC/PubSub) Support
<a href="http://www.tavendo.de/autobahn">Autobahn WebSockets for Android</a> also
includes an implementation of the
<a href="http://www.tavendo.de/autobahn/protocol.html">WebSocket Application Messaging Protocol (WAMP)</a>
<a href="http://autobahn.ws">AutobahnAndroid</a> also
includes an implementation of <a href="http://wamp.ws">The WebSocket Application Messaging Protocol (WAMP)</a>
which can be used to build applications around <b>Remote Procedure Call</b> and
<b>Publish & Subscribe</b> messaging patterns.
It features:
\li RPC and PubSub messaging
\li RPC and PubSub, fully asynchronous design
\li built on JSON and WebSockets
\li simple and open protocol
\li simple, efficient and open protocol
\li automatic mapping to user-defined POJOs
\li seamless integration in Android UI apps
\li Open-Source, licensed under the Apache 2.0 license
Call results and events which travel the wire as JSON payload are automatically
converted and mapped to Java primitive types or user-defined POJOs (Plain-old Java Objects).
Expand All @@ -81,16 +88,16 @@ The API enables the use of common Android idioms for event handling (using
\section usage Usage
The only dependency of
<a href="http://www.tavendo.de/autobahn">Autobahn WebSockets for Android</a>
<a href="http://autobahn.ws">AutobahnAndroid</a>
is <a href="http://jackson.codehaus.org/">Jackson</a>.
To use, all one needs to do is to include the built JARs into an Android
project.
\section more More Information
For more information, please visit the <a href="http://www.tavendo.de/autobahn">project homepage</a>,
For more information, please visit the <a href="http://autobahn.ws/developers">project page</a>,
the <a href="http://groups.google.com/group/autobahnws">forum</a> or the
<a href="https://github.com/oberstet/AutobahnAndroid">code repository</a>.
<a href="https://github.com/tavendo/AutobahnAndroid">code repository</a>.
Commercial support and services is available from <a href="http://www.tavendo.de">Tavendo GmbH</a>.
*/

Expand Down

0 comments on commit 93bc483

Please sign in to comment.