Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abhinavsingh committed Nov 27, 2012
1 parent b626cd8 commit 4ca6efc
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Expand Up @@ -9,10 +9,11 @@ philosophies from my experience with erlang and python languages.
Jaxl is an asynchronous, non-blocking I/O, event based PHP library
for writing custom TCP/IP client and server implementations.
From it's previous versions, library inherits a full blown stable support
for XMPP protocol stack. In v3.0, support for HTTP protocol stack was
also added.
for [XMPP protocol stack](https://github.com/abhinavsingh/JAXL/tree/v3.x/xmpp).
In v3.0, support for [HTTP protocol stack](https://github.com/abhinavsingh/JAXL/tree/v3.x/http)
has also been added.

At the heart of every protocol stack sits a Core stack.
At the heart of every protocol stack sits the [Core stack](https://github.com/abhinavsingh/JAXL/tree/v3.x/core).
It contains all the building blocks for everything that we aim to do with Jaxl library.
Both XMPP and HTTP protocol stacks are written on top of the Core stack.
Infact the source code of protocol implementations knows nothing
Expand All @@ -26,4 +27,4 @@ about the standard (inbuilt) PHP socket and stream methods.

[Create a bug/issue](https://github.com/abhinavsingh/JAXL/issues/new)

[Author](http://abhinavsingh.com/)
[Author](http://abhinavsingh.com/)
17 changes: 17 additions & 0 deletions core/README.md
@@ -0,0 +1,17 @@
Jaxl Core Stack:
----------------
Core stack implementation includes:

* JAXLLoop - Event Loop
* JAXLClock - Time and Periodic Job server
* JAXLSocketClient - Generic Non-Blocking Socket Client
* JAXLSocketServer - Generic Non-Blocking Socket Server
* JAXLCli - Generic Non-Blocking Command Line Interface
* JAXLEvent - Generic Event Emitter
* JAXLFsm - Generic Finite State Machine
* JAXLLogger - Logging utilities
* JAXLPipe - Bidirectional Communication between Processes using Unix Pipes
* JAXLSock5 - SOCKS5 RFC Implementation
* JAXLXml - Light Weight XML Representation
* JAXLXmlStream - Streaming XML Parser
* JAXLException - Error, Exception and Shutdown handler
9 changes: 9 additions & 0 deletions http/README.md
@@ -0,0 +1,9 @@
Jaxl HTTP Stack:
----------------
HTTP Stack implementation includes:

* HTTPClient - Generic HTTP Client
* HTTPServer - Generic HTTP Server
* HTTPRequest - A HTTP Request Object
* HTTPDispatcher - HTTP REST Url Dispatcher
* HTTPMultiPart - HTTP MultiPart Body
14 changes: 14 additions & 0 deletions xep/README.md
@@ -0,0 +1,14 @@
Jaxl XMPP XEP's:
----------------
Following XMPP Extensions are available:

* 0030 - Service Discovery
* 0045 - Multi-User Chat
* 0060 - Publish-Subscribe
* 0077 - In-Band Registration
* 0114 - Jabber Component
* 0115 - Entity Capabilities
* 0199 - XMPP Ping
* 0203 - Delayed Delivery
* 0206 - XMPP Over BOSH
* 0249 - Direct MUC Invitation
12 changes: 12 additions & 0 deletions xmpp/README.md
@@ -0,0 +1,12 @@
Jaxl XMPP Stack:
----------------
XMPP Stack implementation includes:

* XMPPStream - RFC 6120 and RFC 6121
* XMPPXep - Abstract XMPP Extension class
* XMPPStanza - Generic Stanza object
* XMPPPres - Generic Presence object
* XMPPMsg - Generic Message object
* XMPPIq - Generic IQ object
* XMPPJid - JabberId object
* XMPPRosterItem - A XMPP Roster Item representation

0 comments on commit 4ca6efc

Please sign in to comment.