bsProxyMsgs.py

Go to the documentation of this file.

##############################################################################
#
# File: bsProxyMsgs.py
#

"""
bsProxyMsgs.py
"""

## \file
##
## \brief BotSense client application - bsProxy server-terminated core messages.
##
## \warning This file was auto-generated on 2018.08.10 13:54:22 from the NetMsgs
## XML specification bsProxyMsgs.xml.
##
## \par Copyright:
## (C) 2018. RoadNarrows LLC
## (http://www.roadnarrows.com)
## All Rights Reserved
##
##############################################################################


import NetMsgs.NetMsgsBase as nmBase
from NetMsgs.NetMsgsLibITV import NetMsgsITV

from BotSense.BotSenseCore import BSPROXY_VCONN_CLIENT_MAX


# -----------------------------------------------------------------------------
# BsProxy Message Id Enumeration
# -----------------------------------------------------------------------------

class BsProxyMsgId:
  """ BsProxy Message Id Enumeration class. """
  NoId                            = 0     # no message id
  RspOk                           = 1     # RspOk
  RspErr                          = 2     # RspErr
  ReqLoopback                     = 3     # ReqLoopback
  RspLoopback                     = 4     # RspLoopback
  ReqSetLogging                   = 5     # ReqSetLogging
  ReqGetVersion                   = 6     # ReqGetVersion
  RspGetVersion                   = 7     # RspGetVersion
  ReqMsgTrace                     = 8     # ReqMsgTrace
  ReqDevOpen                      = 9     # ReqDevOpen
  RspDevOpen                      = 10    # RspDevOpen
  ReqDevClose                     = 11    # ReqDevClose
  ReqGetVConnList                 = 12    # ReqGetVConnList
  RspGetVConnList                 = 13    # RspGetVConnList
  ReqGetVConnInfo                 = 14    # ReqGetVConnInfo
  RspGetVConnInfo                 = 15    # RspGetVConnInfo
  NumOf                           = 16    # number of message ids
##


# -----------------------------------------------------------------------------
# Message Definition Set
# -----------------------------------------------------------------------------

## RspOk Message Definition 
BsProxyMsgDefRspOk = {
  'fielddef': [  ],
  'ftype': '{',
  'max_count': 0,
  'msgid': BsProxyMsgId.RspOk,
  'name': 'RspOk',
}
##

## RspErr Message Definition 
BsProxyMsgDefRspErr = {
  'fielddef': [
    {'fid':1, 'ftype':'B', 'max_count':1, 'name':'ecode', },
    {
      'fid': 2,
      'ftype': 's',
      'max_count': nmBase.NMStringMaxCount,
      'name': 'emsg',
    },
  ],
  'ftype': '{',
  'max_count': 2,
  'msgid': BsProxyMsgId.RspErr,
  'name': 'RspErr',
}
##

## ReqLoopback Message Definition 
BsProxyMsgDefReqLoopback = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': 's',
      'max_count': nmBase.NMStringMaxCount,
      'name': 'cdata',
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsProxyMsgId.ReqLoopback,
  'name': 'ReqLoopback',
}
##

## RspLoopback Message Definition 
BsProxyMsgDefRspLoopback = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': 's',
      'max_count': nmBase.NMStringMaxCount,
      'name': 'cdata',
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsProxyMsgId.RspLoopback,
  'name': 'RspLoopback',
}
##

## ReqSetLogging Message Definition 
BsProxyMsgDefReqSetLogging = {
  'fielddef': [
    {'fid':1, 'ftype':'i', 'max_count':1, 'name':'level', },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsProxyMsgId.ReqSetLogging,
  'name': 'ReqSetLogging',
}
##

## ReqGetVersion Message Definition 
BsProxyMsgDefReqGetVersion = {
  'fielddef': [  ],
  'ftype': '{',
  'max_count': 0,
  'msgid': BsProxyMsgId.ReqGetVersion,
  'name': 'ReqGetVersion',
}
##

## RspGetVersion Message Definition 
BsProxyMsgDefRspGetVersion = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': 's',
      'max_count': nmBase.NMStringMaxCount,
      'name': 'version',
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsProxyMsgId.RspGetVersion,
  'name': 'RspGetVersion',
}
##

## ReqMsgTrace Message Definition 
BsProxyMsgDefReqMsgTrace = {
  'fielddef': [
    {'fid':1, 'ftype':'B', 'max_count':1, 'name':'vconn', },
    {'fid':2, 'ftype':'?', 'max_count':1, 'name':'trace', },
  ],
  'ftype': '{',
  'max_count': 2,
  'msgid': BsProxyMsgId.ReqMsgTrace,
  'name': 'ReqMsgTrace',
}
##

## ReqDevOpen Message Definition 
BsProxyMsgDefReqDevOpen = {
  'fielddef': [
    {'fid':1, 'ftype':'?', 'max_count':1, 'name':'trace', },
    {
      'fid': 2,
      'ftype': 's',
      'max_count': nmBase.NMStringMaxCount,
      'name': 'devname',
    },
    {
      'fid': 3,
      'ftype': 's',
      'max_count': nmBase.NMStringMaxCount,
      'name': 'modname',
    },
    {
      'fid': 4,
      'ftype': '[',
      'max_count': nmBase.NMVectorMaxCount,
      'name': 'argbuf',
      'vdef': {
        'fid': nmBase.NMFIdNone,
        'ftype': 'B',
        'max_count': 1,
        'name': 'argbuf_item',
      },
    },
  ],
  'ftype': '{',
  'max_count': 4,
  'msgid': BsProxyMsgId.ReqDevOpen,
  'name': 'ReqDevOpen',
}
##

