BotSense.BotSenseTypes.ByteBuf Class Reference

Public Member Functions
def	__init__ (self, size=bsCore.BSPROXY_MSG_BODY_MAX)
def	__del__ (self)
def	__getitem__ (self, i)
def	__getslice__ (self, i, j)
def	__iadd__ (self, y)
def	__imul__ (self, y)
def	__iter__ (self)
def	__len__ (self)
def	__str__ (self)
def	__setitem__ (self, i, y)
def	__setslice__ (self, i, j, y)
def	__sizeof__ (self)
def	avail (self)
def	copyFromSwigObj (self, n, i=0, j=0)
def	copyToSwigObj (self, n, i=0, j=0)
def	getSwigObj (self)
def	getBuffer (self)
def	sizeof (self)

Static Public Member Functions
def	Constructor (seq)
def	Clone (buf)
def	byte (val)
def	bytelist (seq)
def	bytec (val)
def	bytestring (seq)

Public Attributes
	buf
	python byte string

Detailed Description

BotSense Byte Buffer Class.

    The ByteBuf class provides a wrapper around the byte_t* SWIG object.
    The byte_t is typedef'ed in C as an unsigned char. Byte buffers are used
    in packing and unpacking messages and in communication between the
    client and server.

    Note: There does not seem to be any way to advance the pointer of the
          underlining byte_t* SWIG object, so a copy from/to a python byte
          list (buffer) is required.

Definition at line 355 of file BotSenseTypes.py.

Constructor & Destructor Documentation

def BotSense.BotSenseTypes.ByteBuf.__init__	(		self,
			size = bsCore.BSPROXY_MSG_BODY_MAX
	)

Initialize byte buffer instance.

Parameters:
  size  - Number of bytes of the underlining fixed sized SWIG
          object.

Definition at line 369 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.ByteBuf._size, and BotSense.BotSenseTypes.ByteBuf._swigObj.

  def __init__(self, size=bsCore.BSPROXY_MSG_BODY_MAX):
    """ Initialize byte buffer instance.

        Parameters:
          size  - Number of bytes of the underlining fixed sized SWIG
                  object.
    """
    # add header length
    size += bsCore.BSPROXY_MSG_HDR_LEN

    ## internal swig object
    self._swigObj = bsCore.new_byteArray(size)

    ## internal swig object fixed buffer size
    self._size = size

    ## python byte string 
    self.buf = ''

def BotSense.BotSenseTypes.ByteBuf.__del__

(

self

)

Delete byte buffer instance. 

Definition at line 390 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.ByteBuf._swigObj.

  def __del__(self):
    """ Delete byte buffer instance. """
    bsCore.delete_byteArray(self._swigObj)

Member Function Documentation

def BotSense.BotSenseTypes.ByteBuf.__getitem__	(		self,
			i
	)

x.__getitem__(i)  <==> x[i] 

Definition at line 439 of file BotSenseTypes.py.

  def __getitem__(self, i):
    """ x.__getitem__(i)  <==> x[i] """
    return self.buf.__getitem__(i)

def BotSense.BotSenseTypes.ByteBuf.__getslice__	(		self,
			i,
			j
	)

x.__getslice__(i, j)  <==> x[i:j] 

Definition at line 445 of file BotSenseTypes.py.

  def __getslice__(self, i, j):
    """ x.__getslice__(i, j)  <==> x[i:j] """
    return self.buf.__getslice__(i, j)

def BotSense.BotSenseTypes.ByteBuf.__iadd__	(		self,
			y
	)

x.__iadd__(y)  <==> x+=y 

Definition at line 451 of file BotSenseTypes.py.

  def __iadd__(self, y):
    """ x.__iadd__(y)  <==> x+=y """
    z = ByteBuf.bytestring(y)
    self.buf.__iadd__(z)
    return self

def BotSense.BotSenseTypes.ByteBuf.__imul__	(		self,
			y
	)

x.__imul__(y)  <==> x*=y 

Definition at line 459 of file BotSenseTypes.py.

  def __imul__(self, y):
    """ x.__imul__(y)  <==> x*=y """
    self.buf.__imul__(y)
    return self

def BotSense.BotSenseTypes.ByteBuf.__iter__

(

self

)

x.__iter__()  <==> iter(x) 

Definition at line 466 of file BotSenseTypes.py.

  def __iter__(self):
    """ x.__iter__()  <==> iter(x) """
    return self.buf.__iter__()

