bsNull.py

Go to the documentation of this file.

# This file was automatically generated by SWIG (http://www.swig.org).
# Version 3.0.8
#
# Do not make changes to this file unless you know what you are doing--modify
# the SWIG interface file instead.





from sys import version_info
if version_info >= (2, 6, 0):
    def swig_import_helper():
        from os.path import dirname
        import imp
        fp = None
        try:
            fp, pathname, description = imp.find_module('_bsNull', [dirname(__file__)])
        except ImportError:
            import _bsNull
            return _bsNull
        if fp is not None:
            try:
                _mod = imp.load_module('_bsNull', fp, pathname, description)
            finally:
                fp.close()
            return _mod
    _bsNull = swig_import_helper()
    del swig_import_helper
else:
    import _bsNull
del version_info
try:
    _swig_property = property
except NameError:
    pass  # Python < 2.2 doesn't have 'property'.


def _swig_setattr_nondynamic(self, class_type, name, value, static=1):
    if (name == "thisown"):
        return self.this.own(value)
    if (name == "this"):
        if type(value).__name__ == 'SwigPyObject':
            self.__dict__[name] = value
            return
    method = class_type.__swig_setmethods__.get(name, None)
    if method:
        return method(self, value)
    if (not static):
        if _newclass:
            object.__setattr__(self, name, value)
        else:
            self.__dict__[name] = value
    else:
        raise AttributeError("You cannot add attributes to %s" % self)


def _swig_setattr(self, class_type, name, value):
    return _swig_setattr_nondynamic(self, class_type, name, value, 0)


def _swig_getattr_nondynamic(self, class_type, name, static=1):
    if (name == "thisown"):
        return self.this.own()
    method = class_type.__swig_getmethods__.get(name, None)
    if method:
        return method(self)
    if (not static):
        return object.__getattr__(self, name)
    else:
        raise AttributeError(name)

def _swig_getattr(self, class_type, name):
    return _swig_getattr_nondynamic(self, class_type, name, 0)


def _swig_repr(self):
    try:
        strthis = "proxy of " + self.this.__repr__()
    except Exception:
        strthis = ""
    return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)

try:
    _object = object
    _newclass = 1
except AttributeError:
    class _object:
        pass
    _newclass = 0



_bsNull.BS_NULL_DEV_NAME_swigconstant(_bsNull)
BS_NULL_DEV_NAME = _bsNull.BS_NULL_DEV_NAME

_bsNull.BS_NULL_SERVER_MOD_swigconstant(_bsNull)
BS_NULL_SERVER_MOD = _bsNull.BS_NULL_SERVER_MOD

_bsNull.BS_NULL_CLIENT_LIB_swigconstant(_bsNull)
BS_NULL_CLIENT_LIB = _bsNull.BS_NULL_CLIENT_LIB

def bsNullGetMsgName(pClient, hndVConn, uMsgId):
    return _bsNull.bsNullGetMsgName(pClient, hndVConn, uMsgId)
bsNullGetMsgName = _bsNull.bsNullGetMsgName

def bsNullReqOpen(pClient, bInitTrace):
    return _bsNull.bsNullReqOpen(pClient, bInitTrace)
bsNullReqOpen = _bsNull.bsNullReqOpen

def bsNullReqClose(pClient, hndVConn):
    return _bsNull.bsNullReqClose(pClient, hndVConn)
bsNullReqClose = _bsNull.bsNullReqClose

def bsNullReqWrite(pClient, hndVConn, wbuf, uWriteLen):
    return _bsNull.bsNullReqWrite(pClient, hndVConn, wbuf, uWriteLen)
bsNullReqWrite = _bsNull.bsNullReqWrite


"""
BotSense DevNull Python Inline Extensions and Wrappers.
"""

## \file 
## \package BotSense.bsNull
##
## \brief BotSense Swigged Null Python Interface Module.
##
## \author Robin Knight (robin.knight@roadnarrows.com)
##  
## \par Copyright:
##   (C) 2010.  RoadNarrows LLC.\n
##   (http://www.roadnarrows.com)\n
##   All Rights Reserved
##

import BotSenseCore  as bsCore
import BotSenseError as bsError
import BotSenseTypes as bsTypes


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 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 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 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.