## RspDevOpen Message Definition 
BsProxyMsgDefRspDevOpen = {
  'fielddef': [
    {'fid':1, 'ftype':'B', 'max_count':1, 'name':'vconn', },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsProxyMsgId.RspDevOpen,
  'name': 'RspDevOpen',
}
##

## ReqDevClose Message Definition 
BsProxyMsgDefReqDevClose = {
  'fielddef': [
    {'fid':1, 'ftype':'B', 'max_count':1, 'name':'vconn', },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsProxyMsgId.ReqDevClose,
  'name': 'ReqDevClose',
}
##

## ReqGetVConnList Message Definition 
BsProxyMsgDefReqGetVConnList = {
  'fielddef': [  ],
  'ftype': '{',
  'max_count': 0,
  'msgid': BsProxyMsgId.ReqGetVConnList,
  'name': 'ReqGetVConnList',
}
##

## RspGetVConnList Message Definition 
BsProxyMsgDefRspGetVConnList = {
  'fielddef': [
    {
      'fid': 1,
      'ftype': '[',
      'max_count': BSPROXY_VCONN_CLIENT_MAX,
      'name': 'vconn',
      'vdef': {
        'fid': nmBase.NMFIdNone,
        'ftype': 'B',
        'max_count': 1,
        'name': 'vconn_item',
      },
    },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsProxyMsgId.RspGetVConnList,
  'name': 'RspGetVConnList',
}
##

## ReqGetVConnInfo Message Definition 
BsProxyMsgDefReqGetVConnInfo = {
  'fielddef': [
    {'fid':1, 'ftype':'B', 'max_count':1, 'name':'vconn', },
  ],
  'ftype': '{',
  'max_count': 1,
  'msgid': BsProxyMsgId.ReqGetVConnInfo,
  'name': 'ReqGetVConnInfo',
}
##

## RspGetVConnInfo Message Definition 
BsProxyMsgDefRspGetVConnInfo = {
  'fielddef': [
    {'fid':1, 'ftype':'B', 'max_count':1, 'name':'vconn', },
    {'fid':2, 'ftype':'i', 'max_count':1, 'name':'rd', },
    {
      'fid': 3,
      'ftype': 's',
      'max_count': nmBase.NMStringMaxCount,
      'name': 'client',
    },
    {
      'fid': 4,
      'ftype': 's',
      'max_count': nmBase.NMStringMaxCount,
      'name': 'devuri',
    },
    {
      'fid': 5,
      'ftype': 's',
      'max_count': nmBase.NMStringMaxCount,
      'name': 'moduri',
    },
    {
      'fid': 6,
      'ftype': 's',
      'max_count': nmBase.NMStringMaxCount,
      'name': 'modver',
    },
    {
      'fid': 7,
      'ftype': 's',
      'max_count': nmBase.NMStringMaxCount,
      'name': 'moddate',
    },
  ],
  'ftype': '{',
  'max_count': 7,
  'msgid': BsProxyMsgId.RspGetVConnInfo,
  'name': 'RspGetVConnInfo',
}
##

## BsProxy Message Definition Set Dictionary
BsProxySetMsgDef = {
  BsProxyMsgId.ReqDevClose: BsProxyMsgDefReqDevClose,
  BsProxyMsgId.ReqDevOpen: BsProxyMsgDefReqDevOpen,
  BsProxyMsgId.ReqGetVConnInfo: BsProxyMsgDefReqGetVConnInfo,
  BsProxyMsgId.ReqGetVConnList: BsProxyMsgDefReqGetVConnList,
  BsProxyMsgId.ReqGetVersion: BsProxyMsgDefReqGetVersion,
  BsProxyMsgId.ReqLoopback: BsProxyMsgDefReqLoopback,
  BsProxyMsgId.ReqMsgTrace: BsProxyMsgDefReqMsgTrace,
  BsProxyMsgId.ReqSetLogging: BsProxyMsgDefReqSetLogging,
  BsProxyMsgId.RspDevOpen: BsProxyMsgDefRspDevOpen,
  BsProxyMsgId.RspErr: BsProxyMsgDefRspErr,
  BsProxyMsgId.RspGetVConnInfo: BsProxyMsgDefRspGetVConnInfo,
  BsProxyMsgId.RspGetVConnList: BsProxyMsgDefRspGetVConnList,
  BsProxyMsgId.RspGetVersion: BsProxyMsgDefRspGetVersion,
  BsProxyMsgId.RspLoopback: BsProxyMsgDefRspLoopback,
  BsProxyMsgId.RspOk: BsProxyMsgDefRspOk,
}
##


# -----------------------------------------------------------------------------
# CLASS: BsProxyNetMsgs
# -----------------------------------------------------------------------------

class BsProxyNetMsgs(NetMsgsITV):
  """ BsProxy NetMsgs Class. """

  #--
  def __init__(self, **kwargs):
    """ BsProxy NetMsgs initialization. """
    kwargs['msgsetname'] = 'BsProxyMsgSet'
    NetMsgsITV.__init__(self, BsProxySetMsgDef, **kwargs)
  ##
##