def BotSense.BotSenseTypes.ByteBuf.__len__

(

self

)

x.__len__() <==> len(x)

Number of bytes used in buffer. 

Definition at line 472 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.ByteBuf.buf.

  def __len__(self):
    """ x.__len__() <==> len(x)
        
        Number of bytes used in buffer. 
    """
    return len(self.buf)

def BotSense.BotSenseTypes.ByteBuf.__setitem__	(		self,
			i,
			y
	)

x.__setitem__(i, y)  <==> x[i]=y 

Definition at line 487 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.ByteBuf.byte().

  def __setitem__(self, i, y):
    """ x.__setitem__(i, y)  <==> x[i]=y """
    z = self.byte(y)
    self.buf.__setitem__(i, z)
    return self

def BotSense.BotSenseTypes.ByteBuf.__setslice__	(		self,
			i,
			j,
			y
	)

x.__setslice__(i, j, y)  <==> x[i:j]=y 

Definition at line 495 of file BotSenseTypes.py.

  def __setslice__(self, i, j, y):
    """ x.__setslice__(i, j, y)  <==> x[i:j]=y """
    z = ByteBuf.bytestring(y)
    self.buf.__setslice__(i, j, z)
    return self

def BotSense.BotSenseTypes.ByteBuf.__sizeof__

(

self

)

x.__sizeof__() -- size of swig object byte buffer, in bytes. 

Definition at line 503 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.ByteBuf._size.

Referenced by BotSense.BotSenseTypes.ByteBuf.sizeof().

  def __sizeof__(self):
    """ x.__sizeof__() -- size of swig object byte buffer, in bytes. """
    return self._size

def BotSense.BotSenseTypes.ByteBuf.__str__

(

self

)

x.__str__() <==> str(x) <==> print x 

Definition at line 481 of file BotSenseTypes.py.

  def __str__(self):
    """ x.__str__() <==> str(x) <==> print x """
    return self.buf.__str__()

def BotSense.BotSenseTypes.ByteBuf.avail

(

self

)

Available bytes in fixed swig object buffer. 

Definition at line 509 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.ByteBuf._size, and BotSense.BotSenseTypes.ByteBuf.buf.

  def avail(self):
    """ Available bytes in fixed swig object buffer. """
    return self._size - len(self.buf)

def BotSense.BotSenseTypes.ByteBuf.byte (   val )

static

Static method to convert a value into a byte.

Parameters:
  val   - Value to convert. Value type can be an integer [0,255],
          a string of length 1, or a list of length 1 of element
          type of integer, string, list.

Return:
  On success, returns converted byte value.
  On failure, a BotSenseError exception is raised.

Definition at line 577 of file BotSenseTypes.py.

Referenced by BotSense.BotSenseTypes.ByteBuf.__setitem__().

  def byte(val):
    """ Static method to convert a value into a byte.
    
        Parameters:
          val   - Value to convert. Value type can be an integer [0,255],
                  a string of length 1, or a list of length 1 of element
                  type of integer, string, list.

        Return:
          On success, returns converted byte value.
          On failure, a BotSenseError exception is raised.
    """
    if type(val) == int:
      if val > 255:
        raise bsError.BotSenseError(bsCore.BS_ECODE_BAD_VAL, "%s" % str(val))
      else:
        return val
    elif type(val) == str:
      if len(val) != 1:
        raise bsError.BotSenseError(bsCore.BS_ECODE_BAD_VAL, "%s" % str(val))
      else:
        return ord(val[0])
    elif type(val) == list:
      if len(val) != 1:
        raise bsError.BotSenseError(bsCore.BS_ECODE_BAD_VAL, "%s" % str(val))
      else:
        return ByteBuf.byte(val[0])
    else:
      raise bsError.BotSenseError(bsCore.BS_ECODE_BAD_VAL, "%s" % str(val))

def BotSense.BotSenseTypes.ByteBuf.bytec (   val )

static

Static method to convert a value into a byte character string.

Parameters:
  val   - Value to convert. Value type can be an integer [0,255],
          a string of length 1, or a list of length 1 of element
          type of integer, string, list.

Return:
  On success, returns converted byte value.
  On failure, a BotSenseError exception is raised.

