botsense  3.2.0
RoadNarrows Client-Server Proxied Services Framework
bsProxyMsgs.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: bsProxyMsgs.h
4 //
5 /*!
6  * \file
7  *
8  * \brief BotSense client application - bsProxy server-terminated core messages.
9  *
10  * \warning This file was auto-generated on 2018.08.10 13:54:22 from the NetMsgs
11  * XML specification bsProxyMsgs.xml.
12  *
13  * \par Copyright:
14  * (C) 2018. RoadNarrows LLC
15  * (http://www.roadnarrows.com)
16  * All Rights Reserved
17  */
18 ///////////////////////////////////////////////////////////////////////////////
19 
20 
21 #ifndef _BSPROXYMSGS_H
22 #define _BSPROXYMSGS_H
23 
24 #include "rnr/rnrconfig.h"
25 #include "rnr/netmsgs.h"
26 
27 #include "botsense/BotSense.h"
28 
29 
30 C_DECLS_BEGIN
31 
32 /*!
33  * BsProxy Message Id Enumeration
34  */
35 typedef enum
36 {
37  BsProxyMsgIdNone = 0, ///< no message
38  BsProxyMsgIdRspOk = 1, ///< RspOk
39  BsProxyMsgIdRspErr = 2, ///< RspErr
40  BsProxyMsgIdReqLoopback = 3, ///< ReqLoopback
41  BsProxyMsgIdRspLoopback = 4, ///< RspLoopback
42  BsProxyMsgIdReqSetLogging = 5, ///< ReqSetLogging
43  BsProxyMsgIdReqGetVersion = 6, ///< ReqGetVersion
44  BsProxyMsgIdRspGetVersion = 7, ///< RspGetVersion
45  BsProxyMsgIdReqMsgTrace = 8, ///< ReqMsgTrace
46  BsProxyMsgIdReqDevOpen = 9, ///< ReqDevOpen
47  BsProxyMsgIdRspDevOpen = 10, ///< RspDevOpen
48  BsProxyMsgIdReqDevClose = 11, ///< ReqDevClose
49  BsProxyMsgIdReqGetVConnList = 12, ///< ReqGetVConnList
50  BsProxyMsgIdRspGetVConnList = 13, ///< RspGetVConnList
51  BsProxyMsgIdReqGetVConnInfo = 14, ///< ReqGetVConnInfo
52  BsProxyMsgIdRspGetVConnInfo = 15, ///< RspGetVConnInfo
53  BsProxyMsgIdNumOf = 16 ///< number of message ids
55 
56 
57 //-----------------------------------------------------------------------------
58 // Message Types
59 //-----------------------------------------------------------------------------
60 
61 
62 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
63 // Message BsProxyRspErr Declarations
64 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
65 
66 /*! RspErr emsg maximum string length */
67 #define BSPROXY_RSPERR_EMSG_LEN (NMFVAL_LEN_MAX_STRING)
68 
69 /*!
70  * Message RspErr Structure
71  */
72 typedef struct
73 {
74  byte_t m_ecode; ///< ecode
75  char m_emsg[BSPROXY_RSPERR_EMSG_LEN+1];
76  ///< emsg
77 } BsProxyRspErr_T; ///< RspErr structure
78 
79 
80 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
81 // Message BsProxyReqLoopback Declarations
82 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
83 
84 /*! ReqLoopback cdata maximum string length */
85 #define BSPROXY_REQLOOPBACK_CDATA_LEN (NMFVAL_LEN_MAX_STRING)
86 
87 /*!
88  * Message ReqLoopback Structure
89  */
90 typedef struct
91 {
93  ///< cdata
94 } BsProxyReqLoopback_T; ///< ReqLoopback structure
95 
96 
97 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
98 // Message BsProxyRspLoopback Declarations
99 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
100 
101 /*! RspLoopback cdata maximum string length */
102 #define BSPROXY_RSPLOOPBACK_CDATA_LEN (NMFVAL_LEN_MAX_STRING)
103 
104 /*!
105  * Message RspLoopback Structure
106  */
107 typedef struct
108 {
110  ///< cdata
111 } BsProxyRspLoopback_T; ///< RspLoopback structure
112 
113 
114 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
115 // Message BsProxyReqSetLogging Declarations
116 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
117 
118 /*!
119  * Message ReqSetLogging Structure
120  */
121 typedef struct
122 {
123  int m_level; ///< level
124 } BsProxyReqSetLogging_T; ///< ReqSetLogging structure
125 
126 
127 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
128 // Message BsProxyRspGetVersion Declarations
129 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
130 
131 /*! RspGetVersion version maximum string length */
132 #define BSPROXY_RSPGETVERSION_VERSION_LEN (NMFVAL_LEN_MAX_STRING)
133 
134 /*!
135  * Message RspGetVersion Structure
136  */
137 typedef struct
138 {
140  ///< version
141 } BsProxyRspGetVersion_T; ///< RspGetVersion structure
142 
143 
144 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
145 // Message BsProxyReqMsgTrace Declarations
146 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
147 
148 /*!
149  * Message ReqMsgTrace Structure
150  */
151 typedef struct
152 {
153  byte_t m_vconn; ///< vconn
154  bool_t m_trace; ///< trace
155 } BsProxyReqMsgTrace_T; ///< ReqMsgTrace structure
156 
157 
158 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
159 // Message BsProxyReqDevOpen Declarations
160 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
161 
162 /*! ReqDevOpen devname maximum string length */
163 #define BSPROXY_REQDEVOPEN_DEVNAME_LEN (NMFVAL_LEN_MAX_STRING)
164 
165 /*! ReqDevOpen modname maximum string length */
166 #define BSPROXY_REQDEVOPEN_MODNAME_LEN (NMFVAL_LEN_MAX_STRING)
167 
168 /*! ReqDevOpen argbuf maximum vector length */
169 #define BSPROXY_REQDEVOPEN_ARGBUF_LEN (NMFVAL_LEN_MAX_VECTOR)
170 
171 /*!
172  * Message ReqDevOpen Structure
173  */
174 typedef struct
175 {
176  bool_t m_trace; ///< trace
178  ///< devname
180  ///< modname
181  struct
182  {
183  size_t m_count; ///< vector item count
184  union
185  {
186  void *m_pAlign; ///< force alignment
188  ///< the item vector
189  } u; ///< aligned vector items
190  } m_argbuf; ///< vector
191 } BsProxyReqDevOpen_T; ///< ReqDevOpen structure
192 
193 
194 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
195 // Message BsProxyRspDevOpen Declarations
196 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
197 
198 /*!
199  * Message RspDevOpen Structure
200  */
201 typedef struct
202 {
203  byte_t m_vconn; ///< vconn
204 } BsProxyRspDevOpen_T; ///< RspDevOpen structure
205 
206 
207 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
208 // Message BsProxyReqDevClose Declarations
209 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
210 
211 /*!
212  * Message ReqDevClose Structure
213  */
214 typedef struct
215 {
216  byte_t m_vconn; ///< vconn
217 } BsProxyReqDevClose_T; ///< ReqDevClose structure
218 
219 
220 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
221 // Message BsProxyRspGetVConnList Declarations
222 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
223 
224 /*!
225  * Message RspGetVConnList Structure
226  */
227 typedef struct
228 {
229  struct
230  {
231  size_t m_count; ///< vector item count
232  union
233  {
234  void *m_pAlign; ///< force alignment
236  ///< the item vector
237  } u; ///< aligned vector items
238  } m_vconn; ///< vector
239 } BsProxyRspGetVConnList_T; ///< RspGetVConnList structure
240 
241 
242 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
243 // Message BsProxyReqGetVConnInfo Declarations
244 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
245 
246 /*!
247  * Message ReqGetVConnInfo Structure
248  */
249 typedef struct
250 {
251  byte_t m_vconn; ///< vconn
252 } BsProxyReqGetVConnInfo_T; ///< ReqGetVConnInfo structure
253 
254 
255 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
256 // Message BsProxyRspGetVConnInfo Declarations
257 // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
258 
259 /*! RspGetVConnInfo client maximum string length */
260 #define BSPROXY_RSPGETVCONNINFO_CLIENT_LEN (NMFVAL_LEN_MAX_STRING)
261 
262 /*! RspGetVConnInfo devuri maximum string length */
263 #define BSPROXY_RSPGETVCONNINFO_DEVURI_LEN (NMFVAL_LEN_MAX_STRING)
264 
265 /*! RspGetVConnInfo moduri maximum string length */
266 #define BSPROXY_RSPGETVCONNINFO_MODURI_LEN (NMFVAL_LEN_MAX_STRING)
267 
268 /*! RspGetVConnInfo modver maximum string length */
269 #define BSPROXY_RSPGETVCONNINFO_MODVER_LEN (NMFVAL_LEN_MAX_STRING)
270 
271 /*! RspGetVConnInfo moddate maximum string length */
272 #define BSPROXY_RSPGETVCONNINFO_MODDATE_LEN (NMFVAL_LEN_MAX_STRING)
273 
274 /*!
275  * Message RspGetVConnInfo Structure
276  */
277 typedef struct
278 {
279  byte_t m_vconn; ///< vconn
280  int m_rd; ///< rd
282  ///< client
284  ///< devuri
286  ///< moduri
288  ///< modver
290  ///< moddate
291 } BsProxyRspGetVConnInfo_T; ///< RspGetVConnInfo structure
292 
293 
294 //-----------------------------------------------------------------------------
295 // External Data
296 //-----------------------------------------------------------------------------
297 
298 //
299 // BsProxy Message Definition Look-Up Table.
300 // (indexed by BsProxyMsgId_T enum)
301 //
302 extern const NMMsgDef_T *BsProxyMsgDefLookupTbl[];
303 
304 //
305 // BsProxy Maximum Message Body Length (bytes) Look-Up Table.
306 // (indexed by BsProxyMsgId_T enum)
307 //
308 extern size_t BsProxyMsgMaxLenLookupTbl[];
309 
310 
311 //-----------------------------------------------------------------------------
312 // Function Prototypes
313 //-----------------------------------------------------------------------------
314 
315 extern const NMMsgDef_T * BsProxyLookupMsgDef( BsProxyMsgId_T eMsgId );
316 
317 extern size_t BsProxyLookupMsgMaxLen( BsProxyMsgId_T eMsgId );
318 
319 extern int BsProxyPackMsg( BsProxyMsgId_T eMsgId,
320  void * pStruct,
321  byte_t buf[],
322  size_t bufSize,
323  bool_t bTrace );
324 
325 extern int BsProxyUnpackMsg( BsProxyMsgId_T eMsgId,
326  byte_t buf[],
327  size_t uMsgLen,
328  void * pStruct,
329  bool_t bTrace );
330 
331 /*!
332  * \brief Pack a BsProxyRspErr ITV message in big-endian byte order
333  * into the output buffer.
334  *
335  * \param [in] pStruct Pointer to the associated, populated message
336  * structure.
337  * \param [out] buf Output message buffer.
338  * \param bufSize Size of output buffer.
339  * \param bTrace Do [not] trace packing.
340  *
341  * \return
342  * On success, returns the number of bytes packed.
343  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
344  */
345 INLINE_IN_H int BsProxyPackRspErr( BsProxyRspErr_T * pStruct,
346  byte_t buf[],
347  size_t bufSize,
348  bool_t bTrace )
349 {
350  return BsProxyPackMsg(BsProxyMsgIdRspErr, pStruct, buf, bufSize, bTrace);
351 }
352 
353 /*!
354  * \brief Unpack a BsProxyRspErr ITV message in big-endian byte order
355  * from the input buffer.
356  *
357  * \param [in] buf Output message buffer.
358  * \param uMsgLen Length of message (bytes) in input buffer.
359  * \param [out] pStruct Pointer to the associated message structure.
360  * \param bTrace Do [not] trace packing.
361  *
362  * \return
363  * On success, returns the number of bytes unpacked.
364  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
365  */
366 INLINE_IN_H int BsProxyUnpackRspErr( byte_t buf[],
367  size_t uMsgLen,
368  BsProxyRspErr_T * pStruct,
369  bool_t bTrace )
370 {
371  return BsProxyUnpackMsg(BsProxyMsgIdRspErr, buf, uMsgLen, pStruct, bTrace);
372 }
373 
374 /*!
375  * \brief Pack a BsProxyReqLoopback ITV message in big-endian byte order
376  * into the output buffer.
377  *
378  * \param [in] pStruct Pointer to the associated, populated message
379  * structure.
380  * \param [out] buf Output message buffer.
381  * \param bufSize Size of output buffer.
382  * \param bTrace Do [not] trace packing.
383  *
384  * \return
385  * On success, returns the number of bytes packed.
386  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
387  */
388 INLINE_IN_H int BsProxyPackReqLoopback( BsProxyReqLoopback_T * pStruct,
389  byte_t buf[],
390  size_t bufSize,
391  bool_t bTrace )
392 {
393  return BsProxyPackMsg(BsProxyMsgIdReqLoopback, pStruct, buf, bufSize, bTrace);
394 }
395 
396 /*!
397  * \brief Unpack a BsProxyReqLoopback ITV message in big-endian byte order
398  * from the input buffer.
399  *
400  * \param [in] buf Output message buffer.
401  * \param uMsgLen Length of message (bytes) in input buffer.
402  * \param [out] pStruct Pointer to the associated message structure.
403  * \param bTrace Do [not] trace packing.
404  *
405  * \return
406  * On success, returns the number of bytes unpacked.
407  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
408  */
409 INLINE_IN_H int BsProxyUnpackReqLoopback( byte_t buf[],
410  size_t uMsgLen,
411  BsProxyReqLoopback_T * pStruct,
412  bool_t bTrace )
413 {
414  return BsProxyUnpackMsg(BsProxyMsgIdReqLoopback, buf, uMsgLen, pStruct, bTrace);
415 }
416 
417 /*!
418  * \brief Pack a BsProxyRspLoopback ITV message in big-endian byte order
419  * into the output buffer.
420  *
421  * \param [in] pStruct Pointer to the associated, populated message
422  * structure.
423  * \param [out] buf Output message buffer.
424  * \param bufSize Size of output buffer.
425  * \param bTrace Do [not] trace packing.
426  *
427  * \return
428  * On success, returns the number of bytes packed.
429  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
430  */
431 INLINE_IN_H int BsProxyPackRspLoopback( BsProxyRspLoopback_T * pStruct,
432  byte_t buf[],
433  size_t bufSize,
434  bool_t bTrace )
435 {
436  return BsProxyPackMsg(BsProxyMsgIdRspLoopback, pStruct, buf, bufSize, bTrace);
437 }
438 
439 /*!
440  * \brief Unpack a BsProxyRspLoopback ITV message in big-endian byte order
441  * from the input buffer.
442  *
443  * \param [in] buf Output message buffer.
444  * \param uMsgLen Length of message (bytes) in input buffer.
445  * \param [out] pStruct Pointer to the associated message structure.
446  * \param bTrace Do [not] trace packing.
447  *
448  * \return
449  * On success, returns the number of bytes unpacked.
450  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
451  */
452 INLINE_IN_H int BsProxyUnpackRspLoopback( byte_t buf[],
453  size_t uMsgLen,
454  BsProxyRspLoopback_T * pStruct,
455  bool_t bTrace )
456 {
457  return BsProxyUnpackMsg(BsProxyMsgIdRspLoopback, buf, uMsgLen, pStruct, bTrace);
458 }
459 
460 /*!
461  * \brief Pack a BsProxyReqSetLogging ITV message in big-endian byte order
462  * into the output buffer.
463  *
464  * \param [in] pStruct Pointer to the associated, populated message
465  * structure.
466  * \param [out] buf Output message buffer.
467  * \param bufSize Size of output buffer.
468  * \param bTrace Do [not] trace packing.
469  *
470  * \return
471  * On success, returns the number of bytes packed.
472  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
473  */
475  byte_t buf[],
476  size_t bufSize,
477  bool_t bTrace )
478 {
479  return BsProxyPackMsg(BsProxyMsgIdReqSetLogging, pStruct, buf, bufSize, bTrace);
480 }
481 
482 /*!
483  * \brief Unpack a BsProxyReqSetLogging ITV message in big-endian byte order
484  * from the input buffer.
485  *
486  * \param [in] buf Output message buffer.
487  * \param uMsgLen Length of message (bytes) in input buffer.
488  * \param [out] pStruct Pointer to the associated message structure.
489  * \param bTrace Do [not] trace packing.
490  *
491  * \return
492  * On success, returns the number of bytes unpacked.
493  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
494  */
495 INLINE_IN_H int BsProxyUnpackReqSetLogging( byte_t buf[],
496  size_t uMsgLen,
497  BsProxyReqSetLogging_T * pStruct,
498  bool_t bTrace )
499 {
500  return BsProxyUnpackMsg(BsProxyMsgIdReqSetLogging, buf, uMsgLen, pStruct, bTrace);
501 }
502 
503 /*!
504  * \brief Pack a BsProxyRspGetVersion ITV message in big-endian byte order
505  * into the output buffer.
506  *
507  * \param [in] pStruct Pointer to the associated, populated message
508  * structure.
509  * \param [out] buf Output message buffer.
510  * \param bufSize Size of output buffer.
511  * \param bTrace Do [not] trace packing.
512  *
513  * \return
514  * On success, returns the number of bytes packed.
515  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
516  */
518  byte_t buf[],
519  size_t bufSize,
520  bool_t bTrace )
521 {
522  return BsProxyPackMsg(BsProxyMsgIdRspGetVersion, pStruct, buf, bufSize, bTrace);
523 }
524 
525 /*!
526  * \brief Unpack a BsProxyRspGetVersion ITV message in big-endian byte order
527  * from the input buffer.
528  *
529  * \param [in] buf Output message buffer.
530  * \param uMsgLen Length of message (bytes) in input buffer.
531  * \param [out] pStruct Pointer to the associated message structure.
532  * \param bTrace Do [not] trace packing.
533  *
534  * \return
535  * On success, returns the number of bytes unpacked.
536  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
537  */
538 INLINE_IN_H int BsProxyUnpackRspGetVersion( byte_t buf[],
539  size_t uMsgLen,
540  BsProxyRspGetVersion_T * pStruct,
541  bool_t bTrace )
542 {
543  return BsProxyUnpackMsg(BsProxyMsgIdRspGetVersion, buf, uMsgLen, pStruct, bTrace);
544 }
545 
546 /*!
547  * \brief Pack a BsProxyReqMsgTrace ITV message in big-endian byte order
548  * into the output buffer.
549  *
550  * \param [in] pStruct Pointer to the associated, populated message
551  * structure.
552  * \param [out] buf Output message buffer.
553  * \param bufSize Size of output buffer.
554  * \param bTrace Do [not] trace packing.
555  *
556  * \return
557  * On success, returns the number of bytes packed.
558  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
559  */
560 INLINE_IN_H int BsProxyPackReqMsgTrace( BsProxyReqMsgTrace_T * pStruct,
561  byte_t buf[],
562  size_t bufSize,
563  bool_t bTrace )
564 {
565  return BsProxyPackMsg(BsProxyMsgIdReqMsgTrace, pStruct, buf, bufSize, bTrace);
566 }
567 
568 /*!
569  * \brief Unpack a BsProxyReqMsgTrace ITV message in big-endian byte order
570  * from the input buffer.
571  *
572  * \param [in] buf Output message buffer.
573  * \param uMsgLen Length of message (bytes) in input buffer.
574  * \param [out] pStruct Pointer to the associated message structure.
575  * \param bTrace Do [not] trace packing.
576  *
577  * \return
578  * On success, returns the number of bytes unpacked.
579  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
580  */
581 INLINE_IN_H int BsProxyUnpackReqMsgTrace( byte_t buf[],
582  size_t uMsgLen,
583  BsProxyReqMsgTrace_T * pStruct,
584  bool_t bTrace )
585 {
586  return BsProxyUnpackMsg(BsProxyMsgIdReqMsgTrace, buf, uMsgLen, pStruct, bTrace);
587 }
588 
589 /*!
590  * \brief Pack a BsProxyReqDevOpen ITV message in big-endian byte order
591  * into the output buffer.
592  *
593  * \param [in] pStruct Pointer to the associated, populated message
594  * structure.
595  * \param [out] buf Output message buffer.
596  * \param bufSize Size of output buffer.
597  * \param bTrace Do [not] trace packing.
598  *
599  * \return
600  * On success, returns the number of bytes packed.
601  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
602  */
603 INLINE_IN_H int BsProxyPackReqDevOpen( BsProxyReqDevOpen_T * pStruct,
604  byte_t buf[],
605  size_t bufSize,
606  bool_t bTrace )
607 {
608  return BsProxyPackMsg(BsProxyMsgIdReqDevOpen, pStruct, buf, bufSize, bTrace);
609 }
610 
611 /*!
612  * \brief Unpack a BsProxyReqDevOpen ITV message in big-endian byte order
613  * from the input buffer.
614  *
615  * \param [in] buf Output message buffer.
616  * \param uMsgLen Length of message (bytes) in input buffer.
617  * \param [out] pStruct Pointer to the associated message structure.
618  * \param bTrace Do [not] trace packing.
619  *
620  * \return
621  * On success, returns the number of bytes unpacked.
622  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
623  */
624 INLINE_IN_H int BsProxyUnpackReqDevOpen( byte_t buf[],
625  size_t uMsgLen,
626  BsProxyReqDevOpen_T * pStruct,
627  bool_t bTrace )
628 {
629  return BsProxyUnpackMsg(BsProxyMsgIdReqDevOpen, buf, uMsgLen, pStruct, bTrace);
630 }
631 
632 /*!
633  * \brief Pack a BsProxyRspDevOpen ITV message in big-endian byte order
634  * into the output buffer.
635  *
636  * \param [in] pStruct Pointer to the associated, populated message
637  * structure.
638  * \param [out] buf Output message buffer.
639  * \param bufSize Size of output buffer.
640  * \param bTrace Do [not] trace packing.
641  *
642  * \return
643  * On success, returns the number of bytes packed.
644  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
645  */
646 INLINE_IN_H int BsProxyPackRspDevOpen( BsProxyRspDevOpen_T * pStruct,
647  byte_t buf[],
648  size_t bufSize,
649  bool_t bTrace )
650 {
651  return BsProxyPackMsg(BsProxyMsgIdRspDevOpen, pStruct, buf, bufSize, bTrace);
652 }
653 
654 /*!
655  * \brief Unpack a BsProxyRspDevOpen ITV message in big-endian byte order
656  * from the input buffer.
657  *
658  * \param [in] buf Output message buffer.
659  * \param uMsgLen Length of message (bytes) in input buffer.
660  * \param [out] pStruct Pointer to the associated message structure.
661  * \param bTrace Do [not] trace packing.
662  *
663  * \return
664  * On success, returns the number of bytes unpacked.
665  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
666  */
667 INLINE_IN_H int BsProxyUnpackRspDevOpen( byte_t buf[],
668  size_t uMsgLen,
669  BsProxyRspDevOpen_T * pStruct,
670  bool_t bTrace )
671 {
672  return BsProxyUnpackMsg(BsProxyMsgIdRspDevOpen, buf, uMsgLen, pStruct, bTrace);
673 }
674 
675 /*!
676  * \brief Pack a BsProxyReqDevClose ITV message in big-endian byte order
677  * into the output buffer.
678  *
679  * \param [in] pStruct Pointer to the associated, populated message
680  * structure.
681  * \param [out] buf Output message buffer.
682  * \param bufSize Size of output buffer.
683  * \param bTrace Do [not] trace packing.
684  *
685  * \return
686  * On success, returns the number of bytes packed.
687  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
688  */
689 INLINE_IN_H int BsProxyPackReqDevClose( BsProxyReqDevClose_T * pStruct,
690  byte_t buf[],
691  size_t bufSize,
692  bool_t bTrace )
693 {
694  return BsProxyPackMsg(BsProxyMsgIdReqDevClose, pStruct, buf, bufSize, bTrace);
695 }
696 
697 /*!
698  * \brief Unpack a BsProxyReqDevClose ITV message in big-endian byte order
699  * from the input buffer.
700  *
701  * \param [in] buf Output message buffer.
702  * \param uMsgLen Length of message (bytes) in input buffer.
703  * \param [out] pStruct Pointer to the associated message structure.
704  * \param bTrace Do [not] trace packing.
705  *
706  * \return
707  * On success, returns the number of bytes unpacked.
708  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
709  */
710 INLINE_IN_H int BsProxyUnpackReqDevClose( byte_t buf[],
711  size_t uMsgLen,
712  BsProxyReqDevClose_T * pStruct,
713  bool_t bTrace )
714 {
715  return BsProxyUnpackMsg(BsProxyMsgIdReqDevClose, buf, uMsgLen, pStruct, bTrace);
716 }
717 
718 /*!
719  * \brief Pack a BsProxyRspGetVConnList ITV message in big-endian byte order
720  * into the output buffer.
721  *
722  * \param [in] pStruct Pointer to the associated, populated message
723  * structure.
724  * \param [out] buf Output message buffer.
725  * \param bufSize Size of output buffer.
726  * \param bTrace Do [not] trace packing.
727  *
728  * \return
729  * On success, returns the number of bytes packed.
730  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
731  */
733  byte_t buf[],
734  size_t bufSize,
735  bool_t bTrace )
736 {
737  return BsProxyPackMsg(BsProxyMsgIdRspGetVConnList, pStruct, buf, bufSize, bTrace);
738 }
739 
740 /*!
741  * \brief Unpack a BsProxyRspGetVConnList ITV message in big-endian byte order
742  * from the input buffer.
743  *
744  * \param [in] buf Output message buffer.
745  * \param uMsgLen Length of message (bytes) in input buffer.
746  * \param [out] pStruct Pointer to the associated message structure.
747  * \param bTrace Do [not] trace packing.
748  *
749  * \return
750  * On success, returns the number of bytes unpacked.
751  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
752  */
753 INLINE_IN_H int BsProxyUnpackRspGetVConnList( byte_t buf[],
754  size_t uMsgLen,
755  BsProxyRspGetVConnList_T * pStruct,
756  bool_t bTrace )
757 {
758  return BsProxyUnpackMsg(BsProxyMsgIdRspGetVConnList, buf, uMsgLen, pStruct, bTrace);
759 }
760 
761 /*!
762  * \brief Pack a BsProxyReqGetVConnInfo ITV message in big-endian byte order
763  * into the output buffer.
764  *
765  * \param [in] pStruct Pointer to the associated, populated message
766  * structure.
767  * \param [out] buf Output message buffer.
768  * \param bufSize Size of output buffer.
769  * \param bTrace Do [not] trace packing.
770  *
771  * \return
772  * On success, returns the number of bytes packed.
773  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
774  */
776  byte_t buf[],
777  size_t bufSize,
778  bool_t bTrace )
779 {
780  return BsProxyPackMsg(BsProxyMsgIdReqGetVConnInfo, pStruct, buf, bufSize, bTrace);
781 }
782 
783 /*!
784  * \brief Unpack a BsProxyReqGetVConnInfo ITV message in big-endian byte order
785  * from the input buffer.
786  *
787  * \param [in] buf Output message buffer.
788  * \param uMsgLen Length of message (bytes) in input buffer.
789  * \param [out] pStruct Pointer to the associated message structure.
790  * \param bTrace Do [not] trace packing.
791  *
792  * \return
793  * On success, returns the number of bytes unpacked.
794  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
795  */
796 INLINE_IN_H int BsProxyUnpackReqGetVConnInfo( byte_t buf[],
797  size_t uMsgLen,
798  BsProxyReqGetVConnInfo_T * pStruct,
799  bool_t bTrace )
800 {
801  return BsProxyUnpackMsg(BsProxyMsgIdReqGetVConnInfo, buf, uMsgLen, pStruct, bTrace);
802 }
803 
804 /*!
805  * \brief Pack a BsProxyRspGetVConnInfo ITV message in big-endian byte order
806  * into the output buffer.
807  *
808  * \param [in] pStruct Pointer to the associated, populated message
809  * structure.
810  * \param [out] buf Output message buffer.
811  * \param bufSize Size of output buffer.
812  * \param bTrace Do [not] trace packing.
813  *
814  * \return
815  * On success, returns the number of bytes packed.
816  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
817  */
819  byte_t buf[],
820  size_t bufSize,
821  bool_t bTrace )
822 {
823  return BsProxyPackMsg(BsProxyMsgIdRspGetVConnInfo, pStruct, buf, bufSize, bTrace);
824 }
825 
826 /*!
827  * \brief Unpack a BsProxyRspGetVConnInfo ITV message in big-endian byte order
828  * from the input buffer.
829  *
830  * \param [in] buf Output message buffer.
831  * \param uMsgLen Length of message (bytes) in input buffer.
832  * \param [out] pStruct Pointer to the associated message structure.
833  * \param bTrace Do [not] trace packing.
834  *
835  * \return
836  * On success, returns the number of bytes unpacked.
837  * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
838  */
839 INLINE_IN_H int BsProxyUnpackRspGetVConnInfo( byte_t buf[],
840  size_t uMsgLen,
841  BsProxyRspGetVConnInfo_T * pStruct,
842  bool_t bTrace )
843 {
844  return BsProxyUnpackMsg(BsProxyMsgIdRspGetVConnInfo, buf, uMsgLen, pStruct, bTrace);
845 }
846 
847 
848 C_DECLS_END
849 
850 
851 #endif // _BSPROXYMSGS_H
#define BSPROXY_RSPGETVCONNINFO_MODURI_LEN
Definition: bsProxyMsgs.h:266
INLINE_IN_H int BsProxyUnpackReqSetLogging(byte_t buf[], size_t uMsgLen, BsProxyReqSetLogging_T *pStruct, bool_t bTrace)
Unpack a BsProxyReqSetLogging ITV message in big-endian byte order from the input buffer...
Definition: bsProxyMsgs.h:495
const NMMsgDef_T * BsProxyLookupMsgDef(BsProxyMsgId_T eMsgId)
Look up the message definition associated with the message id.
Definition: bsProxyMsgs.c:874
#define BSPROXY_REQDEVOPEN_MODNAME_LEN
Definition: bsProxyMsgs.h:166
INLINE_IN_H int BsProxyUnpackReqMsgTrace(byte_t buf[], size_t uMsgLen, BsProxyReqMsgTrace_T *pStruct, bool_t bTrace)
Unpack a BsProxyReqMsgTrace ITV message in big-endian byte order from the input buffer.
Definition: bsProxyMsgs.h:581
#define BSPROXY_RSPGETVCONNINFO_CLIENT_LEN
Definition: bsProxyMsgs.h:260
void * m_pAlign
force alignment
Definition: bsProxyMsgs.h:186
INLINE_IN_H int BsProxyPackReqLoopback(BsProxyReqLoopback_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a BsProxyReqLoopback ITV message in big-endian byte order into the output buffer.
Definition: bsProxyMsgs.h:388
INLINE_IN_H int BsProxyPackReqDevClose(BsProxyReqDevClose_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a BsProxyReqDevClose ITV message in big-endian byte order into the output buffer.
Definition: bsProxyMsgs.h:689
bool_t m_trace
trace
Definition: bsProxyMsgs.h:154
INLINE_IN_H int BsProxyPackRspLoopback(BsProxyRspLoopback_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a BsProxyRspLoopback ITV message in big-endian byte order into the output buffer.
Definition: bsProxyMsgs.h:431
#define BSPROXY_RSPGETVERSION_VERSION_LEN
Definition: bsProxyMsgs.h:132
INLINE_IN_H int BsProxyPackReqGetVConnInfo(BsProxyReqGetVConnInfo_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a BsProxyReqGetVConnInfo ITV message in big-endian byte order into the output buffer...
Definition: bsProxyMsgs.h:775
INLINE_IN_H int BsProxyPackRspErr(BsProxyRspErr_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a BsProxyRspErr ITV message in big-endian byte order into the output buffer. ...
Definition: bsProxyMsgs.h:345
INLINE_IN_H int BsProxyUnpackReqLoopback(byte_t buf[], size_t uMsgLen, BsProxyReqLoopback_T *pStruct, bool_t bTrace)
Unpack a BsProxyReqLoopback ITV message in big-endian byte order from the input buffer.
Definition: bsProxyMsgs.h:409
ReqGetVConnInfo.
Definition: bsProxyMsgs.h:51
no message
Definition: bsProxyMsgs.h:37
bool_t m_trace
trace
Definition: bsProxyMsgs.h:176
INLINE_IN_H int BsProxyUnpackRspGetVConnList(byte_t buf[], size_t uMsgLen, BsProxyRspGetVConnList_T *pStruct, bool_t bTrace)
Unpack a BsProxyRspGetVConnList ITV message in big-endian byte order from the input buffer...
Definition: bsProxyMsgs.h:753
INLINE_IN_H int BsProxyPackReqMsgTrace(BsProxyReqMsgTrace_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a BsProxyReqMsgTrace ITV message in big-endian byte order into the output buffer.
Definition: bsProxyMsgs.h:560
INLINE_IN_H int BsProxyPackRspDevOpen(BsProxyRspDevOpen_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a BsProxyRspDevOpen ITV message in big-endian byte order into the output buffer.
Definition: bsProxyMsgs.h:646
INLINE_IN_H int BsProxyUnpackRspErr(byte_t buf[], size_t uMsgLen, BsProxyRspErr_T *pStruct, bool_t bTrace)
Unpack a BsProxyRspErr ITV message in big-endian byte order from the input buffer.
Definition: bsProxyMsgs.h:366
INLINE_IN_H int BsProxyUnpackRspDevOpen(byte_t buf[], size_t uMsgLen, BsProxyRspDevOpen_T *pStruct, bool_t bTrace)
Unpack a BsProxyRspDevOpen ITV message in big-endian byte order from the input buffer.
Definition: bsProxyMsgs.h:667
RspGetVConnInfo.
Definition: bsProxyMsgs.h:52
INLINE_IN_H int BsProxyPackRspGetVConnInfo(BsProxyRspGetVConnInfo_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a BsProxyRspGetVConnInfo ITV message in big-endian byte order into the output buffer...
Definition: bsProxyMsgs.h:818
size_t BsProxyMsgMaxLenLookupTbl[]
Definition: bsProxyMsgs.c:838
size_t m_count
vector item count
Definition: bsProxyMsgs.h:183
INLINE_IN_H int BsProxyUnpackReqGetVConnInfo(byte_t buf[], size_t uMsgLen, BsProxyReqGetVConnInfo_T *pStruct, bool_t bTrace)
Unpack a BsProxyReqGetVConnInfo ITV message in big-endian byte order from the input buffer...
Definition: bsProxyMsgs.h:796
INLINE_IN_H int BsProxyPackReqSetLogging(BsProxyReqSetLogging_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a BsProxyReqSetLogging ITV message in big-endian byte order into the output buffer.
Definition: bsProxyMsgs.h:474
#define BSPROXY_RSPGETVCONNINFO_DEVURI_LEN
Definition: bsProxyMsgs.h:263
#define BSPROXY_REQDEVOPEN_DEVNAME_LEN
Definition: bsProxyMsgs.h:163
INLINE_IN_H int BsProxyUnpackReqDevOpen(byte_t buf[], size_t uMsgLen, BsProxyReqDevOpen_T *pStruct, bool_t bTrace)
Unpack a BsProxyReqDevOpen ITV message in big-endian byte order from the input buffer.
Definition: bsProxyMsgs.h:624
RspGetVConnList.
Definition: bsProxyMsgs.h:50
INLINE_IN_H int BsProxyUnpackRspGetVConnInfo(byte_t buf[], size_t uMsgLen, BsProxyRspGetVConnInfo_T *pStruct, bool_t bTrace)
Unpack a BsProxyRspGetVConnInfo ITV message in big-endian byte order from the input buffer...
Definition: bsProxyMsgs.h:839
ReqGetVConnList.
Definition: bsProxyMsgs.h:49
byte_t m_vconn
vconn
Definition: bsProxyMsgs.h:203
number of message ids
Definition: bsProxyMsgs.h:53
INLINE_IN_H int BsProxyPackRspGetVersion(BsProxyRspGetVersion_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a BsProxyRspGetVersion ITV message in big-endian byte order into the output buffer.
Definition: bsProxyMsgs.h:517
size_t BsProxyLookupMsgMaxLen(BsProxyMsgId_T eMsgId)
Look up the message maximum length associated with the message id.
Definition: bsProxyMsgs.c:898
void * m_pAlign
force alignment
Definition: bsProxyMsgs.h:234
const NMMsgDef_T * BsProxyMsgDefLookupTbl[]
Definition: bsProxyMsgs.c:814
size_t m_count
vector item count
Definition: bsProxyMsgs.h:231
INLINE_IN_H int BsProxyUnpackRspGetVersion(byte_t buf[], size_t uMsgLen, BsProxyRspGetVersion_T *pStruct, bool_t bTrace)
Unpack a BsProxyRspGetVersion ITV message in big-endian byte order from the input buffer...
Definition: bsProxyMsgs.h:538
BsProxyMsgId_T
Definition: bsProxyMsgs.h:35
int BsProxyUnpackMsg(BsProxyMsgId_T eMsgId, byte_t buf[], size_t uMsgLen, void *pStruct, bool_t bTrace)
Unpack a ITV message in big-endian byte order.
Definition: bsProxyMsgs.c:962
#define BSPROXY_RSPGETVCONNINFO_MODDATE_LEN
Definition: bsProxyMsgs.h:272
#define BSPROXY_VCONN_CLIENT_MAX
max number of virtual conn/client
Definition: BotSense.h:122
INLINE_IN_H int BsProxyUnpackRspLoopback(byte_t buf[], size_t uMsgLen, BsProxyRspLoopback_T *pStruct, bool_t bTrace)
Unpack a BsProxyRspLoopback ITV message in big-endian byte order from the input buffer.
Definition: bsProxyMsgs.h:452
INLINE_IN_H int BsProxyPackRspGetVConnList(BsProxyRspGetVConnList_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a BsProxyRspGetVConnList ITV message in big-endian byte order into the output buffer...
Definition: bsProxyMsgs.h:732
#define BSPROXY_RSPLOOPBACK_CDATA_LEN
Definition: bsProxyMsgs.h:102
byte_t m_ecode
ecode
Definition: bsProxyMsgs.h:74
#define BSPROXY_REQDEVOPEN_ARGBUF_LEN
Definition: bsProxyMsgs.h:169
byte_t m_vconn
vconn
Definition: bsProxyMsgs.h:153
int BsProxyPackMsg(BsProxyMsgId_T eMsgId, void *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a ITV message in big-endian byte order.
Definition: bsProxyMsgs.c:924
#define BSPROXY_REQLOOPBACK_CDATA_LEN
Definition: bsProxyMsgs.h:85
#define BSPROXY_RSPGETVCONNINFO_MODVER_LEN
Definition: bsProxyMsgs.h:269
byte_t m_vconn
vconn
Definition: bsProxyMsgs.h:216
INLINE_IN_H int BsProxyPackReqDevOpen(BsProxyReqDevOpen_T *pStruct, byte_t buf[], size_t bufSize, bool_t bTrace)
Pack a BsProxyReqDevOpen ITV message in big-endian byte order into the output buffer.
Definition: bsProxyMsgs.h:603
INLINE_IN_H int BsProxyUnpackReqDevClose(byte_t buf[], size_t uMsgLen, BsProxyReqDevClose_T *pStruct, bool_t bTrace)
Unpack a BsProxyReqDevClose ITV message in big-endian byte order from the input buffer.
Definition: bsProxyMsgs.h:710
<b><i>BotSense</i></b> package top-level, unifying header declarations.
#define BSPROXY_RSPERR_EMSG_LEN
Definition: bsProxyMsgs.h:67