a ވaJ@sdZddlmZddlZddlZddlZddlmZddlZddl m Z ddl m Z m Z zddlmZWn2eyd ejvrddlmZnd d ZYn0Gd d d eZdS)zA utility class to send to and recv from a non-blocking socket, using tornado. .. seealso:: - :mod:`zmq.asyncio` - :mod:`zmq.eventloop.future` )with_statementN)Queue)jsonapi)IOLoopgen_log)wrapzzmq.eventloop.minitornadocCs|SN)callbackr r 6lib/python3.9/site-packages/zmq/eventloop/zmqstream.pystack_context_wrap.sr c@sXeZdZdZdZdZdZdZdZdZ dZ dZ dZ dZ dZdFddZddZd d Zd d Zd dZdGddZdHddZddZddZdIddZdJddZdKddZeZdLdd ZdMd"d#Zd$d%Zej ej!Bdfd&d'Z"d(d)Z#dNd*d+Z$d,d-Z%d.d/Z&d0d1Z'd2d3Z(d4d5Z)d6d7Z*d8d9Z+d:d;Z,dd?Z.d@dAZ/dBdCZ0dDdEZ1dS)O ZMQStreamaA utility class to register callbacks when a zmq socket sends and receives For use with zmq.eventloop.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(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 NrFcCs||_|pt|_t|_|jj|_t |_ d|_ d|_ d|_ d|_d|_d|_||jj|_|jj|_|jj|_|jj|_|jj|_|jj|_|jj|_|jj|_|jj|_dS)NFr)socketrZcurrentio_loopzmqZPollerpollerZFD_fdr _send_queue_recv_callback_send_callback_close_callback _recv_copy_flushed_state_init_io_stateZbindZbind_to_random_portZconnectZ setsockoptZ getsockoptZsetsockopt_stringZgetsockopt_stringZsetsockopt_unicodeZgetsockopt_unicode)selfrrr r r __init__cs*          zZMQStream.__init__cCs |dS)z)Disable callback and automatic receiving.N)on_recvrr r r stop_on_recv~szZMQStream.stop_on_recvcCs |dS)zDisable callback on sending.N)on_sendrr r r stop_on_sendszZMQStream.stop_on_sendcCstddSzDEPRECATED, does nothingz(on_err does nothing, and will be removedNrwarnrr r r stop_on_errszZMQStream.stop_on_errcCstddSr#r$rr r r r on_errszZMQStream.on_errTcCsR||dust|sJt||_||_|durB|tjn |tjdS)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_closedcallabler rr_drop_io_staterPOLLIN _add_io_staterr copyr r r rs zZMQStream.on_recvcs.durnjfdd|ddS)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. Ncs |Sr r )msgr rr r z*ZMQStream.on_recv_stream..r/)r rr.r r1r on_recv_streams  zZMQStream.on_recv_streamcCs*||dust|sJt||_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)r)r*r rr'r r r r!s$zZMQStream.on_sendcs*durnfdddS)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. Ncs ||Sr r )r0statusr1r r r2r3z*ZMQStream.on_send_stream..)r"r!r'r r1r on_send_streams  zZMQStream.on_send_streamcKs|j|gf||||d|S)ztSend a message, optionally also register a new callback for sends. See zmq.socket.send for details. )flagsr/trackr )send_multipartrr0r8r/r9r kwargsr r r sendszZMQStream.sendcKs`|t|||d|j||f|p,|j}|durB||n|dd|tjdS)zSend a multipart message, optionally also register a new callback for sends. See zmq.socket.send_multipart for details. )r8r/r9NcWsdSr r )argsr r r r2 r3z*ZMQStream.send_multipart..) updatedictrZputrr!r-rPOLLOUTr;r r r r:s  zZMQStream.send_multipartutf-8cKs0t|tstd|j||f||d|S)zbSend a unicode message with an encoding. See zmq.socket.send_unicode for details. zunicode/str objects onlyr8r ) isinstancestr TypeErrorr=encode)rur8encodingr r<r r r send_string s zZMQStream.send_stringcKs"t|}|j|f||d|S)zaSend json-serialized version of an object. See zmq.socket.send_json for details. rC)rdumpsr=)robjr8r r<r0r r r send_jsons zZMQStream.send_jsoncKs$t||}|j||fd|i|S)ztSend a Python object as a message using pickle to serialize. See zmq.socket.send_json for details. r )picklerKr=)rrLr8Zprotocolr r<r0r r r send_pyobjs zZMQStream.send_pyobjcCs d|_dS)z%callback for unsetting _flushed flag.FN)rrr r r _finish_flush&szZMQStream._finish_flushc s(j}d_d}fdd}|s4dSjjjd}|r|r`||kr|d\}}|tj@r|d7}jdurq|tj @r r |d7}jdurq|rjjjd}qPg}qP|rd_|sj jn |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) Frcstj@otj@BS)zgUpdate the poll flag, to prevent registering POLLOUT events if we don't have pending sends.)rr,sendingrAr flagrr r update_flagQsz$ZMQStream.flush..update_flagrNT)r)rrregisterrZpollrr, _handle_recvrArR _handle_sendr add_callbackrQ_rebuild_io_state) rrTlimitZalready_flushedcountrUeventssZeventr rSr flush*sF     zZMQStream.flushcCst||_dS)z2Call the given callback when the stream is closed.N)r rr'r r r set_close_callback~szZMQStream.set_close_callbackcCsl|jdurh|jjr6tjd|jdd|j|jn|j|j|j|d|_|jrh| |jdS)zClose this stream.NzUnregistering FD %s after closing socket. This could result in unregistering handlers for the wrong socket. Please use stream.close() instead of closing the socket directly.) stacklevel) rclosedwarningsr%rrZremove_handlercloser _run_callback)rZlingerr r r res  zZMQStream.closecCs |jduS)z;Returns True if we are currently receiving from the stream.N)rrr r r receivingszZMQStream.receivingcCs |j S)z7Returns True if we are currently sending to the stream.)remptyrr r r rRszZMQStream.sendingcCs&|jdurdS|jjr"|dSdS)NT)rrcrerr r r rcs  zZMQStream.closedcOs:z||i|Wn"ty4tjdddYn0dS)zMWrap running callbacks in try/except to allow us to close our socket.z(Uncaught exception in ZMQStream callbackTexc_infoN) Exceptionrerror)rr r>r<r r r rfs  zZMQStream._run_callbackcCs|jstd|dSz |jj}Wn"tjyDtd|YdS0zX|tj@rn|rn||jsnWdS|tj @r| r| |jsWdS| Wn"t ytjdddYn0dS)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 contextz(Uncaught exception in zmqstream callbackTri)rrZwarningZEVENTSrZContextTerminatedr,rgrWrArRrXrZrkrl)rfdr]Z zmq_eventsr r r _handle_eventss*     zZMQStream._handle_eventsc Csv|jr dSz|jjtj|jd}Wn6tjyX}z|jtjkrBnWYd}~n"d}~00|j rr|j }| ||dS)zHandle a recv event.Nr4) rrZrecv_multipartrZNOBLOCKrZMQErrorerrnoZEAGAINrrf)rr0er r r r rWs zZMQStream._handle_recvc Cs|jr dS|s tddS|j\}}z|jj|fi|}Wn6tj y|}ztd||}WYd}~n d}~00|j r|j }| |||dS)zHandle a send event.Nz#Shouldn't have handled a send eventzSEND Error: %s) rrRrrlrgetrr:rrorrf)rr0r<r6rqr r r r rXs  zZMQStream._handle_sendcCs|jstddS)NzStream is closed)rIOErrorrr r r r)szZMQStream._check_closedcCsJ|jdurdSd}|r$|tjO}|r6|tjO}||_||dS)z8rebuild io state based on self.sending() and receiving()Nr)rrgrr,rRrAr_update_handlerrstater r r rZs   zZMQStream._rebuild_io_statecCs|j|B|_||jdS)zAdd io_state to poller.Nrrtrur r r r-s zZMQStream._add_io_statecCs|j|@|_||jdS)z&Stop poller from watching an io_state.Nrwrur r r r+ szZMQStream._drop_io_statecs2jdurdS|jj@r.jfdddS)z!Update IOLoop handler with state.NcsjdS)Nr)rnrr rr r r2r3z+ZMQStream._update_handler..)rr]rrYrur rr rts  zZMQStream._update_handlercCs|j|j|j|jjdS)z#initialize the ioloop event handlerN)rZ add_handlerrrnZREADrr r r rszZMQStream._init_io_state)N)T)T)rTFN)rTFN)rrBN)rN)rrNN)N)2__name__ __module__ __qualname____doc__rrrrrrrrrrrrr r"r&r(rr5r!r7r=r:rJZ send_unicoderMrPrQrr,rAr_r`rergrRrcrfrnrWrXr)rZr-r+rtrr r r r r2sZ$  # (    T     r)r{Z __future__rrOsysrdZqueuerrZ zmq.utilsrZiolooprrZtornado.stack_contextrr ImportErrormodulesZminitornado.stack_contextobjectrr r r r s