BotSense.BotSenseTypes.BsClient Class Reference

Public Member Functions
def	__init__ (self, clientName='bsclient')
def	__del__ (self)
def	__sizeof__ (self)
def	AttrGetName (self)
def	AttrGetTraceState (self, hndVConn)
def	AttrGetVConnCount (self)
def	AttrHasVConn (self, hndVConn)
def	AttrGetDevName (self, hndVConn)
def	AttrGetModName (self, hndVConn)
def	AttrSetLogging (self, nLevel)
def	AttrGetConnState (self)
def	AttrGetTimeouts (self)
def	AttrSetTimeouts (self, reqTimeout, rspTimeout)
def	GetMsgName (self, hndVConn, msgId)
def	Trans (self, hndVConn, reqMsgId, reqBuf, rspMsgId, rspMaxSize=bsCore.BSPROXY_MSG_BODY_MAX)

Static Public Member Functions
def	ChkClient (obj)

Public Attributes
	pClient
	Pointer to opaque object.

Detailed Description

BotSense Client Wrapper Class.

    The BsClient class provides a safe wrapper around the BsClient_T *
    opaque object.

Definition at line 72 of file BotSenseTypes.py.

Constructor & Destructor Documentation

def BotSense.BotSenseTypes.BsClient.__init__	(		self,
			clientName = 'bsclient'
	)

  Create and initialize BotSense client instance.

  Parameters:
clientName  - Proxied client name string.

Definition at line 80 of file BotSenseTypes.py.

  def __init__(self, clientName='bsclient'):
    """ 
      Create and initialize BotSense client instance.

      Parameters:
        clientName  - Proxied client name string.
    """
    ## Pointer to opaque object
    self.pClient = None

    pClient = bsCore.bsClientNew(clientName)
    if not pClient:
      raise bsError.BotSenseError(BS_ECODE_NO_RSRC, "Failed to create client.")

    self.pClient = pClient

def BotSense.BotSenseTypes.BsClient.__del__

(

self

)

Delete BotSense client instance. 

Definition at line 98 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient.pClient.

  def __del__(self):
    """ Delete BotSense client instance. """
    if self.pClient is not None:
      bsCore.bsClientDelete(self.pClient)
    self.pClient = None

Member Function Documentation

def BotSense.BotSenseTypes.BsClient.__sizeof__

(

self

)

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

Definition at line 106 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient.pClient.

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

  def __sizeof__(self):
    """ x.__sizeof__() -- size of swig object, in bytes. """
    if self.pClient is not None:
      return 1    # opaque size
    else:
      return 0    # opaque size

def BotSense.BotSenseTypes.BsClient.AttrGetConnState

(

self

)

Get the client's connection state.

Return:
  Dictionary specifying connection state.

Definition at line 232 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient._ChkSelf(), and BotSense.BotSenseTypes.BsClient.pClient.

  def AttrGetConnState(self):
    """ Get the client's connection state.

        Return:
          Dictionary specifying connection state.
    """
    self._ChkSelf()
    connstate = bsCore.BsClientConnState_T()
    bsCore.bsClientAttrGetConnState(self.pClient, connstate)
    d = {}
    if connstate.m_bIsConnected:
      d['is_connected'] = True
    else:
      d['is_connected']   = False
    d['server_hostname']  = connstate.m_sServerHostName
    return d

def BotSense.BotSenseTypes.BsClient.AttrGetDevName	(		self,
			hndVConn
	)

Get the proxied device name associated with the given handle.

Parameters:
  hndVConn  - Virtual connection handle.

Return:
  On success, returns the device URI string. If no device is found,
  then '#nodev#' is returned.
  On parameter check failure, a BotSenseError exception is raised.

Definition at line 182 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient._ChkSelf(), and BotSense.BotSenseTypes.BsClient.pClient.

  def AttrGetDevName(self, hndVConn):
    """ Get the proxied device name associated with the given handle.

        Parameters:
          hndVConn  - Virtual connection handle.

        Return:
          On success, returns the device URI string. If no device is found,
          then '#nodev#' is returned.
          On parameter check failure, a BotSenseError exception is raised.
    """
    self._ChkSelf()
    devName = bsCore.bsClientAttrGetDevName(self.pClient, hndVConn)
    if not devName:
      devName = '#nodev#'
    return devName

def BotSense.BotSenseTypes.BsClient.AttrGetModName	(		self,
			hndVConn
	)

Get the proxied interface module name associated with the given
handle.

Parameters:
  hndVConn  - Virtual connection handle.

Return:
  On success, returns the I/F module URI string. If no module is
  found, then '#nomod#' is returned.
  On parameter check failure, a BotSenseError exception is raised.

