BotSense.BotSenseTypes.BsProxyMsgHdr Class Reference

Inheritance diagram for BotSense.BotSenseTypes.BsProxyMsgHdr:

Public Member Functions
def	__init__ (self, tid=0, vconn=bsCore.BSPROXY_VCONN_SERVER, msgid=0, bodylen=0)
def	__sizeof__ (self)
def	__getitem__ (self, y)
def	__setitem__ (self, y, v)
def	__iter__ (self)
def	__str__ (self)
def	ListAttrs (self)
def	PackMsgHdr (self, buf)
def	UnpackMsgHdr (self, buf)

Public Attributes
	m_hdrMagic
	message header fixed magic number
	m_hdrTid
	message header transaction id
	m_hdrVConn
	message header virtual connection handle
	m_hdrMsgId
	message header message id
	m_hdrBodyLen
	message header body length

Detailed Description

BotSense bsProxy Message Header Wrapper Class. 

Definition at line 701 of file BotSenseTypes.py.

Constructor & Destructor Documentation

def BotSense.BotSenseTypes.BsProxyMsgHdr.__init__	(		self,
			tid = 0,
			vconn = bsCore.BSPROXY_VCONN_SERVER,
			msgid = 0,
			bodylen = 0
	)

Initialize BotSense Proxy Message Header instance.

Parameters:
  tid     - Transaction id.
  vconn   - Virtual connection handle.
  msgid   - Message id.
  bodylen - Message body length, in bytes.

Definition at line 706 of file BotSenseTypes.py.

                      bodylen=0):
    """ Initialize BotSense Proxy Message Header instance.

        Parameters:
          tid     - Transaction id.
          vconn   - Virtual connection handle.
          msgid   - Message id.
          bodylen - Message body length, in bytes.
    """
    bsCore.BsProxyMsgHdr_T.__init__(self)
    ## message header fixed magic number
    self.m_hdrMagic   = bsCore.BSPROXY_MSG_MAGIC
    ## message header transaction id
    self.m_hdrTid     = tid
    ## message header virtual connection handle
    self.m_hdrVConn   = vconn
    ## message header message id
    self.m_hdrMsgId   = msgid
    ## message header body length
    self.m_hdrBodyLen = bodylen

    ## class attributes
    self._attrlist = ['m_hdrMagic', 'm_hdrTid', 'm_hdrVConn', 'm_hdrMsgId',
                      'm_hdrBodyLen']

Member Function Documentation

def BotSense.BotSenseTypes.BsProxyMsgHdr.__getitem__	(		self,
			y
	)

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

Definition at line 739 of file BotSenseTypes.py.

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

def BotSense.BotSenseTypes.BsProxyMsgHdr.__iter__

(

self

)

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

Definition at line 754 of file BotSenseTypes.py.

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

def BotSense.BotSenseTypes.BsProxyMsgHdr.__setitem__	(		self,
			y,
			v
	)

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

Definition at line 745 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsProxyMsgHdr._attrlist.

  def __setitem__(self, y, v):
    """ x.__setitem__(y, v) <==> x[y]=v """
    if y in self._attrlist:
      setattr(self, y, v)
    else:
      raise AttributeError(y)

def BotSense.BotSenseTypes.BsProxyMsgHdr.__sizeof__

(

self

)

x.__sizeof__() -- size of header, in bytes. 

Definition at line 733 of file BotSenseTypes.py.

  def __sizeof__(self):
    """ x.__sizeof__() -- size of header, in bytes. """
    return bsCore.BSPROXY_MSG_HDR_LEN

def BotSense.BotSenseTypes.BsProxyMsgHdr.__str__

(

self

)

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

Definition at line 760 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsProxyMsgHdr._attrlist.

  def __str__(self):
    """ x.__str__() <==> str(x) <==> print x """
    d = {}
    for attr in self._attrlist:
      d[attr] = getattr(self, attr)
    return str(d)

def BotSense.BotSenseTypes.BsProxyMsgHdr.ListAttrs

(

self

)

Return list of class variable attribute names. 

Definition at line 769 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsProxyMsgHdr._attrlist.

  def ListAttrs(self):
    """ Return list of class variable attribute names. """
    return self._attrlist

def BotSense.BotSenseTypes.BsProxyMsgHdr.PackMsgHdr	(		self,
			buf
	)

Pack BotSense bsProxy message header

Raises a BotSenseError exception on failure.
 
Parameters:
  buf [out] - BotSenseTypes.ByteBuf output buffer instance.

Return:
  On success, returns the number of bytes packed.
  On failure, a BotSenseError exception is raised.

Definition at line 775 of file BotSenseTypes.py.

  def PackMsgHdr(self, buf):
    """ Pack BotSense bsProxy message header

        Raises a BotSenseError exception on failure.
         
        Parameters:
          buf [out] - BotSenseTypes.ByteBuf output buffer instance.

        Return:
          On success, returns the number of bytes packed.
          On failure, a BotSenseError exception is raised.
    """
    bsError.ChkType(buf, ByteBuf)
    n = bsCore.bsPackMsgHdr(self, buf.getSwigObj(), buf.sizeof())
    bsError.ChkReturnIsNonNeg(n, "Failed to pack message header.")
    buf.copyFromSwigObj(n)
    return n 

def BotSense.BotSenseTypes.BsProxyMsgHdr.UnpackMsgHdr	(		self,
			buf
	)

Unpack BotSense bsProxy message header

Raises a BotSenseError exception on failure.

Parameters:
  buf [in]  - BotSenseTypes.ByteBuf input buffer instance.

Return:
  On success, returns the number of bytes unpacked.
  On failure, a BotSenseError exception is raised.

Definition at line 795 of file BotSenseTypes.py.

  def UnpackMsgHdr(self, buf):
    """ Unpack BotSense bsProxy message header

        Raises a BotSenseError exception on failure.

        Parameters:
          buf [in]  - BotSenseTypes.ByteBuf input buffer instance.

        Return:
          On success, returns the number of bytes unpacked.
          On failure, a BotSenseError exception is raised.
    """
    bsError.ChkType(buf, ByteBuf)
    buf.copyToSwigObj(bsCore.BSPROXY_MSG_HDR_LEN)
    n = bsCore.bsUnpackMsgHdr(buf.getSwigObj(), len(buf), self)
    bsError.ChkReturnIsNonNeg(n, "Failed to unpack message header.")
    return n 

---

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

• bsPython/modules/BotSense/BotSenseTypes.py