5 ### (c) 2005 Straylight/Edgeware
8 ###----- Licensing notice ---------------------------------------------------
10 ### This file is part of the Python interface to mLib.
12 ### mLib/Python is free software; you can redistribute it and/or modify
13 ### it under the terms of the GNU General Public License as published by
14 ### the Free Software Foundation; either version 2 of the License, or
15 ### (at your option) any later version.
17 ### mLib/Python is distributed in the hope that it will be useful,
18 ### but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ### GNU General Public License for more details.
22 ### You should have received a copy of the GNU General Public License
23 ### along with mLib/Python; if not, write to the Free Software Foundation,
24 ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 cdef class PacketBuffer:
28 PacketBuffer([packetproc = None], [eofproc = None])
30 Split an incoming stream into packets.
35 def __cinit__(me, packetproc = None, eofproc = None, *hunoz, **hukairz):
36 pkbuf_init(&me.pk, _pkfunc, <void *>me)
37 me._packet = _checkcallable(packetproc, 'packet proc')
38 me._eof = _checkcallable(eofproc, 'eof proc')
42 """PK.activep -> BOOL: is the buffer still active?"""
44 return _tobool(me.pk.f & PKBUF_ENABLE)
46 """PK.want -> INT: size of next packet to return"""
49 def __set__(me, want):
51 raise TypeError, 'want must be positive'
52 pkbuf_want(&me.pk, pk)
54 """PK.packetproc -> FUNC: call FUNC(PACKET) on each packet"""
57 def __set__(me, proc):
58 me._line = _checkcallable(proc, 'packet proc')
62 """PK.eofproc -> FUNC: call FUNC() at end-of-file"""
65 def __set__(me, proc):
66 me._eof = _checkcallable(proc, 'eof proc')
70 """PK.enable(): enable the buffer, allowing packets to be emitted"""
71 if me.pk.f & PKBUF_ENABLE:
72 raise ValueError, 'already enabled'
73 me.pk.f = me.pk.f | PKBUF_ENABLE
77 """PK.disable(): disable the buffer, suspending packet emission"""
78 if not (me.pk.f & PKBUF_ENABLE):
79 raise ValueError, 'already disabled'
80 me.pk.f = me.pk.f & ~PKBUF_ENABLE
84 """PK.close(): report the end of the input stream"""
85 if not (me.pk.f & PKBUF_ENABLE):
86 raise ValueError, 'buffer disabled'
90 """PK.free -> INT: amount of space remaining in buffer"""
93 return pkbuf_free(&me.pk, &p)
95 """PK.flush(STR) -> insert STR into the buffer and emit packets"""
100 PyObject_AsReadBuffer(str, <cvp *>&p, &len)
102 n = pkbuf_free(&me.pk, &q)
108 if not (me.pk.f & PKBUF_ENABLE):
110 pkbuf_flush(&me.pk, q, n)
111 return PyString_FromStringAndSize(<char *>p, len)
113 """PK.enabled(): called when buffer is enabled"""
116 """PK.disabled(): called when buffer is disabled"""
119 """PK.packet(PACKET): called for each completed packet"""
120 return _maybecall(me._packet, (pk,))
122 """PK.eof(): called at end-of-file"""
123 return _maybecall(me._eof, ())
125 cdef void _pkfunc(unsigned char *p, size_t n, pkbuf *pk,
126 size_t *keep, void *arg):
130 pb = <PacketBuffer>arg
134 r = pb.packet(PyString_FromStringAndSize(<char *>p, n))
136 PyObject_AsReadBuffer(r, <cvp *>&rp, &rn)
138 raise ValueError, 'remaining buffer too large'
140 memcpy(p + n - rn, rp, rn)
143 ###----- That's all, folks --------------------------------------------------