Definition at line 201 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient._ChkSelf(), and BotSense.BotSenseTypes.BsClient.pClient.

  def AttrGetModName(self, hndVConn):
    """ Get the proxied interface module name associated with the given
        handle.

        Parameters:
          hndVConn  - Virtual connection handle.

        Return:
          On success, returns the I/F module URI string. If no module is
          found, then '#nomod#' is returned.
          On parameter check failure, a BotSenseError exception is raised.
    """
    self._ChkSelf()
    modName = bsCore.bsClientAttrGetModName(self.pClient, hndVConn)
    if not modName:
      modName = '#nomod#'
    return modName

def BotSense.BotSenseTypes.BsClient.AttrGetName

(

self

)

Get the client's name.

Return:
  On success, returns client string name.
  On parameter check failure, a BotSenseError exception is raised.

Definition at line 115 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient._ChkSelf(), and BotSense.BotSenseTypes.BsClient.pClient.

Referenced by BotSense.BotSenseTypes.BsClient.Trans().

  def AttrGetName(self):
    """ Get the client's name.

        Return:
          On success, returns client string name.
          On parameter check failure, a BotSenseError exception is raised.
    """
    self._ChkSelf()
    clientName = bsCore.bsClientAttrGetName(self.pClient)
    if not clientName:
      clientName = 'unknown'
    return clientName

def BotSense.BotSenseTypes.BsClient.AttrGetTimeouts

(

self

)

Get the client's request and response timeouts in seconds.

Definition at line 251 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient._ChkSelf(), and BotSense.BotSenseTypes.BsClient.pClient.

  def AttrGetTimeouts(self):
    """ Get the client's request and response timeouts in seconds.
    """
    self._ChkSelf()
    reqTimeout = bsCore.new_uintp();
    rspTimeout = bsCore.new_uintp();
    bsCore.bsClientAttrGetTimeouts(self.pClient, reqTimeout, rspTimeout)
    ret = (bsCore.uintp_value(reqTimeout), bsCore.uintp_value(rspTimeout))
    bsCore.delete_uintp(reqTimeout);
    bsCore.delete_uintp(rspTimeout);
    return ret

def BotSense.BotSenseTypes.BsClient.AttrGetTraceState	(		self,
			hndVConn
	)

Get a client's virtual connection trace state.

Parameters:
  hndVConn  - Virtual connection handle.

Return:
  On success, returns True (enabled) or False (disabled).
  On parameter check failure, a BotSenseError exception is raised.

Definition at line 130 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient._ChkSelf(), and BotSense.BotSenseTypes.BsClient.pClient.

  def AttrGetTraceState(self, hndVConn):
    """ Get a client's virtual connection trace state.

        Parameters:
          hndVConn  - Virtual connection handle.

        Return:
          On success, returns True (enabled) or False (disabled).
          On parameter check failure, a BotSenseError exception is raised.
    """
    self._ChkSelf()
    state = bsCore.bsClientAttrGetTraceState(self.pClient, hndVConn)
    if state:
      return True
    else:
      return False

def BotSense.BotSenseTypes.BsClient.AttrGetVConnCount

(

self

)

Get a client's virtual connection trace state.

Return:
  On success, returns client's virtual connection count.
  On parameter check failure, a BotSenseError exception is raised.

Definition at line 149 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient._ChkSelf(), and BotSense.BotSenseTypes.BsClient.pClient.

  def AttrGetVConnCount(self):
    """ Get a client's virtual connection trace state.

        Return:
          On success, returns client's virtual connection count.
          On parameter check failure, a BotSenseError exception is raised.
    """
    self._ChkSelf()
    cnt = bsCore.bsClientAttrGetVConnCount(self.pClient)
    return cnt

def BotSense.BotSenseTypes.BsClient.AttrHasVConn	(		self,
			hndVConn
	)

Check if the client has a virtual connection associated with the
given handle.

Parameters:
  hndVConn  - Virtual connection handle.

Return:
  On success, returns True or False.
  On parameter check failure, a BotSenseError exception is raised.

Definition at line 162 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient._ChkSelf(), and BotSense.BotSenseTypes.BsClient.pClient.

  def AttrHasVConn(self, hndVConn):
    """ Check if the client has a virtual connection associated with the
        given handle.

        Parameters:
          hndVConn  - Virtual connection handle.

        Return:
          On success, returns True or False.
          On parameter check failure, a BotSenseError exception is raised.
    """
    self._ChkSelf()
    tf = bsCore.bsClientAttrHasVConn(self.pClient, hndVConn)
    if tf:
      return True
    else:
      return False

def BotSense.BotSenseTypes.BsClient.AttrSetLogging	(		self,
			nLevel
	)

Set the client's diagnostic logging threshold.

Parameters:
  nLevel  - New logging threshold level.

Definition at line 221 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient._ChkSelf(), and BotSense.BotSenseTypes.BsClient.pClient.

  def AttrSetLogging(self, nLevel):
    """ Set the client's diagnostic logging threshold.

        Parameters:
          nLevel  - New logging threshold level.
    """
    self._ChkSelf()
    bsCore.bsClientAttrSetLogging(self.pClient, nLevel)

def BotSense.BotSenseTypes.BsClient.AttrSetTimeouts	(		self,
			reqTimeout,
			rspTimeout
	)

