Permalink
Browse files

updated README

  • Loading branch information...
1 parent b864422 commit 1b435cb53f8e08130c400d0e9dc0d319792a9087 Felix Richter committed Jan 19, 2011
Showing with 6 additions and 5 deletions.
  1. +6 −5 README.md
View
@@ -14,21 +14,22 @@ Currently the python implementation has the following submodules
Version number of the script and the configuration given
* auto\_amqp.py - the amqp connector class which provides the following
functions:
- * load\_conf - loads and merges configuration from the given dictionary
+ * load\_conf(str) - loads and merges configuration from the given dictionary
- * load\_conf\_file - loads and merges configuration directly from a file
+ * load\_conf\_file(fname) - loads and merges configuration directly from a file
- * create\_connection - starts the connection the the AMQP Server
+ * create\_connection() - starts the connection the the AMQP Server
- * \_setup\_tubes - creates the in 'config' configured input and output
- queues/exchanges
+ * [internal] \_setup\_tubes - creates the in 'config' configured input and output
+ queues/exchanges. will be called by create_connection
in addition it registers the following functions if input exchange is
defined:
* consume (callback) - calls amqp's basic\_consume with the correct
params
* start\_loop () - calls asyncore\_loop()
the following function is registered if the output exchange is defined
* publish (msg) - sends a message to the output exchange
+ * close\_connection () - closes all connections, cleans up the object
In addition to that, auto\_amqp.py needs to hold a "default parameter"
list called DEFAULT\_CONFIG.

0 comments on commit 1b435cb

Please sign in to comment.