bsNullMsgs.h

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: bsNullMsgs.h
//
/*!
 * \file
 *
 * \brief BotSense bsProxy server - client /dev/null NetMsgs XML Definition
 *
 * \warning This file was auto-generated on 2018.08.10 13:54:23 from the NetMsgs
 * XML specification bsNullMsgs.xml.
 *
 * \par Copyright:
 * (C) 2018. RoadNarrows LLC
 * (http://www.roadnarrows.com)
 * All Rights Reserved
 */
///////////////////////////////////////////////////////////////////////////////


#ifndef _BSNULLMSGS_H
#define _BSNULLMSGS_H

#include "rnr/rnrconfig.h"
#include "rnr/netmsgs.h"

#include "botsense/BotSense.h"


C_DECLS_BEGIN

/*!
 * BsNull Message Id Enumeration
 */
typedef enum
{
  BsNullMsgIdNone                       = 0,    ///< no message
  BsNullMsgIdReqWrite                   = 1,    ///< ReqWrite
  BsNullMsgIdRspWrite                   = 2,    ///< RspWrite
  BsNullMsgIdNumOf                      = 3     ///< number of message ids
} BsNullMsgId_T;


//-----------------------------------------------------------------------------
// Message Types
//-----------------------------------------------------------------------------


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsNullReqWrite Declarations
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*! ReqWrite writebuf maximum vector length */
#define BSNULL_REQWRITE_WRITEBUF_LEN (NMFVAL_LEN_MAX_VECTOR)

/*!
 * Message ReqWrite Structure
 */
typedef struct
{
  struct
  {
    size_t                m_count;            ///< vector item count
    union
    {
      void                *m_pAlign;          ///< force alignment
      byte_t              m_buf[BSNULL_REQWRITE_WRITEBUF_LEN];
                                              ///< the item vector
    } u; ///< aligned vector items
  } m_writebuf;                               ///< vector
} BsNullReqWrite_T;                           ///< ReqWrite structure


// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
// Message BsNullRspWrite Declarations
// . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

/*!
 * Message RspWrite Structure
 */
typedef struct
{
  byte_t                  m_byteswritten;     ///< byteswritten
} BsNullRspWrite_T;                           ///< RspWrite structure


//-----------------------------------------------------------------------------
// External Data
//-----------------------------------------------------------------------------

//
// BsNull Message Definition Look-Up Table.
// (indexed by BsNullMsgId_T enum)
// 
extern const NMMsgDef_T *BsNullMsgDefLookupTbl[];

//
// BsNull Maximum Message Body Length (bytes) Look-Up Table.
// (indexed by BsNullMsgId_T enum)
// 
extern size_t BsNullMsgMaxLenLookupTbl[];


//-----------------------------------------------------------------------------
// Function Prototypes
//-----------------------------------------------------------------------------

extern const NMMsgDef_T * BsNullLookupMsgDef( BsNullMsgId_T eMsgId );

extern size_t BsNullLookupMsgMaxLen( BsNullMsgId_T eMsgId );

extern int BsNullPackMsg( BsNullMsgId_T eMsgId,
                          void * pStruct,
                          byte_t buf[],
                          size_t bufSize,
                          bool_t bTrace );

extern int BsNullUnpackMsg( BsNullMsgId_T eMsgId,
                            byte_t buf[],
                            size_t uMsgLen,
                            void * pStruct,
                            bool_t bTrace );

/*!
 * \brief Pack a BsNullReqWrite ITV message in big-endian byte order
 *        into the output buffer.
 * 
 * \param [in] pStruct    Pointer to the associated, populated message
 *                        structure.
 * \param [out] buf       Output message buffer.
 * \param bufSize         Size of output buffer.
 * \param bTrace          Do [not] trace packing.
 * 
 * \return
 * On success, returns the number of bytes packed.
 * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsNullPackReqWrite( BsNullReqWrite_T * pStruct,
                                    byte_t buf[],
                                    size_t bufSize,
                                    bool_t bTrace )
{
  return BsNullPackMsg(BsNullMsgIdReqWrite, pStruct, buf, bufSize, bTrace);
}

/*!
 * \brief Unpack a BsNullReqWrite ITV message in big-endian byte order
 *        from the input buffer.
 * 
 * \param [in] buf        Output message buffer.
 * \param uMsgLen         Length of message (bytes) in input buffer.
 * \param [out] pStruct   Pointer to the associated message structure.
 * \param bTrace          Do [not] trace packing.
 * 
 * \return
 * On success, returns the number of bytes unpacked.
 * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsNullUnpackReqWrite( byte_t buf[],
                                      size_t uMsgLen,
                                      BsNullReqWrite_T * pStruct,
                                      bool_t bTrace )
{
  return BsNullUnpackMsg(BsNullMsgIdReqWrite, buf, uMsgLen, pStruct, bTrace);
}

/*!
 * \brief Pack a BsNullRspWrite ITV message in big-endian byte order
 *        into the output buffer.
 * 
 * \param [in] pStruct    Pointer to the associated, populated message
 *                        structure.
 * \param [out] buf       Output message buffer.
 * \param bufSize         Size of output buffer.
 * \param bTrace          Do [not] trace packing.
 * 
 * \return
 * On success, returns the number of bytes packed.
 * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsNullPackRspWrite( BsNullRspWrite_T * pStruct,
                                    byte_t buf[],
                                    size_t bufSize,
                                    bool_t bTrace )
{
  return BsNullPackMsg(BsNullMsgIdRspWrite, pStruct, buf, bufSize, bTrace);
}

/*!
 * \brief Unpack a BsNullRspWrite ITV message in big-endian byte order
 *        from the input buffer.
 * 
 * \param [in] buf        Output message buffer.
 * \param uMsgLen         Length of message (bytes) in input buffer.
 * \param [out] pStruct   Pointer to the associated message structure.
 * \param bTrace          Do [not] trace packing.
 * 
 * \return
 * On success, returns the number of bytes unpacked.
 * On error, returns the appropriate \h_lt 0 negated NM_ECODE.
 */
INLINE_IN_H int BsNullUnpackRspWrite( byte_t buf[],
                                      size_t uMsgLen,
                                      BsNullRspWrite_T * pStruct,
                                      bool_t bTrace )
{
  return BsNullUnpackMsg(BsNullMsgIdRspWrite, buf, uMsgLen, pStruct, bTrace);
}


C_DECLS_END


#endif // _BSNULLMSGS_H