Python socktools documentation

socktools is a python package that abstracts away all the messy parts of implementing a message-based protocol on top of a socket.

Contents

• Basic overview
  • How socktools is organised
• Modules
  • Core modules
    • socktools.base_sock - base socket implementation
    • socktools.meta_sock - one socket to rule them all
  • Socket implementations
    • socktools.tcp_sock - P2P TCP implementation
    • socktools.udp_sock - UDP implementation
    • socktools.wsgi_websocket_sock
  • Utility mixins
    • socktools.msgtype_mixin - reference message types by name
    • socktools.json_mixin - JSON formatted messages
    • socktools.msgpack_mixin - msgpack formatted messages
    • socktools.tcp_linemode_mixin - line by line support for TCP servers
    • socktools.http_mixin - toy HTTP implementation
      • Overview
      • Python API
  • Embedded webserver
    • socktools.webwrap - web.py WSGI wrapper
  • Daemons and servers
    • socktools.daemon.base_daemon - UNIX daemon basic implementation
    • socktools.daemon.cron_timer - cron-like timers for daemons
• Full applications
  • Overview
  • Servers
    • socktools.apps.geekircd - an IRC server for geeks
      • Overview
      • geekircd.py
      • geekirc/irc_sock.py
      • geekirc/meta_chat.py
• Examples
  • How to run the examples
  • Simple examples
    • socktools.examples.simple_chat
    • socktools.examples.simple_dns
  • Web examples
    • socktools.examples.ws_dumper
    • socktools.examples.simple_http
      • Overview
      • Python API
• Tools and utilities
  • What the tools do
  • Running the tools
  • Generator tools
    • gen_proto.py - generate a protocol from a specification
      • Overview
      • Usage
      • JSON specification format
      • Examples
        • build_example_chat.py - generate the chat protocol
          • Overview
        • socktools.tools.examples.gen_proto.chat_server
        • socktools.tools.examples.gen_proto.chat_client
      • Python API

Indices and tables

• Index
• Module Index
• Search Page