plomlompom.com Git - plomrogue2-experiments/blob - plom_socket_io.py

   1 def send(socket, message):
   2     """Send message via socket, encoded and delimited the way recv() expects.
   3
   4     In detail, all \ and $ in message are escaped with prefixed \, and an
   5     unescaped $ is appended as a message delimiter. Then, socket.send() is
   6     called as often as necessary to ensure message is sent fully, as
   7     socket.send() due to buffering may not send all of it right away.
   8
   9     Assuming socket is blocking, it's rather improbable that socket.send() will
  10     be partial / return a positive value less than the (byte) length of msg –
  11     but not entirely out of the question. See:
  12     - <http://stackoverflow.com/q/19697218>
  13     - <http://stackoverflow.com/q/2618736>
  14     - <http://stackoverflow.com/q/8900474>
  15
  16     This also handles a socket.send() return value of 0, which might be
  17     possible or not (?) for blocking sockets:
  18     - <http://stackoverflow.com/q/34919846>
  19     """
  20     escaped_message = ''
  21     for char in message:
  22         if char in ('\\', '$'):
  23             escaped_message += '\\'
  24         escaped_message += char
  25     escaped_message += '$'
  26     data = escaped_message.encode()
  27     totalsent = 0
  28     while totalsent < len(data):
  29         sent = socket.send(data[totalsent:])
  30         if sent == 0:
  31             raise RuntimeError('socket connection broken')
  32         totalsent = totalsent + sent
  33
  34
  35 def recv(socket):
  36     """Get full send()-prepared message from socket.
  37
  38     In detail, socket.recv() is looped over for sequences of bytes that can be
  39     decoded as a Unicode string delimited by an unescaped $, with \ and $
  40     escapable by \. If a sequence of characters that ends in an unescaped $
  41     cannot be decoded as Unicode, None is returned as its representation. Stop
  42     once socket.recv() returns nothing.
  43
  44     Under the hood, the TCP stack receives packets that construct the input
  45     payload in an internal buffer; socket.recv(BUFSIZE) pops up to BUFSIZE
  46     bytes from that buffer, without knowledge either about the input's
  47     segmentation into packets, or whether the input is segmented in any other
  48     meaningful way; that's why we do our own message segmentation with $ as a
  49     delimiter.
  50     """
  51     quit = False
  52     esc = False
  53     data = b''
  54     msg = b''
  55     while True:
  56         data += socket.recv(1024)
  57         if 0 == len(data):
  58             return
  59         cut_off = 0
  60         for c in data:
  61             cut_off += 1
  62             if esc:
  63                 msg += bytes([c])
  64                 esc = False
  65             elif chr(c) == '\\':
  66                 esc = True
  67             elif chr(c) == '$':
  68                 try:
  69                     yield msg.decode()
  70                 except UnicodeDecodeError:
  71                     yield None
  72                 data = data[cut_off:]
  73                 msg = b''
  74             else:
  75                 msg += bytes([c])