API
Top-level application package
Application
Handles WebSocket requests and HTTP requests
-
exception araldo.app.AppException(msg)[source]
An internal exception
-
exception araldo.app.TooLong[source]
Indicates a gevent timeout
-
class araldo.app.WebSocketApp(config, queue, plugin_manager)[source]
Provides bidirectional communication:
- inbound via WebSocket
- outbound via regular HTTP request
-
class araldo.app.WebSocketApp(config, queue, plugin_manager)[source]
Provides bidirectional communication:
- inbound via WebSocket
- outbound via regular HTTP request
-
__call__(environ, start_response)[source]
main WSGI method
Server
Launches WSGI server process hosting WebSocketApp
-
araldo.server.main()[source]
Server main method
-
araldo.server.parse_args(args)[source]
Get parser for command line parameters
-
araldo.server.setup_logging(config)[source]
Configure logger, log level, etc.
-
araldo.server.setup_plugins(logger, config)[source]
Load and instantiate plugins
-
araldo.server.setup_sending(config, queue, plugin_manager)[source]
Set up sending of outbound messages
-
araldo.server.setup_signals()[source]
Setup OS signals for graceful termination of server
-
araldo.server.sig_handler(signum, frame)[source]
Handles abortion; e.g. by pressing CTRL+C
-
araldo.server.start_server(config, port, queue, plugin_manager, start_method=<function <lambda> at 0x3294398>)[source]
Launches WSGI server that will listen forever
Communication Endpoints
Communication endpoints
-
class araldo.endpoints.EndPointBase(**kwargs)[source]
Abstract base class for Araldo endpoints
Concrete classes must implement Greenlet’s _run method to
process incoming messages and to enque them into gevent_queue
-
config()[source]
Plugin configuration sub-object
-
description()[source]
Textual description of plugin
-
gevent_queue[source]
gevent target queue
-
marshalling()[source]
Short, human-readable name marshalling used
-
name()[source]
Short, human-readable name of plugin
-
plugin_manager()[source]
plugin manager for loading other plugins
-
send(message)[source]
Send message to backend
-
exception araldo.endpoints.PluginException(msg)[source]
An end-point related exception