Definition at line 638 of file BotSenseTypes.py.

  def bytec(val):
    """ Static method to convert a value into a byte character string.
    
        Parameters:
          val   - Value to convert. Value type can be an integer [0,255],
                  a string of length 1, or a list of length 1 of element
                  type of integer, string, list.

        Return:
          On success, returns converted byte value.
          On failure, a BotSenseError exception is raised.
    """
    if type(val) == int:
      if val > 255:
        raise bsError.BotSenseError(bsCore.BS_ECODE_BAD_VAL, "%s" % str(val))
      else:
        return chr(val)
    elif type(val) == str:
      if len(val) != 1:
        raise bsError.BotSenseError(bsCore.BS_ECODE_BAD_VAL, "%s" % str(val))
      else:
        return val[0]
    elif type(val) == list:
      if len(val) != 1:
        raise bsError.BotSenseError(bsCore.BS_ECODE_BAD_VAL, "%s" % str(val))
      else:
        return ByteBuf.bytec(val[0])
    else:
      raise bsError.BotSenseError(bsCore.BS_ECODE_BAD_VAL, "%s" % str(val))

def BotSense.BotSenseTypes.ByteBuf.bytelist (   seq )

static

Static method to convert a value sequence into a byte list.

Parameters:
  seq     - Sequence of values to convert. Sequence type can be an
            integer [0,255], a string, or a list of elements of
            type integer, string, list.

Return:
  On success, returns converted byte value list.
  On failure, a BotSenseError exception is raised.

Definition at line 610 of file BotSenseTypes.py.

  def bytelist(seq):
    """ Static method to convert a value sequence into a byte list.

        Parameters:
          seq     - Sequence of values to convert. Sequence type can be an
                    integer [0,255], a string, or a list of elements of
                    type integer, string, list.

        Return:
          On success, returns converted byte value list.
          On failure, a BotSenseError exception is raised.
    """
    if seq is None:
      return []
    elif type(seq) == int:
      outbuf = [ ByteBuf.byte(seq) ]
      return outbuf
    elif type(seq) == str or type(seq) == list:
      outbuf = []
      for val in seq:
        outbuf += [ ByteBuf.byte(val) ]
      return outbuf
    else:
      raise bsError.BotSenseError(bsCore.BS_ECODE_BAD_VAL, "%s" % str(val))

def BotSense.BotSenseTypes.ByteBuf.bytestring (   seq )

static

Static method to convert a value sequence into a byte string.

Parameters:
  seq     - Sequence of values to convert. Sequence type can be an
            integer [0,255], a string, or a list of elements of
            type integer, string, list.

Return:
  On success, returns converted byte value list.
  On failure, a BotSenseError exception is raised.

Definition at line 671 of file BotSenseTypes.py.

  def bytestring(seq):
    """ Static method to convert a value sequence into a byte string.

        Parameters:
          seq     - Sequence of values to convert. Sequence type can be an
                    integer [0,255], a string, or a list of elements of
                    type integer, string, list.

        Return:
          On success, returns converted byte value list.
          On failure, a BotSenseError exception is raised.
    """
    if seq is None:
      return ''
    elif type(seq) == int:
      return ByteBuf.bytec(seq)
    elif type(seq) == str or type(seq) == list:
      outbuf = ''
      for val in seq:
        outbuf += ByteBuf.bytec(val)
      return outbuf
    else:
      raise bsError.BotSenseError(bsCore.BS_ECODE_BAD_VAL, "%s" % str(val))

def BotSense.BotSenseTypes.ByteBuf.Clone (   buf )

static

Smart clone constructor.

If buf is a ByteBuf instance, then simply return buf.
Otherwise convert buf to a ByteBuf instance.

The underlining swig object contents are not touched, so swig copies
will need to be done prior to or after calling a byte_t* core routine.

Parameters:
  buf   - Either a ByteBuf instance or a sequence of values to convert.
          Sequence type can be an integer [0,255], a string, or a list
          of elements of type integer, string, list.

Return:
  Existing or new ByteBuf().

Definition at line 415 of file BotSenseTypes.py.

  def Clone(buf):
    """ Smart clone constructor.

        If buf is a ByteBuf instance, then simply return buf.
        Otherwise convert buf to a ByteBuf instance.

        The underlining swig object contents are not touched, so swig copies
        will need to be done prior to or after calling a byte_t* core routine.

        Parameters:
          buf   - Either a ByteBuf instance or a sequence of values to convert.
                  Sequence type can be an integer [0,255], a string, or a list
                  of elements of type integer, string, list.

        Return:
          Existing or new ByteBuf().
    """
    if isinstance(buf, ByteBuf):
      return buf
    else:
      return ByteBuf.Constructor(buf)

