Skip to content

Latest commit

 

History

History
148 lines (82 loc) · 3.81 KB

getting_started.rst

File metadata and controls

148 lines (82 loc) · 3.81 KB

Getting Started

Requirements

No external component or library is required. You simply need a standard PHP installation to work with Jaxl.

Library has been developed and tested extensively on linux operating systems. But there is no reason why it should not work on other OS. File an issue if you face any glitches.

Install

Use Composer to install:

php composer.phar require "jaxl/jaxl=^3.1.0"

Then use autoloader in your application:

require dirname(__FILE__) . '/vendor/autoload.php';

Library Structure

Jaxl library comprises of following packages:

  • jaxl-core

    contains generic networking and eventing components

  • jaxl-xmpp

    contains xmpp rfc implementation

  • jaxl-xmpp-xep

    contains various xmpp xep implementation

  • jaxl-http

    contains http rfc implementation

  • jaxl-docs

    this documentation comes from this package

  • jaxl-tests

    test suites for all the above packages

Inside Jaxl everything that you will interact with will be an object which will emit events and callbacks which we will be able to catch in our applications for custom processing and routing. Listed below are a few main objects:

  1. Core Stack

  • JAXLLoop

    main select loop

  • JAXLClock

    timed job/callback dispatcher

  • JAXLEvent

    event registry and emitter

  • JAXLFsm

    generic finite state machine

  • JAXLSocketClient

    generic tcp/udp client

  • JAXLSocketServer

    generic tcp/udp server

  • JAXLXmlStream

    streaming XML parser

  • JAXLXml

    custom XML object implementation

  • JAXLLogger

    logging facility

  1. XMPP Stack

  • XMPPStream

    base xmpp rfc implementation

  • XMPPStanza

    provides easy access patterns over xmpp stanza (wraps JAXLXml)

  • XMPPIq

    xmpp iq stanza object (extends XMPPStanza)

  • XMPPMsg

    xmpp msg stanza object (extends XMPPStanza)

  • XMPPPres

    xmpp pres stanza object (extends XMPPStanza)

  • XMPPXep

    abstract xmpp extension (extended by XEP implementations)

  • XMPPJid

    xmpp jid object

  1. HTTP Stack

  • HTTPServer

    http server implementation

  • HTTPClient

    http client implementation

  • HTTPRequest

    http request object

  • HTTPResponse

    http response object

Questions, Bugs and Issues

If you have any questions kindly post them on google groups. Groups are the quickest way to get an answer to your questions which is actively monitored by core developers.

If you are facing a bug or issue, please report that it on github issue tracker. You can even :ref:`contribute to the library <developer-introduction>` if you already have fixed the bug.