Files
Hippolyzer/docs/html/.doctrees/modules/event_queue.doctree

65 lines
10 KiB
Plaintext
Raw Normal View History

<EFBFBD>(cdocutils.nodes
document
qoq}q(U nametypesq}q(X0pyogp.lib.base.event_queue.EventQueueClient.stopqKX1pyogp.lib.base.event_queue.EventQueueClient.startqKX event_queueqNX+pyogp.lib.base.event_queue.EventQueueClientq KuUsubstitution_defsq
}q Uparse_messagesq ]q Ucurrent_sourceqNU
decorationqNUautofootnote_startqKUnameidsq}q(hhhhhU event-queueqh h uUchildrenq]q(cdocutils.nodes
section
qoq}q(U rawsourceqUUparentqhUsourceqUU/Users/enus/svn/pyogp.buildout/src/pyogp.lib.base/docs/source/modules/event_queue.rstqUtagnameqUsectionqU
attributesq}q (Udupnamesq!]q"Uclassesq#]q$Ubackrefsq%]q&Uidsq']q(X!module-pyogp.lib.base.event_queueq)aUnamesq*]q+hauUlineq,KUdocumentq-hh]q.((cdocutils.nodes
title
q/oq0}q1(hX:mod:`event_queue`q2hhhhhUtitleq3h}q4(h!]q5h#]q6h%]q7h']q8h*]q9uh,Kh-hh]q:(csphinx.addnodes
pending_xref
q;oq<}q=(hh2hh0hU pending_xrefq>h}q?(Ureftypeq@XmodqAUmodnameqBNU
refcaptionqC<EFBFBD>U reftargetqDX event_queueqEh']qFh%]qGU classnameqHNh!]qIh#]qJh*]qKuh,Kh]qL(cdocutils.nodes
literal
qMoqN}qO(hh2h}qP(h!]qQh#]qRUxrefqSah%]qTh']qUh*]qVuhh<h]qW(cdocutils.nodes
Text
qXoqY}qZ(hUUdataq[hEhhNubahUliteralq\ubaubaub(csphinx.addnodes
index
q]oq^}q_(hUhhhU <autodoc>q`hUindexqah}qb(h']qch%]qdh!]qeh#]qfh*]qgUentriesqh]qi(UsingleqjX#pyogp.lib.base.event_queue (module)X!module-pyogp.lib.base.event_queueXpyogp.lib.base.event_queueqktqlauh,Kh-hh]qmub(csphinx.addnodes
module
qnoqo}qp(hUhhhh`hUmoduleqqh}qr(Umodnameqshkh']qth%]quh!]qvUsynopsisqwUh#]qxh*]qyuh,Kh-hh]qzub(h]oq{}q|(hUhhhNhhah}q}(h']q~h%]qh!]q<>h#]q<>h*]q<>Uentriesq<73>]q<>(hjX6EventQueueClient (class in pyogp.lib.base.event_queue)h h tq<74>auh,Nh-hh]q<>ub(csphinx.addnodes
desc
q<EFBFBD>oq<EFBFBD>}q<>(hUhhhNhUdescq<63>h}q<>(Unoindexq<78><71>h']q<>h%]q<>h!]q<>h#]q<>h*]q<>Udesctypeq<65>Xclassq<73>uh,Nh-hh]q<>((csphinx.addnodes
desc_signature
q<EFBFBD>oq<EFBFBD>}q<>(hXQEventQueueClient(capability=None, settings=None, message_handler=None, host=None)q<>hh<>hU <autodoc>q<>hUdesc_signatureq<65>h}q<>(h']q<>h ah%]q<>h!]q<>h#]q<>h*]q<>h aUfirstq<74><71>uh,Nh-hh]q<>((csphinx.addnodes
desc_annotation
q<EFBFBD>oq<EFBFBD>}q<>(hXclass q<>hh<>hh<>hUdesc_annotationq<6E>h}q<>(h!]q<>h#]q<>h%]q<>h']q<>h*]q<>uh,Nh-hh]q<>(hXoq<6F>}q<>(hUh[h<>hh<>ubaub(csphinx.addnodes
desc_addname
q<EFBFBD>oq<EFBFBD>}q<>(hXpyogp.lib.base.event_queue.q<>hh<>hh<>hU desc_addnameq<65>h}q<>(h!]q<>h#]q<>h%]q<>h']q<>h*]q<>uh,Nh-hh]q<>(hXoq<6F>}q<>(hUh[h<>hh<>ubaub(csphinx.addnodes
desc_name
q<EFBFBD>oq<EFBFBD>}q<>(hXEventQueueClientq<74>hh<>hh<>hU desc_nameq<65>h}q<>(h!]q<>h#]q<>h%]q<>h']q<>h*]q<>uh,Nh-hh]q<>(hXoq<6F>}q<>(hUh[h<>hh<>ubaub(csphinx.addnodes
desc_parameterlist
q<EFBFBD>oq<EFBFBD>}q<>(hUhh<>hh<>hUdesc_parameterlistq<74>h}q<>(h!]q<>h#]q<>h%]q<>h']q<>h*]q<>uh,Nh-hh]q<>((csphinx.addnodes
desc_parameter
q<EFBFBD>oq<EFBFBD>}q<>(hXcapability=Noneq<65>hh<>hh<>hUdesc_parameterq<72>h}q<>(h!]q<>h#]q<>h%]q<>h']q<>h*]q<>uh,Nh-hh]q<>(hXoq<6F>}q<>(hUh[h<>hh<>ubaub(h<>oq<6F>}q<>(hX settings=Noneq<65>hh<>hh<>hh<>h}q<>(h!]q<>h#]q<>h%]q<>h']q<>h*]q<>uh,Nh-hh]q<>(hXoq<6F>}q<>(hUh[h<>hh<>ubaub(h<>oq<6F>}q<>(hXmessage_handler=Noneq<65>hh<>hh<>hh<>h}q<>(h!]q<>h#]q<>h%]q<>h']q<>h*]q<>uh,Nh-hh]q<>(hXoq<6F>}q<>(hUh[h<>hh<>ubaub(h<>oq<6F>}q<>(hX host=Nonerhh<>hh<>hh<>h}r(h!]rh#]rh%]rh']rh*]ruh,Nh-hh]r(hXor}r (hUh[jhh<>ubaubeubeub(csphinx.addnodes
desc_content
r
or }r (hUhh<>hh<>hU desc_contentr h}r(h!]rh#]rh%]rh']rh*]ruh,Nh-hh]r((cdocutils.nodes
paragraph
ror}r(hX?handles an event queue of either an agent domain or a simulatorrhj hX<>/Users/enus/svn/pyogp.buildout/src/pyogp.lib.base/pyogp/lib/base/event_queue.py:docstring of pyogp.lib.base.event_queue.EventQueueClientrhU paragraphrh}r(h!]rh#]rh%]rh']rh*]r uh,Kh-hh]r!(hXor"}r#(hjh[X?handles an event queue of either an agent domain or a simulatorr$hjubaub(jor%}r&(hXGInitialize the event queue client class
>>> client = EventQueueClient()r'hj hjhjh}r((h!]r)h#]r*h%]r+h']r,h*]r-uh,Kh-hh]r.(hXor/}r0(hj'h[XGInitialize the event queue client class
>>> client = EventQueueClient()r1hj%ubaub(jor2}r3(hX<>The event queue client requires an event queue capability
>>> from pyogp.lib.base.caps import Capability
>>> cap = Capability('EventQueue', http://localhost:12345/cap)r4hj hjhjh}r5(h!]r6h#]r7h%]r8h']r9h*]r:uh,K
h-hh]r;((hXor<}r=(hX<>The event queue client requires an event queue capability
>>> from pyogp.lib.base.caps import Capability
>>> cap = Capability('EventQueue', r>h[X<>The event queue client requires an event queue capability
>>> from pyogp.lib.base.caps import Capability
>>> cap = Capability('EventQueue', r?hj2ub(cdocutils.nodes
reference
r@orA}rB(hXhttp://localhost:12345/caprCh}rD(UrefurirEXhttp://localhost:12345/caprFh']rGh%]rHh!]rIh#]rJh*]rKuhj2h]rL(hXorM}rN(hUh[jFhjAubahU referencerOub(hXorP}rQ(hX)h[X)hj2ubeub(cdocutils.nodes
doctest_block
rRorS}rT(hX?>>> event_queue = EventQueueClient(cap)
>>> event_queue.start()rUhj hjhU doctest_blockrVh}rW(U xml:spacerXUpreserverYh']rZh%]r[h!]r\h#]r]h*]r^uh,K h-hh]r_(hXor`}ra(hUh[jUhjSubaub(jorb}rc(hXBSample implementations: region.py
Tests: tests/test_event_queue.pyrdhj hjhjh}re(h!]rfh#]rgh%]rhh']rih*]rjuh,Kh-hh]rk(hXorl}rm(hjdh[XBSample implementations: region.py
Tests: tests/test_event_queue.pyrnhjbubaub(joro}rp(hX!set up the event queue attributesrqhj hjhjh}rr(h!]rsh#]rth%]ruh']rvh*]rwuh,Kh-hh]rx(hXory}rz(hjqh[X!set up the event queue attributesr{hjoubaub(h]or|}r}(hUhj hX<>/Users/enus/svn/pyogp.buildout/src/pyogp.lib.base/pyogp/lib/base/event_queue.py:docstring of pyogp.lib.base.event_queue.EventQueueClient.startr~hhah}r(h']r<>h%]r<>h!]r<>h#]r<>h*]r<>Uentriesr<73>]r<>(hjX<start() (pyogp.lib.base.event_queue.EventQueueClient method)hhtr<74>auh,Nh-hh]r<>ub(h<>or<6F>}r<>(hUhj hj~hh<>h}r<>(h<><68>h']r<>h%]r<>h!]r<>h#]r<>h*]r<>h<>Xmethodr<64>uh,Nh-hh]r<>((h<>or<6F>}r<>(hXEventQueueClient.start()r<>hj<>hh<>hh<>h}r<>(h']r<>hah%]r<>h!]r<>h#]r<>h*]r<>hah<61><68>uh,Nh-hh]r<>((h<>or<6F>}r<>(hXstartr<74>hj<>hh<>hh<>h}r<>(h!]r<>h#]r<>h%]r<>h']r<>h*]r<>uh,Nh-hh]r<>(hXor<6F>}r<>(hUh[j<>hj<>ubaub(h<>or<6F>}r<>(hUhj<>hh<>hh<>h}r<>(h!]r<>h#]r<>h%]r<>h']r<>h*]r<>uh,Nh-hh]r<>ubeub(j
or<6F>}r<>(hUhj<>hh<>hj h}r<>(h!]r<>h#]r<>h%]r<>h']r<>h*]r<>uh,Nh-hh]r<>(jor<6F>}r<>(hX>spawns a coroutine connecting to the event queue on the targetr<74>hj<>hj~hjh}r<>(h!]r<>h#]r<>h%]r<>h']r<>h*]r<>uh,Kh-hh]r<>(hXor<6F>}r<>(hj<>h[X>spawns a coroutine connecting to the event queue on the targetr<74>hj<>ubaubaubeub(h]or<6F>}r<>(hUhj hX<>/Users/enus/svn/pyogp.buildout/src/pyogp.lib.base/pyogp/lib/base/event_queue.py:docstring of pyogp.lib.base.event_queue.EventQueueClient.stopr<70>hhah}r<>(h']r<>h%]r<>h!]r<>h#]r<>h*]r<>Uentriesr<73>]r<>(hjX;stop() (pyogp.lib.base.event_queue.EventQueueClient method)hhtr<74>auh,Nh-hh]r<>ub(h<>or<6F>}r<>(hUhj hj<>hh<>h}r<>(h<><68>h']r<>h%]r<>h!]r<>h#]r<>h*]r<>h<>Xmethodr<64>uh,Nh-hh]r<>((h<>or<6F>}r<>(hXEventQueueClient.stop()r<>hj<>hh<>hh<>h}r<>(h']r<>hah%]r<>h!]r<>h#]r<>h*]r<>hah<61><68>uh,Nh-hh]r<>((h<>or<6F>}r<>(hXstopr<70>hj<>hh<>hh<>h}r<>(h!]r<>h#]r<>h%]r<>h']r<>h*]r<>uh,Nh-hh]r<>(hXor<6F>}r<>(hUh[j<>hj<>ubaub(h<>or<6F>}r<>(hUhj<>hh<>hh<>h}r<>(h!]r<>h#]r<>h%]r<>h']r<>h*]r<>uh,Nh-hh]r<>ubeub(j
or<6F>}r<>(hUhj<>hh<>hj h}r(h!]rh#]rh%]rh']rh*]ruh,Nh-hh]r(jor}r(hX@trigger the event queue to stop communicating with the simulatorr hj<>hj<>hjh}r
(h!]r h#]r h%]r h']rh*]ruh,K h-hh]r(hXor}r(hj h[X@trigger the event queue to stop communicating with the simulatorrhjubaubaubeubeubeubeubahUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]r h-hU current_liner!NUtransform_messagesr"]r#Ureporterr$NUid_startr%KU autofootnotesr&]r'U citation_refsr(}r)Uindirect_targetsr*]r+Usettingsr,(cdocutils.frontend
Values
r-or.}r/(Ufootnote_backlinksr0KUrecord_dependenciesr1NU rfc_base_urlr2Uhttp://tools.ietf.org/html/r3U tracebackr4KUpep_referencesr5NUstrip_commentsr6NU toc_backlinksr7Uentryr8U language_coder9Uenr:U datestampr;NU report_levelr<KU _destinationr=NU
halt_levelr>KU strip_classesr?Nh3NUerror_encoding_error_handlerr@UbackslashreplacerAUdebugrBNUembed_stylesheetrC<00>Uoutput_encoding_error_handlerrDUstrictrEU sectnum_xformrFKUdump_transformsrGNU docinfo_xformrHKUwarning_streamrINUpep_file_url_templaterJUpep-%04drKUexit_status_levelrLKUconfigrMNUstrict_visitorrNNUcloak_email_addressesrO<00>Utrim_footnote_reference_spacerP<00>UenvrQNUdump_pseudo_xmlrRNUexpose_internalsrSNUsectsubtitle_xformrT<00>U source_linkrUNUrfc_referencesrVNUoutput_encodingrWUutf-8rXU
source_urlrYNUinput_encodingrZU utf-8-sigr[U_disable_configr\NU id_prefixr]UU tab_widthr^KUerror_encodingr_Uasciir`U_sourcerahU generatorrbNUdump_internalsrcNU pep_base_urlrdUhttp://www.python.org/dev/peps/reUinput_encoding_error_handlerrfjEUauto_id_prefixrgUidrhUdoctitle_xformri<00>Ustrip_elements_with_classesrjNU _config_filesrk]rlUfile_insertion_enabledrmKU raw_enabledrnKU dump_settingsroNubUsymbol_footnote_startrpKUidsrq}rr(hhhj<>hj<>h h<>h)(cdocutils.nodes
target
rsort}ru(hUhhhh`hUtargetrvh}rw(h!]rxh'h(h%]ryUismodrz<00>h#]r{h*]r|uh,Kh-hh]r}ubuUsubstitution_namesr~}rhh-h}r<>(h!]r<>h']r<>h%]r<>Usourcer<65>hh#]r<>h*]r<>uU footnotesr<73>]r<>Urefidsr<73>}r<>ub.