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

56 lines
16 KiB
Plaintext
Raw Normal View History

<EFBFBD>(cdocutils.nodes
document
qoq}q(U nametypesq}q(X<pyogp.lib.base.message.message_handler.MessageHandler.handleqKX>pyogp.lib.base.message.message_handler.MessageHandler.registerqKXFpyogp.lib.base.message.message_handler.MessageHandledNotifier.receivedqKX5pyogp.lib.base.message.message_handler.MessageHandlerq KXGpyogp.lib.base.message.message_handler.MessageHandledNotifier.subscribeq
KXmessage_handlerq NXHpyogp.lib.base.message.message_handler.MessageHandler.is_message_handledq KXIpyogp.lib.base.message.message_handler.MessageHandledNotifier.unsubscribeq KX=pyogp.lib.base.message.message_handler.MessageHandledNotifierqKuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU
decorationqNUautofootnote_startqKUnameidsq}q(hhhhhhh h h
h
h Umessage-handlerqh h h h hhuUchildrenq]q(cdocutils.nodes
section
qoq}q(U rawsourceqUUparentqhUsourceq UY/Users/enus/svn/pyogp.buildout/src/pyogp.lib.base/docs/source/modules/message_handler.rstq!Utagnameq"Usectionq#U
attributesq$}q%(Udupnamesq&]q'Uclassesq(]q)Ubackrefsq*]q+Uidsq,]q-X-module-pyogp.lib.base.message.message_handlerq.aUnamesq/]q0h auUlineq1KUdocumentq2hh]q3((cdocutils.nodes
title
q4oq5}q6(hX:mod:`message_handler`q7hhh h!h"Utitleq8h$}q9(h&]q:h(]q;h*]q<h,]q=h/]q>uh1Kh2hh]q?(csphinx.addnodes
pending_xref
q@oqA}qB(hh7hh5h"U pending_xrefqCh$}qD(UreftypeqEXmodqFUmodnameqGNU
refcaptionqH<EFBFBD>U reftargetqIXmessage_handlerqJh,]qKh*]qLU classnameqMNh&]qNh(]qOh/]qPuh1Kh]qQ(cdocutils.nodes
literal
qRoqS}qT(hh7h$}qU(h&]qVh(]qWUxrefqXah*]qYh,]qZh/]q[uhhAh]q\(cdocutils.nodes
Text
q]oq^}q_(hUUdataq`hJhhSubah"Uliteralqaubaubaub(csphinx.addnodes
index
qboqc}qd(hUhhh U <autodoc>qeh"Uindexqfh$}qg(h,]qhh*]qih&]qjh(]qkh/]qlUentriesqm]qn(UsingleqoX/pyogp.lib.base.message.message_handler (module)X-module-pyogp.lib.base.message.message_handlerX&pyogp.lib.base.message.message_handlerqptqqauh1Kh2hh]qrub(csphinx.addnodes
module
qsoqt}qu(hUhhh heh"Umoduleqvh$}qw(Umodnameqxhph,]qyh*]qzh&]q{Usynopsisq|Uh(]q}h/]q~uh1Kh2hh]qub(hboq<6F>}q<>(hUhhh Nh"hfh$}q<>(h,]q<>h*]q<>h&]q<>h(]q<>h/]q<>Uentriesq<73>]q<>(hoXHMessageHandledNotifier (class in pyogp.lib.base.message.message_handler)hhtq<74>auh1Nh2hh]q<>ub(csphinx.addnodes
desc
q<EFBFBD>oq<EFBFBD>}q<>(hUhhh Nh"Udescq<63>h$}q<>(Unoindexq<78><71>h,]q<>h*]q<>h&]q<>h(]q<>h/]q<>Udesctypeq<65>Xclassq<73>uh1Nh2hh]q<>((csphinx.addnodes
desc_signature
q<EFBFBD>oq<EFBFBD>}q<>(hX.MessageHandledNotifier(message_name, settings)q<>hh<>h U <autodoc>q<>h"Udesc_signatureq<65>h$}q<>(h,]q<>hah*]q<>h&]q<>h(]q<>h/]q<>haUfirstq<74><71>uh1Nh2hh]q<>((csphinx.addnodes
desc_annotation
q<EFBFBD>oq<EFBFBD>}q<>(hXclass q<>hh<>h h<>h"Udesc_annotationq<6E>h$}q<>(h&]q<>h(]q<>h*]q<>h,]q<>h/]q<>uh1Nh2hh]q<>(h]oq<6F>}q<>(hUh`h<>hh<>ubaub(csphinx.addnodes
desc_addname
q<EFBFBD>oq<EFBFBD>}q<>(hX'pyogp.lib.base.message.message_handler.q<>hh<>h h<>h"U desc_addnameq<65>h$}q<>(h&]q<>h(]q<>h*]q<>h,]q<>h/]q<>uh1Nh2hh]q<>(h]oq<6F>}q<>(hUh`h<>hh<>ubaub(csphinx.addnodes
desc_name
q<EFBFBD>oq<EFBFBD>}q<>(hXMessageHandledNotifierq<72>hh<>h h<>h"U desc_nameq<65>h$}q<>(h&]q<>h(]q<>h*]q<>h,]q<>h/]q<>uh1Nh2hh]q<>(h]oq<6F>}q<>(hUh`h<>hh<>ubaub(csphinx.addnodes
desc_parameterlist
q<EFBFBD>oq<EFBFBD>}q<>(hUhh<>h h<>h"Udesc_parameterlistq<74>h$}q<>(h&]q<>h(]q<>h*]q<>h,]q<>h/]q<>uh1Nh2hh]q<>((csphinx.addnodes
desc_parameter
q<EFBFBD>oq<EFBFBD>}q<>(hX message_nameq<65>hh<>h h<>h"Udesc_parameterq<72>h$}q<>(h&]q<>h(]q<>h*]q<>h,]q<>h/]q<>uh1Nh2hh]q<>(h]oq<6F>}q<>(hUh`h<>hh<>ubaub(h<>oq<6F>}q<>(hXsettingsq<73>hh<>h h<>h"h<>h$}q<>(h&]q<>h(]q<>h*]q<>h,]q<>h/]q<>uh1Nh2hh]q<>(h]oq<6F>}q<>(hUh`h<>hh<>ubaubeubeub(csphinx.addnodes
desc_content
q<EFBFBD>oq<EFBFBD>}q<>(hUhh<>h h<>h"U desc_contentq<74>h$}q<>(h&]q<>h(]q<>h*]q<>h,]q<>h/]ruh1Nh2hh]r((cdocutils.nodes
paragraph
ror}r(hXEpseudo subclassing the Event class to treat the message like an eventrhh<>h X<>/Users/enus/svn/pyogp.buildout/src/pyogp.lib.base/pyogp/lib/base/message/message_handler.py:docstring of pyogp.lib.base.message.message_handler.MessageHandledNotifierrh"U paragraphrh$}r(h&]r h(]r
h*]r h,]r h/]r uh1Kh2hh]r(h]or}r(hjh`XEpseudo subclassing the Event class to treat the message like an eventrhjubaub(hbor}r(hUhh<>h Nh"hfh$}r(h,]rh*]rh&]rh(]rh/]rUentriesr]r(hoXQreceived() (pyogp.lib.base.message.message_handler.MessageHandledNotifier method)hhtrauh1Nh2hh]rub(h<>or}r(hUhh<>h Nh"h<>h$}r (h<><68>h,]r!h*]r"h&]r#h(]r$h/]r%h<>Xmethodr&uh1Nh2hh]r'((h<>or(}r)(hX(MessageHandledNotifier.received(message)r*hjh h<>h"h<>h$}r+(h,]r,hah*]r-h&]r.h(]r/h/]r0hah<61><68>uh1Nh2hh]r1((h<>or2}r3(hXreceivedr4hj(h h<>h"h<>h$}r5(h&]r6h(]r7h*]r8h,]r9h/]r:uh1Nh2hh]r;(h]or<}r=(hUh`j4hj2ubaub(h<>or>}r?(hUhj(h h<>h"h<>h$}r@(h&]rAh(]rBh*]rCh,]rDh/]rEuh1Nh2hh]rF(h<>orG}rH(hXmessagerIhj>h h<>h"h<>h$}rJ(h&]rKh(]rLh*]rMh,]rNh/]rOuh1Nh2hh]rP(h]orQ}rR(hUh`jIhjGubaubaubeub(h<>orS}rT(hUhjh h<>h"h<>h$}rU(h&]rVh(]rWh*]rXh,]rYh/]rZuh1Nh2hh]r[ubeub(hbor\}r](hUhh<>h Nh"hfh$}r^(h,]r_h*]r`h&]rah(]rbh/]rcUentriesrd]re(hoXRsubscribe() (pyogp.lib.base.message.message_handler.MessageHandledNotifier method)h
h
trfauh1Nh2hh]rgub(h<>orh}ri(hUhh<>h Nh"h<>h$}rj(h<><68>h,]rkh*]rlh&]rmh(]rnh/]roh<>Xmethodrpuh1Nh2hh]rq((h<>orr}rs(hX2MessageHandledNotifier.subscribe(*args, **kwdargs)rthjhh h<>h"h<>h$}ru(h,]rvh
ah*]rwh&]rxh(]ryh/]rzh
ah<EFBFBD><EFBFBD>uh1Nh2hh]r{((h<>or|}r}(hX subscriber~hjrh h<>h"h<>h$}r(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>(h]or<6F>}r<>(hUh`j~hj|ubaub(h<>or<6F>}r<>(hUhjrh h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>((h<>or<6F>}r<>(hX*argsr<73>hj<>h h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>(h]or<6F>}r<>(hUh`j<>hj<>ubaub(h<>or<6F>}r<>(hX **kwdargsr<73>hj<>h h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>(h]or<6F>}r<>(hUh`j<>hj<>ubaubeubeub(h<>or<6F>}r<>(hUhjhh h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>ubeub(hbor<6F>}r<>(hUhh<>h Nh"hfh$}r<>(h,]r<>h*]r<>h&]r<>h(]r<>h/]r<>Uentriesr<73>]r<>(hoXTunsubscribe() (pyogp.lib.base.message.message_handler.MessageHandledNotifier method)h h tr<74>auh1Nh2hh]r<>ub(h<>or<6F>}r<>(hUhh<>h Nh"h<>h$}r<>(h<><68>h,]r<>h*]r<>h&]r<>h(]r<>h/]r<>h<>Xmethodr<64>uh1Nh2hh]r<>((h<>or<6F>}r<>(hX4MessageHandledNotifier.unsubscribe(*args, **kwdargs)r<>hj<>h h<>h"h<>h$}r<>(h,]r<>h ah*]r<>h&]r<>h(]r<>h/]r<>h ah<61><68>uh1Nh2hh]r<>((h<>or<6F>}r<>(hX unsubscriber<65>hj<>h h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>(h]or<6F>}r<>(hUh`j<>hj<>ubaub(h<>or<6F>}r<>(hUhj<>h h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>((h<>or<6F>}r<>(hX*argsr<73>hj<>h h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>(h]or<6F>}r<>(hUh`j<>hj<>ubaub(h<>or<6F>}r<>(hX **kwdargsr<73>hj<>h h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>(h]or<6F>}r<>(hUh`j<>hj<>ubaubeubeub(h<>or<6F>}r(hUhj<>h h<>h"h<>h$}r(h&]rh(]rh*]rh,]rh/]ruh1Nh2hh]rubeubeubeub(hbor}r (hUhhh Nh"hfh$}r
(h,]r h*]r h&]r h(]rh/]rUentriesr]r(hoX@MessageHandler (class in pyogp.lib.base.message.message_handler)h h trauh1Nh2hh]rub(h<>or}r(hUhhh Nh"h<>h$}r(h<><68>h,]rh*]rh&]rh(]rh/]rh<>Xclassruh1Nh2hh]r((h<>or}r(hXMessageHandler(settings=None)r hjh h<>h"h<>h$}r!(h,]r"h ah*]r#h&]r$h(]r%h/]r&h ah<61><68>uh1Nh2hh]r'((h<>or(}r)(hXclass r*hjh h<>h"h<>h$}r+(h&]r,h(]r-h*]r.h,]r/h/]r0uh1Nh2hh]r1(h]or2}r3(hUh`j*hj(ubaub(h<>or4}r5(hX'pyogp.lib.base.message.message_handler.r6hjh h<>h"h<>h$}r7(h&]r8h(]r9h*]r:h,]r;h/]r<uh1Nh2hh]r=(h]or>}r?(hUh`j6hj4ubaub(h<>or@}rA(hXMessageHandlerrBhjh h<>h"h<>h$}rC(h&]rDh(]rEh*]rFh,]rGh/]rHuh1Nh2hh]rI(h]orJ}rK(hUh`jBhj@ubaub(h<>orL}rM(hUhjh h<>h"h<>h$}rN(h&]rOh(]rPh*]rQh,]rRh/]rSuh1Nh2hh]rT(h<>orU}rV(hX settings=NonerWhjLh h<>h"h<>h$}rX(h&]rYh(]rZh*]r[h,]r\h/]r]uh1Nh2hh]r^(h]or_}r`(hUh`jWhjUubaubaubeub(h<>ora}rb(hUhjh h<>h"h<>h$}rc(h&]rdh(]reh*]rfh,]rgh/]rhuh1Nh2hh]ri((jorj}rk(hX*general class handling individual messagesrlhjah X<>/Users/enus/svn/pyogp.buildout/src/pyogp.lib.base/pyogp/lib/base/message/message_handler.py:docstring of pyogp.lib.base.message.message_handler.MessageHandlerrmh"jh$}rn(h&]roh(]rph*]rqh,]rrh/]rsuh1Kh2hh]rt(h]oru}rv(hjlh`X*general class handling individual messagesrwhjjubaub(jorx}ry(hX i do nothingrzhjah jmh"jh$}r{(h&]r|h(]r}h*]r~h,]rh/]r<>uh1Kh2hh]r<>(h]or<6F>}r<>(hjzh`X i do nothingr<67>hjxubaub(hbor<6F>}r<>(hUhjah X<>/Users/enus/svn/pyogp.buildout/src/pyogp.lib.base/pyogp/lib/base/message/message_handler.py:docstring of pyogp.lib.base.message.message_handler.MessageHandler.handler<65>h"hfh$}r<>(h,]r<>h*]r<>h&]r<>h(]r<>h/]r<>Uentriesr<73>]r<>(hoXGhandle() (pyogp.lib.base.message.message_handler.MessageHandler method)hhtr<74>auh1Nh2hh]r<>ub(h<>or<6F>}r<>(hUhjah j<>h"h<>h$}r<>(h<><68>h,]r<>h*]r<>h&]r<>h(]r<>h/]r<>h<>Xmethodr<64>uh1Nh2hh]r<>((h<>or<6F>}r<>(hXMessageHandler.handle(message)r<>hj<>h h<>h"h<>h$}r<>(h,]r<>hah*]r<>h&]r<>h(]r<>h/]r<>hah<61><68>uh1Nh2hh]r<>((h<>or<6F>}r<>(hXhandler<65>hj<>h h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>(h]or<6F>}r<>(hUh`j<>hj<>ubaub(h<>or<6F>}r<>(hUhj<>h h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>(h<>or<6F>}r<>(hXmessager<65>hj<>h h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>(h]or<6F>}r<>(hUh`j<>hj<>ubaubaubeub(h<>or<6F>}r<>(hUhj<>h h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>(jor<6F>}r<>(hX_essentially a case statement to pass messages to event notifiers in the form of self attributesr<73>hj<>h j<>h"jh$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1K h2hh]r<>(h]or<6F>}r<>(hj<>h`X_essentially a case statement to pass messages to event notifiers in the form of self attributesr<73>hj<>ubaubaubeub(hbor<6F>}r<>(hUhjah X<>/Users/enus/svn/pyogp.buildout/src/pyogp.lib.base/pyogp/lib/base/message/message_handler.py:docstring of pyogp.lib.base.message.message_handler.MessageHandler.is_message_handledr<64>h"hfh$}r<>(h,]r<>h*]r<>h&]r<>h(]r<>h/]r<>Uentriesr<73>]r<>(hoXSis_message_handled() (pyogp.lib.base.message.message_handler.MessageHandler method)h h tr<74>auh1Nh2hh]r<>ub(h<>or<6F>}r<>(hUhjah j<>h"h<>h$}r<>(h<><68>h,]r<>h*]r<>h&]r<>h(]r<>h/]r<>h<>Xmethodr<64>uh1Nh2hh]r<>((h<>or<6F>}r<>(hX/MessageHandler.is_message_handled(message_name)r<>hj<>h h<>h"h<>h$}r<>(h,]r<>h ah*]r<>h&]r<>h(]r<>
}r (hUhj<>h h<>h"h<>h$}r (h&]r h(]rh*]rh,]rh/]ruh1Nh2hh]r(h<>or}r(hX message_namerhj
h h<>h"h<>h$}r(h&]rh(]rh*]rh,]rh/]ruh1Nh2hh]r(h]or}r(hUh`jhjubaubaubeub(h<>or}r (hUhj<>h h<>h"h<>h$}r!(h&]r"h(]r#h*]r$h,]r%h/]r&uh1Nh2hh]r'((jor(}r)(hXGif the message is being monitored, return True, otherwise, return Falser*hjh j<>h"jh$}r+(h&]r,h(]r-h*]r.h,]r/h/]r0uh1Kh2hh]r1(h]or2}r3(hj*h`XGif the message is being monitored, return True, otherwise, return Falser4hj(ubaub(jor5}r6(hXYthis can allow us to skip parsing inbound messages if no one is watching a particular oner7hjh j<>h"jh$}r8(h&]r9h(]r:h*]r;h,]r<h/]r=uh1Kh2hh]r>(h]or?}r@(hj7h`XYthis can allow us to skip parsing inbound messages if no one is watching a particular onerAhj5ubaubeubeub(hborB}rC(hUhjah Nh"hfh$}rD(h,]rEh*]rFh&]rGh(]rHh/]rIUentriesrJ]rK(hoXIregister() (pyogp.lib.base.message.message_handler.MessageHandler method)hhtrLauh1Nh2hh]rMub(h<>orN}rO(hUhjah Nh"h<>h$}rP(h<><68>h,]rQh*]rRh&]rSh(]rTh/]rUh<>XmethodrVuh1Nh2hh]rW((h<>orX}rY(hX%MessageHandler.register(message_name)rZhjNh h<>h"h<>h$}r[(h,]r\hah*]r]h&]r^h(]r_h/]r`hah<61><68>uh1Nh2hh]ra((h<>orb}rc(hXregisterrdhjXh h<>h"h<>h$}re(h&]rfh(]rgh*]rhh,]rih/]rjuh1Nh2hh]rk(h]orl}rm(hUh`jdhjbubaub(h<>orn}ro(hUhjXh h<>h"h<>h$}rp(h&]rqh(]rrh*]rsh,]rth/]ruuh1Nh2hh]rv(h<>orw}rx(hX message_nameryhjnh h<>h"h<>h$}rz(h&]r{h(]r|h*]r}h,]r~h/]ruh1Nh2hh]r<>(h]or<6F>}r<>(hUh`jyhjwubaubaubeub(h<>or<6F>}r<>(hUhjNh h<>h"h<>h$}r<>(h&]r<>h(]r<>h*]r<>h,]r<>h/]r<>uh1Nh2hh]r<>ubeubeubeubeubahUU transformerr<72>NU footnote_refsr<73>}r<>Urefnamesr<73>}r<>Usymbol_footnotesr<73>]r<>Uautofootnote_refsr<73>]r<>Usymbol_footnote_refsr<73>]r<>U citationsr<73>]r<>h2hU current_liner<65>NUtransform_messagesr<73>]r<>Ureporterr<72>NUid_startr<74>KU autofootnotesr<73>]r<>U citation_refsr<73>}r<>Uindirect_targetsr<73>]r<>Usettingsr<73>(cdocutils.frontend
Values
r<EFBFBD>or<6F>}r<>(Ufootnote_backlinksr<73>KUrecord_dependenciesr<73>NU rfc_base_urlr<6C>Uhttp://tools.ietf.org/html/r<>U tracebackr<6B>KUpep_referencesr<73>NUstrip_commentsr<73>NU toc_backlinksr<73>Uentryr<79>U language_coder<65>Uenr<6E>U datestampr<70>NU report_levelr<6C>KU _destinationr<6E>NU
halt_levelr<EFBFBD>KU strip_classesr<73>Nh8NUerror_encoding_error_handlerr<72>Ubackslashreplacer<65>Udebugr<67>NUembed_stylesheetr<74><00>Uoutput_encoding_error_handlerr<72>Ustrictr<74>U sectnum_xformr<6D>KUdump_transformsr<73>NU docinfo_xformr<6D>KUwarning_streamr<6D>NUpep_file_url_templater<65>Upep-%04dr<64>Uexit_status_levelr<6C>KUconfigr<67>NUstrict_visitorr<72>NUcloak_email_addressesr<73><00>Utrim_footnote_reference_spacer<65><00>Uenvr<76>NUdump_pseudo_xmlr<6C>NUexpose_internalsr<73>NUsectsubtitle_xformr<6D><00>U source_linkr<6B>NUrfc_referencesr<73>NUoutput_encodingr<67>Uutf-8r<38>U
source_urlr<EFBFBD>NUinput_encodingr<67>U utf-8-sigr<67>U_disable_configr<67>NU id_prefixr<78>UU tab_widthr<68>KUerror_encodingr<67>Uasciir<69>U_sourcer<65>h!U generatorr<72>NUdump_internalsr<73>NU pep_base_urlr<6C>Uhttp://www.python.org/dev/peps/r<>Uinput_encoding_error_handlerr<72>j<>Uauto_id_prefixr<78>Uidr<64>Udoctitle_xformr<6D><00>Ustrip_elements_with_classesr<73>NU _config_filesr<73>]r<>Ufile_insertion_enabledr<64>KU raw_enabledr<64>KU dump_settingsr<73>NubUsymbol_footnote_startr<74>KUidsr<73>}r<>(hj<>hjXhhh.(cdocutils.nodes
target
r<EFBFBD>or<6F>}r<>(hUhhh heh"Utargetr<74>h$}r<>(h&]r<>h,h-h*]r<>Uismodr<64><00>h(]r<>h/]r<>uh1Kh2hh]r<>ubhj(h jh
jrh j<>h j<>hh<>uUsubstitution_namesr<73>}r<>h"h2h$}r<>(h&]r<>h,]r<>h*]r<>Usourcer<65>h!h(]r<>h/]r<>uU footnotesr<73>]rUrefidsr}rub.