<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY roadrunner-RRChannel SYSTEM "sgml/rr-channel.sgml">
<!ENTITY roadrunner-RRConnection SYSTEM "sgml/rr-connection.sgml">
<!ENTITY roadrunner-RRFrame SYSTEM "sgml/rr-frame.sgml">
<!ENTITY roadrunner-RRListener SYSTEM "sgml/rr-listener.sgml">
<!ENTITY roadrunner-RRManager SYSTEM "sgml/rr-manager.sgml">
<!ENTITY roadrunner-RRMime SYSTEM "sgml/rr-mime.sgml">
<!ENTITY roadrunner-RRProfileRegistry SYSTEM "sgml/rr-profileregistry.sgml">
<!ENTITY roadrunner-RRFilter SYSTEM "sgml/rr-filter.sgml">
<!ENTITY roadrunner-RRGreeting SYSTEM "sgml/rr-greeting.sgml">
<!ENTITY roadrunner-RRMessageClose SYSTEM "sgml/rr-message-close.sgml">
<!ENTITY roadrunner-RRMessageError SYSTEM "sgml/rr-message-error.sgml">
<!ENTITY roadrunner-RRMessageStart SYSTEM "sgml/rr-message-start.sgml">
<!ENTITY roadrunner-RRMessageStatic SYSTEM "sgml/rr-message-static.sgml">
<!ENTITY roadrunner-RRMessage SYSTEM "sgml/rr-message.sgml">
<!ENTITY roadrunner-RRMessageStartRpy SYSTEM "sgml/rr-message-startrpy.sgml">
<!ENTITY roadrunner-RRFrameSeq SYSTEM "sgml/rr-frame-seq.sgml">
<!ENTITY roadrunner-RRTCPConnection SYSTEM "sgml/rr-tcpconnection.sgml">
<!ENTITY roadrunner-RRTCPListener SYSTEM "sgml/rr-tcplistener.sgml">
<!ENTITY roadrunner-RRTCPFilter SYSTEM "sgml/rr-tcpfilter.sgml">
<!ENTITY roadrunner-rr-framefactory SYSTEM "sgml/rr-framefactory.sgml">
<!ENTITY roadrunner-rr SYSTEM "sgml/rr.sgml">
<!ENTITY roadrunner-RRWorkPool SYSTEM "sgml/rr-workpool.sgml">
<!ENTITY roadrunner-rr-beeperror SYSTEM "sgml/rr-beeperror.sgml">
<!ENTITY roadrunner-rr-filterstack SYSTEM "sgml/rr-filterstack.sgml">
<!ENTITY index-Object-Tree SYSTEM "sgml/tree_index.sgml">
]>
<book id="index">
  <bookinfo>
    <title>RoadRunner Reference Manual</title>
  </bookinfo>

  <chapter role="no-toc">
    <title>What is RoadRunner</title>
    <sect1>
      <title>Introduction</title>
      <para>
      RoadRunner is a complete application toolkit library implementing the 
      BEEP (Blocks Extensible Exchange Protocol) for use in developing network 
      applications. Apart from BEEP, RoadRunner also consists of a useful set of 
      profiles, readily available and usable in applications.
      </para>
    </sect1>
    <sect1>
      <title>Features</title>
      <para>
      Some major features and strengths in RoadRunner are:
      <variablelist>
      <varlistentry>
      <term>Portability</term>
      <listitem>
	<para>
	Runs unmodified on most major platforms.
	</para>
      </listitem>
      </varlistentry>
      <varlistentry>
      <term>Object oriented design</term>
      <listitem>
	<para>
	RoadRunner is designed in an object oriented 
	fashion, making development of new BEEP profiles simple and 
	straight-forward.
	</para>
      </listitem>
      </varlistentry>
      <varlistentry>
      <term>Robustness and stability</term>
      <listitem>
	<para>
	The software contains extensive validation 
	checks and error reporting, allowing for quickly locating and fixing bugs. 
	As a result, RoadRunner is already at its first release a very stable 
	library.
	</para>
      </listitem>
      </varlistentry>
      <varlistentry>
      <term>High performance</term>
      <listitem>
	<para>
	Nonblocking design, constant message processing time 
	and intra-connection channel scheduling capability makes RoadRunner a 
	suitable framework for realtime messaging applications.
	</para>
      </listitem>
      </varlistentry>
      <varlistentry>
      <term>Multithreaded</term>
      <listitem>
	<para>
	Using the threads abstraction layer in glib, RoadRunner 
	runs natively multithreaded on all supported platforms.
	</para>
      </listitem>
      </varlistentry>
      </variablelist>
      </para>
    </sect1>
  </chapter>
  <chapter>
    <title>RoadRunner Classes and Objects</title>
    <sect1>
      <title>Object Hierarchy</title>
      &index-Object-Tree;
    </sect1>
    <sect1>
      <title>RoadRunner Fundamentals</title>
      &roadrunner-rr;
      &roadrunner-RRChannel;
      &roadrunner-RRConnection;
      &roadrunner-RRFrame;
      &roadrunner-RRListener;
      &roadrunner-RRManager;
      &roadrunner-RRMime;
      &roadrunner-RRProfileRegistry;
      &roadrunner-RRFilter;
      &roadrunner-rr-framefactory;
      &roadrunner-RRWorkPool;
      &roadrunner-rr-beeperror;
      &roadrunner-rr-filterstack;
    </sect1>
    <sect1>
      <title>RoadRunner message classes</title>
      &roadrunner-RRMessage;
      &roadrunner-RRMessageClose;
      &roadrunner-RRMessageError;
      &roadrunner-RRMessageStart;
      &roadrunner-RRMessageStatic;
      &roadrunner-RRMessageStartRpy;
      &roadrunner-RRGreeting;
    </sect1>
    <sect1>
      <title>TCP/IP specific</title>
      &roadrunner-RRTCPConnection;
      &roadrunner-RRTCPListener;
      &roadrunner-RRTCPFilter;
      &roadrunner-RRFrameSeq;
    </sect1>
  </chapter>
</book>
