Guide to the C API

This section gives a high-level view of libyimmo usage, architecture, and development files. It isn’t a tutorial (coming soon!), just some supplementary information that ought to make the API docs 1 more intelligible.

The Basics

At a high-level, this is the way it works:

1. Implement each of the callbacks required by some protocol

   (e.g. see The HTTP Protocol)

2. Create a protocol object, passing in your callbacks.

   (e.g. ymo_proto_http_create())

3. Create, initialize, and start your server

   (ymo_server_create(), ymo_server_init(), ymo_server_start())

4. Start your event loop with ev_run.

Sections

• Architecture
  • Interaction
  • Data
    • Example: HTTP Data
• Settings
  • Runtime
  • Compile-Time
• Installed Files
  • Header Files and Libs
  • Pkg-Config
    • Autotools
  • Symlinks
• The HTTP Protocol
  • Sessions & Exchanges
  • Callbacks
  • Buffering
    • Buffered Requests
    • Unbuffered Requests
  • Generating Responses
    • Transfer-Encoding and Content-Length
    • Synchronous Response Handling
    • Asynchronous Response Handling
  • Quirks
    • Character Constraints
    • Headers

1

(WIP, also — like everything else here!)