Gecko [ goons4good.org ]

Name	Size	Permission	Date
__pycache__	[ DIR ]	drwxr-xr-x	2022-03-29 05:07
__init__.py	0 B	-rw-r--r--	2018-02-10 08:02
buffers.pxd	9.63 KB	-rw-r--r--	2018-02-10 08:02
compiler.json	266 B	-rw-r--r--	2022-03-16 07:01
config.json	255 B	-rw-r--r--	2022-03-16 07:01
constant_names.py	7.73 KB	-rw-r--r--	2018-02-10 08:02
garbage.py	5.8 KB	-rw-r--r--	2018-02-10 08:02
getpid_compat.h	103 B	-rw-r--r--	2018-02-10 08:02
interop.py	709 B	-rw-r--r--	2018-02-10 08:02
ipcmaxlen.h	454 B	-rw-r--r--	2018-02-10 08:02
jsonapi.py	1.36 KB	-rw-r--r--	2018-02-10 08:02
monitor.py	2.04 KB	-rw-r--r--	2018-02-10 08:02
mutex.h	1.58 KB	-rw-r--r--	2018-02-10 08:02
pyversion_compat.h	1.29 KB	-rw-r--r--	2018-02-10 08:02
sixcerpt.py	1.84 KB	-rw-r--r--	2018-02-10 08:02
strtypes.py	1.17 KB	-rw-r--r--	2018-02-10 08:02
win32.py	5 KB	-rw-r--r--	2018-02-10 08:02
z85.py	1.95 KB	-rw-r--r--	2018-02-10 08:02
zmq_compat.h	2.88 KB	-rw-r--r--	2018-02-10 08:02
zmq_constants.h	13.66 KB	-rw-r--r--	2018-02-10 08:02

Rename

# -*- coding: utf-8 -*-
"""Module holding utility and convenience functions for zmq event monitoring."""

# Copyright (C) PyZMQ Developers
# Distributed under the terms of the Modified BSD License.

import struct
import zmq
from zmq.error import _check_version

def parse_monitor_message(msg):
    """decode zmq_monitor event messages.
    
    Parameters
    ----------
    msg : list(bytes)
        zmq multipart message that has arrived on a monitor PAIR socket.
        
        First frame is::
        
            16 bit event id
            32 bit event value
            no padding

Second frame is the endpoint as a bytestring

Returns
    -------
    event : dict
        event description as dict with the keys `event`, `value`, and `endpoint`.
    """
    
    if len(msg) != 2 or len(msg[0]) != 6:
        raise RuntimeError("Invalid event message format: %s" % msg)
    event = {'event': struct.unpack("=hi", msg[0])[0],
             'value': struct.unpack("=hi", msg[0])[1],
             'endpoint': msg[1]}
    return event

def recv_monitor_message(socket, flags=0):
    """Receive and decode the given raw message from the monitoring socket and return a dict.

Requires libzmq ≥ 4.0

The returned dict will have the following entries:
      event     : int, the event id as described in libzmq.zmq_socket_monitor
      value     : int, the event value associated with the event, see libzmq.zmq_socket_monitor
      endpoint  : string, the affected endpoint
    
    Parameters
    ----------
    socket : zmq PAIR socket
        The PAIR socket (created by other.get_monitor_socket()) on which to recv the message
    flags : bitfield (int)
        standard zmq recv flags

Returns
    -------
    event : dict
        event description as dict with the keys `event`, `value`, and `endpoint`.
    """
    _check_version((4,0), 'libzmq event API')
    # will always return a list
    msg = socket.recv_multipart(flags)
    # 4.0-style event API
    return parse_monitor_message(msg)

__all__ = ['parse_monitor_message', 'recv_monitor_message']