summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJames E. Blair <jeblair@openstack.org>2013-05-02 17:38:47 -0700
committerJames E. Blair <jeblair@openstack.org>2013-05-04 08:20:51 -0700
commit61bd6ce5708d27015bb9ccf01aff99bb2b0ac2d8 (patch)
treeebe5cd2476c8d1bd3d21a17fc8328f8016433078 /doc
parent772d256328b4c876a0f308240ef941800def55fc (diff)
downloadgear-61bd6ce5708d27015bb9ccf01aff99bb2b0ac2d8.tar.gz
Add simple Gearman server.
For testing, not for real use under load. Change-Id: I9c84b1eea7d868e907b80b6edf60c49c172c356b
Diffstat (limited to 'doc')
-rw-r--r--doc/source/index.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 31bd184..584bd37 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -10,6 +10,9 @@ it simple, with a relatively thin abstration of the Gearman protocol
itself. It should be easy to use to build a client or worker that
operates either synchronously or asynchronously.
+The module also provides a simple Gearman server for use as a
+convenience in unit tests. The server is not designed for production
+use under load.
Client Example
--------------
@@ -137,6 +140,20 @@ AdminRequest Objects
:inherited-members:
+Server Usage
+------------
+
+A simple Gearman server is provided for convenience in unit testing,
+but is not designed for production use at scale. It takes no
+parameters other than the port number on which to listen.
+
+Server Objects
+^^^^^^^^^^^^^^
+.. autoclass:: gear.Server
+ :members:
+ :inherited-members:
+
+
Common
------