BotSense.bsNull Namespace Reference

BotSense Swigged Null Python Interface Module. More...

Classes
class	_object

Functions
def	swig_import_helper ()
def	bsNullGetMsgName (pClient, hndVConn, uMsgId)
def	bsNullReqOpen (pClient, bInitTrace)
def	bsNullReqClose (pClient, hndVConn)
def	bsNullReqWrite (pClient, hndVConn, wbuf, uWriteLen)
def	NullGetMsgName (client, hndVConn, msgId)
def	NullReqOpen (client, trace=False)
def	NullReqClose (client, hndVConn)
def	NullReqWrite (client, hndVConn, wbuf)

Variables
	BS_NULL_DEV_NAME = _bsNull.BS_NULL_DEV_NAME
	BS_NULL_SERVER_MOD = _bsNull.BS_NULL_SERVER_MOD
	BS_NULL_CLIENT_LIB = _bsNull.BS_NULL_CLIENT_LIB
	bsNullGetMsgName = _bsNull.bsNullGetMsgName
	bsNullReqOpen = _bsNull.bsNullReqOpen
	bsNullReqClose = _bsNull.bsNullReqClose
	bsNullReqWrite = _bsNull.bsNullReqWrite

Detailed Description

BotSense Swigged Null Python Interface Module.

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright:

(C) 2010. RoadNarrows LLC.
(http://www.roadnarrows.com)
All Rights Reserved

Function Documentation

def BotSense.bsNull.NullGetMsgName	(		client,
			hndVConn,
			msgId
	)

Get the DevNull message name.

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

    Parameters:
      client    - BotSenseTypes.BsClient instance.
      hndVConn  - Virtual connection handle (ignored).
      msgId     - DevNull message id.

    Return:
      Returns message name string if it can be determined.
      Otherwise returns 'unknown'.

Definition at line 142 of file bsNull.py.

def NullGetMsgName(client, hndVConn, msgId):
  """ Get the DevNull message name.

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

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        hndVConn  - Virtual connection handle (ignored).
        msgId     - DevNull message id.

      Return:
        Returns message name string if it can be determined.
        Otherwise returns 'unknown'.
  """
  bsTypes.BsClient.ChkClient(client)
  return bsNullGetMsgName(client.pClient, hndVConn, msgId)

def BotSense.bsNull.NullReqClose	(		client,
			hndVConn
	)

Proxy server request to close client's proxied /dev/null device virtual
    connection.

    Raises a BotSenseError exception on failure.

    Parameters:
      client    - BotSenseTypes.BsClient instance.
      hndVConn  - Virtual connection handle.

Definition at line 180 of file bsNull.py.

def NullReqClose(client, hndVConn):
  """ Proxy server request to close client's proxied /dev/null device virtual
      connection.

      Raises a BotSenseError exception on failure.

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        hndVConn  - Virtual connection handle.
  """
  bsTypes.BsClient.ChkClient(client)
  rc = bsNullReqClose(client.pClient, hndVConn)
  bsError.ChkReturnIsOk(rc,
      "Client %s: DevNull Close request failed." % (client.AttrGetName()))

def BotSense.bsNull.NullReqOpen	(		client,
			trace = False
	)

Proxy server request to establish a virtual connection to the /dev/null
    device.

    Raises a BotSenseError exception on failure.

    Parameters:
      client    - BotSenseTypes.BsClient instance.
      trace     - Initial message tracing enable(true)/disable(false) state.

    Return
      New virtual connection handle.

Definition at line 161 of file bsNull.py.

def NullReqOpen(client, trace=False):
  """ Proxy server request to establish a virtual connection to the /dev/null
      device.

      Raises a BotSenseError exception on failure.

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        trace     - Initial message tracing enable(true)/disable(false) state.

      Return
        New virtual connection handle.
  """
  bsTypes.BsClient.ChkClient(client)
  hndVConn = bsNullReqOpen(client.pClient, trace)
  bsError.ChkReturnIsNonNeg(hndVConn,
      "Client %s: DevNull Open request failed." % (client.AttrGetName()))
  return hndVConn

def BotSense.bsNull.NullReqWrite	(		client,
			hndVConn,
			wbuf
	)

DevNull request to write /dev/null.

    Raises a BotSenseError exception on failure.

    Parameters:
      client    - BotSenseTypes.BsClient instance.
      hndVConn  - Virtual connection handle.
      wbuf      - Write buffer.

    Return:
      Number of bytes written.

Definition at line 195 of file bsNull.py.

def NullReqWrite(client, hndVConn, wbuf):
  """ DevNull request to write /dev/null.

      Raises a BotSenseError exception on failure.

      Parameters:
        client    - BotSenseTypes.BsClient instance.
        hndVConn  - Virtual connection handle.
        wbuf      - Write buffer.

      Return:
        Number of bytes written.
  """
  bsTypes.BsClient.ChkClient(client)
  wbytebuf = bsTypes.ByteBuf.Clone(wbuf)
  wbytebuf.copyToSwigObj(len(wbytebuf))
  n = bsNullReqWrite(client.pClient, hndVConn, wbytebuf.getSwigObj(),
                        len(wbytebuf))
  bsError.ChkReturnIsNonNeg(n,
      "Client %s: DevNull Write request failed." % (client.AttrGetName()))
  return n


# This file is compatible with both classic and new-style classes.