def BotSense.BotSenseTypes.ByteBuf.Constructor (   seq )

static

Conversion constructor.

Parameters:
  seq   - Sequence of values to convert. Sequence type can be an
          integer [0,255], a string, or a list of elements of
          type integer, string, list.

Return:
  New initialized ByteBuf().

Definition at line 397 of file BotSenseTypes.py.

  def Constructor(seq):
    """ Conversion constructor.

        Parameters:
          seq   - Sequence of values to convert. Sequence type can be an
                  integer [0,255], a string, or a list of elements of
                  type integer, string, list.

        Return:
          New initialized ByteBuf().
    """
    buf = ByteBuf.bytestring(seq)
    bytebuf = ByteBuf(size=len(buf))
    bytebuf.buf = buf
    return bytebuf

def BotSense.BotSenseTypes.ByteBuf.copyFromSwigObj	(		self,
			n,
			i = 0,
			j = 0
	)

Copy swig object buffer to python buffer.

Parameters:
  n   - Number of bytes to copy.
  i   - Starting source index in swig object buffer.
  j   - Starting destination index in python buffer.

Definition at line 515 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.ByteBuf._size, BotSense.BotSenseTypes.ByteBuf._swigObj, and BotSense.BotSenseTypes.ByteBuf.buf.

  def copyFromSwigObj(self, n, i=0, j=0):
    """ Copy swig object buffer to python buffer.

        Parameters:
          n   - Number of bytes to copy.
          i   - Starting source index in swig object buffer.
          j   - Starting destination index in python buffer.
    """
    if i+n > self._size:
      raise bsError.BotSenseError(bsCore.BS_ECODE_BUF_TOO_SMALL,
          "copyFromSwigObj: swig object buffer size=%d < %d bytes" % \
              (self._size, i+n))
    l = len(self.buf)
    if l < j+n:
      self.buf += chr(0) * (j + n - l)
    s = ''
    for k in xrange(n):
      s += chr(bsCore.byteArray_getitem(self._swigObj, i+k))
    self.buf = self.buf[:j] + s

def BotSense.BotSenseTypes.ByteBuf.copyToSwigObj	(		self,
			n,
			i = 0,
			j = 0
	)

Copy python buffer to instance swig object buffer.

Parameters:
  n   - Number of bytes to copy.
  i   - Starting source index in python buffer.
  j   - Starting destination index in swig object buffer.

Definition at line 537 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.ByteBuf._size, BotSense.BotSenseTypes.ByteBuf._swigObj, and BotSense.BotSenseTypes.ByteBuf.buf.

  def copyToSwigObj(self, n, i=0, j=0):
    """ Copy python buffer to instance swig object buffer.

        Parameters:
          n   - Number of bytes to copy.
          i   - Starting source index in python buffer.
          j   - Starting destination index in swig object buffer.
    """
    if i+n > len(self.buf):
      raise bsError.BotSenseError(bsCore.BS_ECODE_BUF_TOO_SMALL,
          "copyToSwigObj: python buffer size=%d < %d bytes" % \
              (len(self.buf), i+n))
    elif j+n > self._size:
      raise bsError.BotSenseError(bsCore.BS_ECODE_BUF_TOO_SMALL,
          "copyToSwigObj: swig object buffer size=%d < %d bytes" % \
              (self._size, j+n))
    for k in xrange(n):
      bsCore.byteArray_setitem(self._swigObj, j+k, ord(self.buf[i+k]))

def BotSense.BotSenseTypes.ByteBuf.getBuffer

(

self

)

Return python buffer. 

Definition at line 564 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.ByteBuf.buf.

  def getBuffer(self):
    """ Return python buffer. """
    return self.buf

def BotSense.BotSenseTypes.ByteBuf.getSwigObj

(

self

)

Return raw swig object. 

Definition at line 558 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.ByteBuf._swigObj.

  def getSwigObj(self):
    """ Return raw swig object. """
    return self._swigObj

def BotSense.BotSenseTypes.ByteBuf.sizeof

(

self

)

Size of fixed swig object byte buffer, in bytes. 

Definition at line 570 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient.__sizeof__(), and BotSense.BotSenseTypes.ByteBuf.__sizeof__().

  def sizeof(self):
    """ Size of fixed swig object byte buffer, in bytes. """
    return self.__sizeof__()

---

The documentation for this class was generated from the following file:

• bsPython/modules/BotSense/BotSenseTypes.py