XML Message Set

Introduction

The RoadNarrows BotSense NetMsgs XML message specifications define the set of client-server-terminated messages supported by bsProxy.

The RoadNarrows NetMsgs package defines the supported XML format and generates the appropriate c and python code.

The message encoding is 8-bit Id-Type-Value (itv). All message fields are packed in big-endian order.

<!--
 - Package:   BotSense
 -
 - Library:   libbsclient
 -
 - File: bsProxyMsg.xml
 -
- See http://docs.python.org/library/struct.html
/*!
  $LastChangedDate$
  $Rev$

   \brief BotSense bsProxy server - client NetMsgs XML definitions.
  
   \author Robin Knight (robin.knight@roadnarrows.com)
  
 -  \copyright
 -    \h_copy 2009-2017. RoadNarrows LLC.\n
 -    http://www.roadnarrows.com\n
 -    All Rights Reserved
*/
 - Permission is hereby granted, without written agreement and without
 - license or royalty fees, to use, copy, modify, and distribute this
 - software and its documentation for any purpose, provided that
 - (1) The above copyright notice and the following two paragraphs
 - appear in all copies of the source code and (2) redistributions
 - including binaries reproduces these notices in the supporting
 - documentation.   Substantial modifications to this software may be
 - copyrighted by their authors and need not follow the licensing terms
 - described here, provided that the new terms are clearly indicated in
 - all files where they apply.
 -
 - IN NO EVENT SHALL THE AUTHOR, ROADNARROWS LLC, OR ANY MEMBERS/EMPLOYEES
 - OF ROADNARROW LLC OR DISTRIBUTORS OF THIS SOFTWARE BE LIABLE TO ANY
 - PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
 - DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION,
 - EVEN IF THE AUTHORS OR ANY OF THE ABOVE PARTIES HAVE BEEN ADVISED OF
 - THE POSSIBILITY OF SUCH DAMAGE.
 -
 - THE AUTHOR AND ROADNARROWS LLC SPECIFICALLY DISCLAIM ANY WARRANTIES,
 - INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 - FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN
 - "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO
 - PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 -
-->
<netmsgs encoding="itv" endian="big">
  
  <!-- ........................................................................
    - Meta Data to Tweak Source Generation
    ....................................................................... -->
  <meta>
    <brief>
BotSense client application - bsProxy server-terminated core messages.
    </brief>
    <ns>BsProxy</ns>
    <prologue lang="h">
#include "botsense/BotSense.h"
    </prologue>
    <epilogue lang="h" />
    <prologue lang="c" />
    <epilogue lang="c" />
    <prologue lang="python">
from BotSense.BotSenseCore import BSPROXY_VCONN_CLIENT_MAX
    </prologue>
    <epilogue lang="python" />
  </meta>

  <!-- ........................................................................
    - Extended Field Types (Optional)
    ....................................................................... -->
  <field_types>
  </field_types>

   <!-- ........................................................................
    - Message Definitions
    ....................................................................... -->
  <msg_types>
  
    <!-- Common Ok Response (available for server and all modules) -->
    <msgdef msgid="RspOk" />
  
    <!-- Common Error Response (available for server and all modules) -->
    <msgdef msgid="RspErr">
      <fielddef fname="ecode" ftype="u8" />
      <fielddef fname="emsg"  ftype="string" />
    </msgdef>
  
    <!-- Loopback Request (server) -->
    <msgdef msgid="ReqLoopback">
      <fielddef fname="cdata" ftype="string" />
    </msgdef>
  
    <!-- Loopback Response -->
    <msgdef msgid="RspLoopback">
      <fielddef fname="cdata" ftype="string" />
    </msgdef>
  
    <!-- Set Logging Level Request (server) -->
    <msgdef msgid="ReqSetLogging">
      <fielddef fname="level" ftype="s32" />
    </msgdef>
  
    <!-- Get Server Version Request (server) -->
    <msgdef msgid="ReqGetVersion" />
  
    <!-- Get Server Version Response -->
    <msgdef msgid="RspGetVersion">
      <fielddef fname="version" ftype="string" />
    </msgdef>
  
    <!-- Enable/Disable Message Tracing Request (server and module) -->
    <msgdef msgid="ReqMsgTrace">
      <fielddef fname="vconn" ftype="u8" />
      <fielddef fname="trace" ftype="bool" />
    </msgdef>
  
    <!-- Open Proxied Device (server and module) -->
    <msgdef msgid="ReqDevOpen">
      <fielddef fname="trace"   ftype="bool" />
      <fielddef fname="devname" ftype="string" />
      <fielddef fname="modname" ftype="string" />
      <fielddef fname="argbuf"  ftype="u8[]" />
    </msgdef>
  
    <!-- Open Proxied Device Response -->
    <msgdef msgid="RspDevOpen">
      <fielddef fname="vconn" ftype="u8" />
    </msgdef>
  
    <!-- Close Proxied Device (server and module) -->
    <msgdef msgid="ReqDevClose">
      <fielddef fname="vconn" ftype="u8" />
    </msgdef>
  
    <!-- Get Client's List of Virtual Connection Handles Request (server) -->
    <msgdef msgid="ReqGetVConnList" />
  
    <!-- Get Client's List of Virtual Connection Handles Response -->
    <msgdef msgid="RspGetVConnList">
      <fielddef fname="vconn" ftype="u8[]" size="BSPROXY_VCONN_CLIENT_MAX" />
    </msgdef>
  
    <!-- Get Client's Virtual Connection Info Request (server and module) -->
    <msgdef msgid="ReqGetVConnInfo">
      <fielddef fname="vconn" ftype="u8" />
    </msgdef>
  
    <!-- Get Client's Proxied Device-Module Info Response -->
    <msgdef msgid="RspGetVConnInfo">
      <fielddef fname="vconn"   ftype="u8" />
      <fielddef fname="rd"      ftype="s32" />
      <fielddef fname="client"  ftype="string" />
      <fielddef fname="devuri"  ftype="string" />
      <fielddef fname="moduri"  ftype="string" />
      <fielddef fname="modver"  ftype="string" />
      <fielddef fname="moddate" ftype="string" />
    </msgdef>
  
  </msg_types>

</netmsgs>