summaryrefslogtreecommitdiff
path: root/doc/basic_usage.rst
diff options
context:
space:
mode:
authorRyan Williams <rdw@lindenlab.com>2010-02-21 09:57:29 -0500
committerRyan Williams <rdw@lindenlab.com>2010-02-21 09:57:29 -0500
commit9a3f2cca1253c535e718f723b9c2aca1ea0a2ac2 (patch)
tree2f924a3ec948c96dd4545e3a5485b8ed08227bf7 /doc/basic_usage.rst
parentc268aaf6d10fb45ef01a9dab6245369ca96f2292 (diff)
downloadeventlet-9a3f2cca1253c535e718f723b9c2aca1ea0a2ac2.tar.gz
Putting connect and listen into eventlet; fixing up the way the docs look when rendered, removed reference to serve in listen's doc since it's not complete yet.
Diffstat (limited to 'doc/basic_usage.rst')
-rwxr-xr-x[-rw-r--r--]doc/basic_usage.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/basic_usage.rst b/doc/basic_usage.rst
index fb18972..c7a68e1 100644..100755
--- a/doc/basic_usage.rst
+++ b/doc/basic_usage.rst
@@ -31,6 +31,10 @@ Though Eventlet has many modules, much of the most-used stuff is accessible simp
Suspends the current greenthread and allows others a chance to process. See :func:`sleep <eventlet.greenthread.sleep>` for more details.
+.. autofunction:: eventlet.connect
+
+.. autofunction:: eventlet.listen
+
.. class:: eventlet.GreenPool
Pools control concurrency. It's very common in applications to want to consume only a finite amount of memory, or to restrict the amount of connections that one part of the code holds open so as to leave more for the rest, or to behave consistently in the face of unpredictable input data. GreenPools provide this control. See :class:`GreenPool <eventlet.greenpool.GreenPool>` for more on how to use these.
@@ -58,5 +62,6 @@ Though Eventlet has many modules, much of the most-used stuff is accessible simp
Globally patches certain system modules to be greenthread-friendly. The keyword arguments afford some control over which modules are patched. If *all* is True, then all modules are patched regardless of the other arguments. If it's False, then the rest of the keyword arguments control patching of specific subsections of the standard library. Most patch the single module of the same name (os, time, select). The exceptions are socket, which also patches the ssl module if present; and thread, which patches thread, threading, and Queue. It's safe to call monkey_patch multiple times. For more information see :ref:`monkey-patch`.
+
These are the basic primitives of Eventlet; there are a lot more out there in the other Eventlet modules; check out the :doc:`modules`.