X-Git-Url: https://git.distorted.org.uk/~mdw/mLib-python/blobdiff_plain/704500e11c6a7e240acc047607d34bc6db520f15..HEAD:/pkbuf.pyx

diff --git a/pkbuf.pyx b/pkbuf.pyx
index 2544aaa..fe296f3 100644
--- a/pkbuf.pyx
+++ b/pkbuf.pyx
@@ -24,6 +24,11 @@
 ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
 cdef class PacketBuffer:
+  """
+  PacketBuffer([packetproc = None], [eofproc = None])
+
+  Split an incoming stream into packets.
+  """
   cdef pkbuf pk
   cdef _packet
   cdef _eof
@@ -34,9 +39,11 @@ cdef class PacketBuffer:
   def __dealloc__(me):
     pkbuf_destroy(&me.pk)
   property activep:
+    """PK.activep -> BOOL: is the buffer still active?"""
     def __get__(me):
       return _tobool(me.pk.f & PKBUF_ENABLE)
   property want:
+    """PK.want -> INT: size of next packet to return"""
     def __get__(me):
       return me.pk.want
     def __set__(me, want):
@@ -44,6 +51,7 @@ cdef class PacketBuffer:
         raise TypeError, 'want must be positive'
       pkbuf_want(&me.pk, pk)
   property packetproc:
+    """PK.packetproc -> FUNC: call FUNC(PACKET) on each packet"""
     def __get__(me):
       return me._packet
     def __set__(me, proc):
@@ -51,6 +59,7 @@ cdef class PacketBuffer:
     def __del__(me):
       me._line = None
   property eofproc:
+    """PK.eofproc -> FUNC: call FUNC() at end-of-file"""
     def __get__(me):
       return me._eof
     def __set__(me, proc):
@@ -58,27 +67,32 @@ cdef class PacketBuffer:
     def __del__(me):
       me._eof = None
   def enable(me):
+    """PK.enable(): enable the buffer, allowing packets to be emitted"""
     if me.pk.f & PKBUF_ENABLE:
       raise ValueError, 'already enabled'
     me.pk.f = me.pk.f | PKBUF_ENABLE
     me.enabled()
     return me
   def disable(me):
+    """PK.disable(): disable the buffer, suspending packet emission"""
     if not (me.pk.f & PKBUF_ENABLE):
       raise ValueError, 'already disabled'
     me.pk.f = me.pk.f & ~PKBUF_ENABLE
     me.disabled()
     return me
   def close(me):
+    """PK.close(): report the end of the input stream"""
     if not (me.pk.f & PKBUF_ENABLE):
       raise ValueError, 'buffer disabled'
     pkbuf_close(&me.pk)
     return me
   property free:
+    """PK.free -> INT: amount of space remaining in buffer"""
     def __get__(me):
       cdef unsigned char *p
       return pkbuf_free(&me.pk, &p)
   def flush(me, str):
+    """PK.flush(STR) -> insert STR into the buffer and emit packets"""
     cdef Py_ssize_t len
     cdef unsigned char *p
     cdef unsigned char *q
@@ -96,12 +110,16 @@ cdef class PacketBuffer:
       pkbuf_flush(&me.pk, q, n)
     return PyString_FromStringAndSize(<char *>p, len)
   def enabled(me):
+    """PK.enabled(): called when buffer is enabled"""
     pass
   def disabled(me):
+    """PK.disabled(): called when buffer is disabled"""
     pass
   def packet(me, pk):
+    """PK.packet(PACKET): called for each completed packet"""
     return _maybecall(me._packet, (pk,))
   def eof(me):
+    """PK.eof(): called at end-of-file"""
     return _maybecall(me._eof, ())
 
 cdef void _pkfunc(unsigned char *p, size_t n, pkbuf *pk,