Set the client's request and response timeouts in seconds.

Parameters:
  reqTimeout  - Request (write) timeout.
  rspTimeout  - Response (read) timeout.

Definition at line 265 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient._ChkSelf(), and BotSense.BotSenseTypes.BsClient.pClient.

  def AttrSetTimeouts(self, reqTimeout, rspTimeout):
    """ Set the client's request and response timeouts in seconds.

        Parameters:
          reqTimeout  - Request (write) timeout.
          rspTimeout  - Response (read) timeout.
    """
    self._ChkSelf()
    bsCore.bsClientAttrSetTimeouts(self.pClient, reqTimeout, rspTimeout)

def BotSense.BotSenseTypes.BsClient.ChkClient (   obj )

static

Static check if object is a valid BsClient object.

Parameters:
    obj   - Object instance.

Definition at line 340 of file BotSenseTypes.py.

  def ChkClient(obj):
    """ Static check if object is a valid BsClient object.
    
        Parameters:
            obj   - Object instance.
    """
    bsError.ChkType(obj, BsClient)
    obj._ChkSelf()

def BotSense.BotSenseTypes.BsClient.GetMsgName	(		self,
			hndVConn,
			msgId
	)

Get the message name string.

For each (virtual connection, message id) 2-tuple, the message
name can be determinied (provided the msgid is valid and an
application provides the information).

Parameters:
  hndVConn  - Virtual connection handle.
  msgId     - Message id.

Return:
  On success, returns the message name string. If the name cannot
  be determined, then 'unknown' is returned.
  On parameter check failure, a BotSenseError exception is raised.

Definition at line 277 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient._ChkSelf(), BotSense.BotSenseTypes.BsClient.pClient, and BotSense.BotSenseTypes.BsClient.Trans().

  def GetMsgName(self, hndVConn, msgId):
    """ Get the message name string.

        For each (virtual connection, message id) 2-tuple, the message
        name can be determinied (provided the msgid is valid and an
        application provides the information).

        Parameters:
          hndVConn  - Virtual connection handle.
          msgId     - Message id.

        Return:
          On success, returns the message name string. If the name cannot
          be determined, then 'unknown' is returned.
          On parameter check failure, a BotSenseError exception is raised.
    """
    self._ChkSelf()
    return bsCore.bsClientGetMsgName(self.pClient, hndVConn, msgId)

def BotSense.BotSenseTypes.BsClient.Trans	(		self,
			hndVConn,
			reqMsgId,
			reqBuf,
			rspMsgId,
			rspMaxSize = bsCore.BSPROXY_MSG_BODY_MAX
	)

Execute a request - response transaction with the server.

The request message header is automatically generated. The response
message header is stripped off from the received response.

Raises a BotSenseError exception on failure.
 
Parameters:
  hndVConn    - Virtual connection handle.
  reqMsgId    - Virtual connection unique request message id.
  reqBuf      - Packed request message body.
  rspMsgId    - Virtual connection expected response message id.
  rspMaxSize  - Maximum expected response body size.

Return:
  Packed response message body buffer.

Definition at line 299 of file BotSenseTypes.py.

References BotSense.BotSenseTypes.BsClient._ChkSelf(), BotSense.BotSenseTypes.BsClient.AttrGetName(), BotSense.BotSenseTypes.BsClient.pClient, and BotSense.BotSenseTypes.sizeof().

Referenced by BotSense.BotSenseTypes.BsClient.GetMsgName().

                  rspMaxSize=bsCore.BSPROXY_MSG_BODY_MAX):
    """ Execute a request - response transaction with the server.

        The request message header is automatically generated. The response
        message header is stripped off from the received response.

        Raises a BotSenseError exception on failure.
         
        Parameters:
          hndVConn    - Virtual connection handle.
          reqMsgId    - Virtual connection unique request message id.
          reqBuf      - Packed request message body.
          rspMsgId    - Virtual connection expected response message id.
          rspMaxSize  - Maximum expected response body size.

        Return:
          Packed response message body buffer.
    """
    self._ChkSelf()
    reqByteBuf = ByteBuf.Clone(reqBuf)
    # leave space in buffer to prepend request message header
    reqByteBuf.copyToSwigObj(len(reqByteBuf), i=0, j=bsCore.BSPROXY_MSG_HDR_LEN)
    rspByteBuf = ByteBuf(rspMaxSize)
    n = bsCore.bsClientTrans(self.pClient, hndVConn,
                          reqMsgId, reqByteBuf.getSwigObj(), len(reqByteBuf),
                          rspMsgId, rspByteBuf.getSwigObj(), sizeof(rspByteBuf))
    bsError.ChkReturnIsNonNeg(n,
      "Client %s: Transaction request failed." % (self.AttrGetName()))
    rspByteBuf.copyFromSwigObj(n)
    return rspByteBuf.buf

---

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

• bsPython/modules/BotSense/BotSenseTypes.py