MhZdZddlmZddlZddlZddlZddlmZddlm Z m Z m Z m Z m Z mZmZddlmZddlmZddlZddlZddlmZmZdd lmZGd d ZdS) zA utility class for event-based messaging on a zmq socket using tornado. .. seealso:: - :mod:`zmq.asyncio` - :mod:`zmq.eventloop.future` ) annotationsN)Queue)Any AwaitableCallableLiteralSequencecastoverload)IOLoop)gen_log)POLLINPOLLOUT)jsonapiceZdZUdZded<ded<ded<ded <d ed <d ed <d ed <dZded<dZded<dZded<ded<dadbdZdZ dZ dZ dcdZ e ddd"Ze ded%Ze dfd(Ze dgdhd+Z didjd-Ze dkd/Ze dld0Ze dmd2Ze dgdnd4Z didnd5Zdod7Zdpd9Zdqd:Z dqdrdAZ dsdtdFZeZ dudvdHZ dwdxdKZdLZejejzdfdydPZdzdQZdad{dSZd|dTZd|dUZ d|dVZ!dWZ"dXZ#dYZ$dZZ%d[Z&d\Z'd]Z(d^Z)d_Z*d`Z+dS)} ZMQStreamaA utility class to register callbacks when a zmq socket sends and receives For use with tornado IOLoop. There are three main methods Methods: * **on_recv(callback, copy=True):** register a callback to be run every time the socket has something to receive * **on_send(callback):** register a callback to be run every time you call send * **send_multipart(self, msg, flags=0, copy=False, callback=None):** perform a send that will trigger the callback if callback is passed, on_send is also called. There are also send_multipart(), send_json(), send_pyobj() Three other methods for deactivating the callbacks: * **stop_on_recv():** turn off the recv callback * **stop_on_send():** turn off the send callback which simply call ``on_(None)``. The entire socket interface, excluding direct recv methods, is also provided, primarily through direct-linking the methods. e.g. >>> stream.bind is stream.socket.bind True .. versionadded:: 25 send/recv callbacks can be coroutines. .. versionchanged:: 25 ZMQStreams only support base zmq.Socket classes (this has always been true, but not enforced). If ZMQStreams are created with e.g. async Socket subclasses, a RuntimeWarning will be shown, and the socket cast back to the default zmq.Socket before connecting events. Previously, using async sockets (or any zmq.Socket subclass) would result in undefined behavior for the arguments passed to callback functions. Now, the callback functions reliably get the return value of the base `zmq.Socket` send/recv_multipart methods (the list of message frames). zmq.Socketsocketr io_loopz zmq.Pollerpollerr _send_queueCallable | None_recv_callback_send_callback_close_callbackrint_stateFbool_flushed _recv_copy_fdN IOLoop | NonecFt|tjjr:t jd|jdtdtj|}||_ |ptj |_ tj |_tt |j j|_t'|_d|_d|_d|_d|_d|_d|_||j j|_|j j|_|j j|_|j j|_|j j |_ |j j!|_!|j j"|_"|j j#|_#|j j$|_$dS)NzZMQStream only supports the base zmq.Socket class. Use zmq.Socket(shadow=other_socket) or `ctx.socket(zmq.z, socket_class=zmq.Socket)` to create a base zmq.Socket object, no matter what other kind of socket your Context creates.  stacklevel)shadowFr)% isinstancezmq_future _AsyncSocketwarningswarn _type_nameRuntimeWarningSocketrr currentrPollerrr rFDr!rrrrrr rr_init_io_statebindbind_to_random_portconnect setsockopt getsockoptsetsockopt_stringgetsockopt_stringsetsockopt_unicodegetsockopt_unicode)selfrrs W/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/zmq/eventloop/zmqstream.py__init__zZMQStream.__init__asm fck6 7 7 / M%+$5    Zv...F 2&."2"2 jll T[^,, 77""#   K$ #';#B {* +0+0!%!>!%!>"&+"@"&+"@c,|dS)z)Disable callback and automatic receiving.N)on_recvr>s r? stop_on_recvzZMQStream.stop_on_recv||D!!!rAc,|dS)zDisable callback on sending.N)on_sendrDs r? stop_on_sendzZMQStream.stop_on_sendrFrAc.tjddSzDEPRECATED, does nothingz(on_err does nothing, and will be removedNr r-rDs r? stop_on_errzZMQStream.stop_on_err ?@@@@@rAcallbackrc.tjddSrKrLr>rOs r?on_errzZMQStream.on_errrNrACallable[[list[bytes]], Any]returnNonecdSNrQs r?rCzZMQStream.on_recv srAcopy Literal[True]cdSrWrXr>rOrZs r?rCzZMQStream.on_recv srA Callable[[list[zmq.Frame]], Any]Literal[False]cdSrWrXr]s r?rCzZMQStream.on_recvr^rA.?Callable[[list[zmq.Frame]], Any] | Callable[[list[bytes]], Any]cdSrWrXr]s r?rCzZMQStream.on_recvs  srATc||t|sJ||_||_|!|t jdS|t jdS)aRegister a callback for when a message is ready to recv. There can be only one callback registered at a time, so each call to `on_recv` replaces previously registered callbacks. on_recv(None) disables recv event polling. Use on_recv_stream(callback) instead, to register a callback that will receive both this ZMQStream and the message, instead of just the message. Parameters ---------- callback : callable callback must take exactly one argument, which will be a list, as returned by socket.recv_multipart() if callback is None, recv callbacks are disabled. copy : bool copy is passed directly to recv, so if copy is False, callback will receive Message objects. If copy is True, then callback will receive bytes/str objects. Returns : None N) _check_closedcallablerr _drop_io_stater)r _add_io_stater]s r?rCzZMQStream.on_recvs|< 8H#5#5&      + + + + +   sz * * * * *rA'Callable[[ZMQStream, list[bytes]], Any]cdSrWrXrQs r?on_recv_streamzZMQStream.on_recv_streamrYrAcdSrWrXr]s r?rkzZMQStream.on_recv_streamr^rA+Callable[[ZMQStream, list[zmq.Frame]], Any]cdSrWrXr]s r?rkzZMQStream.on_recv_streamr^rAUCallable[[ZMQStream, list[zmq.Frame]], Any] | Callable[[ZMQStream, list[bytes]], Any]cdSrWrXr]s r?rkzZMQStream.on_recv_streams  srActdSfd}||dS)a Same as on_recv, but callback will get this stream as first argument callback must take exactly two arguments, as it will be called as:: callback(stream, msg) Useful when a single callback should be used with multiple streams. Nc|SrWrX)msgrOr>s r?stream_callbackz1ZMQStream.on_recv_stream..stream_callbacksxc***rArZ)rErC)r>rOrZrts`` r?rkzZMQStream.on_recv_streams`           + + + + + + LLtL 4 4 4 4 4rA9Callable[[Sequence[Any], zmq.MessageTracker | None], Any]cb||t|sJ||_dS)aRegister a callback to be called on each send There will be two arguments:: callback(msg, status) * `msg` will be the list of sendable objects that was just sent * `status` will be the return result of socket.send_multipart(msg) - MessageTracker or None. Non-copying sends return a MessageTracker object whose `done` attribute will be True when the send is complete. This allows users to track when an object is safe to write to again. The second argument will always be None if copy=True on the send. Use on_send_stream(callback) to register a callback that will be passed this ZMQStream as the first argument, in addition to the other two. on_send(None) disables recv event polling. Parameters ---------- callback : callable callback must take exactly two arguments, which will be the message being sent (always a list), and the return result of socket.send_multipart(msg) - MessageTracker or None. if callback is None, send callbacks are disabled. N)rerfrrQs r?rHzZMQStream.on_sends>L 8H#5#5&rADCallable[[ZMQStream, Sequence[Any], zmq.MessageTracker | None], Any]cldSfddS)zSame as on_send, but callback will get this stream as first argument Callback will be passed three arguments:: callback(stream, msg, status) Useful when a single callback should be used with multiple streams. Nc||SrWrX)rsstatusrOr>s r?z*ZMQStream.on_send_stream..PsXXdC-H-HrA)rIrHrQs``r?on_send_streamzZMQStream.on_send_streamAsI           LLHHHHH I I I I IrAc *|j|gf||||d|S)ztSend a message, optionally also register a new callback for sends. See zmq.socket.send for details. )flagsrZtrackrO)send_multipartr>rsrrZrrOkwargss r?sendzZMQStream.sendRs;#t" E T  MS   rArs Sequence[Any]rrrrc 4|t||||j||f|p|j}|||n|d|tjdS)zSend a multipart message, optionally also register a new callback for sends. See zmq.socket.send_multipart for details. )rrZrNcdSrWrX)argss r?r|z*ZMQStream.send_multipart..mstrA) updatedictrputrrHrhr)rrs r?rzZMQStream.send_multipartZs  dT???@@@ c6]+++2t2   LL " " " " LL++ , , , 3;'''''rAutf-8ustrencodingc t|tstd|j||f||d|S)zbSend a unicode message with an encoding. See zmq.socket.send_unicode for details. zunicode/str objects onlyrrO)r(r TypeErrorrencode)r>rrrrOrs r? send_stringzZMQStream.send_stringpsR!S!! 8677 7ty(++V58VVvVVVrAobjc Ltj|}|j|f||d|S)zaSend json-serialized version of an object. See zmq.socket.send_json for details. r)rdumpsr)r>rrrOrrss r? send_jsonzZMQStream.send_jsons4mC  tyGEHGGGGGrAprotocolc Ntj||}|j||fd|i|S)ztSend a Python object as a message using pickle to serialize. See zmq.socket.send_json for details. rO)picklerr)r>rrrrOrrss r? send_pyobjzZMQStream.send_pyobjs6l3))tyeAAhA&AAArAcd|_dS)z%callback for unsetting _flushed flag.FN)rrDs r? _finish_flushzZMQStream._finish_flushs  rAflaglimit int | Nonec"j}d_d}fd}|sdSjjjd}|r|r||kr|d\}}|t zr!|dz }jn|tzr5 r! |dz }jnS|r;jjjd}ng}|r|||k|r)d_|sj j n |rd_|S)aFlush pending messages. This method safely handles all pending incoming and/or outgoing messages, bypassing the inner loop, passing them to the registered callbacks. A limit can be specified, to prevent blocking under high load. flush will return the first time ANY of these conditions are met: * No more events matching the flag are pending. * the total number of events handled reaches the limit. Note that if ``flag|POLLIN != 0``, recv events will be flushed even if no callback is registered, unlike normal IOLoop operation. This allows flush to be used to remove *and ignore* incoming messages. Parameters ---------- flag : int default=POLLIN|POLLOUT 0MQ poll flags. If flag|POLLIN, recv events will be flushed. If flag|POLLOUT, send events will be flushed. Both flags can be set at once, which is the default. limit : None or int, optional The maximum number of messages to send or receive. Both send and recv count against this limit. Returns ------- int : count of events handled (both send and recv) FrcjtjzotjzzS)zgUpdate the poll flag, to prevent registering POLLOUT events if we don't have pending sends.)r)rsendingr)rr>sr? update_flagz$ZMQStream.flush..update_flags+#*$ (M4#+;MN NrANT)rerrregisterrpollr _handle_recvrr _handle_sendr add_callbackr_rebuild_io_state) r>rralready_flushedcountreventssevents `` r?flushzZMQStream.flushsB -  O O O O O O {}} 1 T[$///!!!$$ e uu}}ayHAuv~ !!### ;&w 4<<>> !!### ;&;==D  $$T[$777))!,,) e uu}}*  ! DM" > ))$*<===  ! DM     rAc||_dS)z2Call the given callback when the stream is closed.N)rrQs r?set_close_callbackzZMQStream.set_close_callbacks'rAlingerct|j|jjr?tjd|jdd|j|jn9|j|j|j|d|_|jr| |jdSdSdS)zClose this stream.NzUnregistering FD z after closing socket. This could result in unregistering handlers for the wrong socket. Please use stream.close() instead of closing the socket directly.r$r%) rclosedr,r-r!rremove_handlercloser _run_callback)r>rs r?rzZMQStream.closes ; "{! * XXXX !   ++DH5555 ++DK888 !!&)))DK# 9""4#788888# # "  9 9rAc|jduS)z;Returns True if we are currently receiving from the stream.N)rrDs r? receivingzZMQStream.receivings"$..rAc6|j S)z7Returns True if we are currently sending to the stream.)remptyrDs r?rzZMQStream.sendings#))++++rAc\|jdS|jjr|dSdS)NTF)rrrrDs r?rzZMQStream.closeds5 ; 4 ;   JJLLL4urAc ||i|}t|trtj|}nd}n%#t$rt jddwxYw|d}||dSdS)zMWrap running callbacks in try/except to allow us to close our socket.N(Uncaught exception in ZMQStream callbackTexc_infoc~ |dS#t$rtjddYdSwxYw)NrTr)result Exceptionr error)fs r? _log_errorz+ZMQStream._run_callback.._log_error3s`HHJJJJJ MBTs  <<)r(rasyncio ensure_futurerr radd_done_callback)r>rOrrrrs r?rzZMQStream._run_callback"s $)&))A!Y'' )!,,    MDt T T T T    =       + + + + + =s 47"Ac|jstjd|dS |jj}n#tj$r-tjd||YdStj$rL}|rtjd||ntjd||Yd}~dSd}~wwxYw |tj zr1| r| |jsdS|tj zr1| r||jsdS|dS#t $rtjddwxYw) zThis method is the actual handler for IOLoop, that gets called whenever an event on my socket is posted. It dispatches to _handle_recv, etc.zGot events for closed stream %sNz2Got events for stream %s after terminating contextz6Got events for stream %s attached to closed socket: %szError getting events for %s: %sz(Uncaught exception in zmqstream callbackTr)rr warningEVENTSr)ContextTerminatedrZMQErrorrrrrrrrrr)r>fdr zmq_eventses r?_handle_eventszZMQStream._handle_events=s{  O=t D D D F +JJ$    OPRV W W W KKMMM FF|   {{}} JLdTU ?qIII FFFFF  CJ& 4>>+;+; !!###{FCK' DLLNN !!###{F  " " $ $ $ $ $    MDt T T T T  s4 -8C(C6AB==C>E>EE"E>c$|jrdS |jtj|j}|jr|j}|||dSdS#tj$r"}|j tj krnYd}~dSd}~wwxYw)zHandle a recv event.Nru) rrrecv_multipartr)NOBLOCKr rrrerrnoEAGAIN)r>rsrOrs r?rzZMQStream._handle_recvfs =  F 2+,,S[t,OOC" 2.""8S11111 2 2|   w#*$$ s+AB-B  Bc|jrdS|stjddS|j\}} |jj|fi|}n3#tj $r!}tjd||}Yd}~nd}~wwxYw|j r |j }| |||dSdS)zHandle a send event.Nz#Shouldn't have handled a send eventzSEND Error: %s) rrr rrgetrrr)rrr)r>rsrr{rrOs r?rzZMQStream._handle_sendws =  F||~~  M? @ @ @ F&**,, V /T[/>>v>>FF|    M*A . . .FFFFFF    6*H   xf 5 5 5 5 5 6 6sA%%B4BBc2|jstddS)NzStream is closed)rOSErrorrDs r?rezZMQStream._check_closeds%{ .,-- - . .rAc|jdSd}|r|tjz}|r|tjz}||_||dS)z8rebuild io state based on self.sending() and receiving()Nr)rrr)rrrr_update_handlerr>states r?rzZMQStream._rebuild_io_stateso ;  F >>   SZ E <<>> ! S[ E  U#####rAcX|j|z|_||jdS)zAdd io_state to poller.Nrrrs r?rhzZMQStream._add_io_states,kE)  T[)))))rAcZ|j|z|_||jdS)z&Stop poller from watching an io_state.Nrrs r?rgzZMQStream._drop_io_states.keV,  T[)))))rAcvjdS|jjzrjfddSdS)z!Update IOLoop handler with state.Nc:jdS)Nr)rrrDsr?r|z+ZMQStream._update_handler..sd.A.A$+q.Q.QrA)rrrrrs` r?rzZMQStream._update_handlersW ;  F 4;% % S L % %&Q&Q&Q&Q R R R R R S SrAcf|j|j|j|jjdS)z#initialize the ioloop event handlerN)r add_handlerrrREADrDs r?r4zZMQStream._init_io_states,   d.A4rs/ #""""" NNNNNNNNNNNNNNNNNN!!!!!! Q VQ VQ VQ VQ VQ VQ VQ VQ VQ VrA