bsLibUtils.c File Reference

Library utilities. More...

#include <stdio.h>
#include <stdlib.h>
#include <libgen.h>
#include <string.h>
#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/netmsgs.h"
#include "botsense/BotSense.h"
#include "botsense/libBotSense.h"
#include "botsense/bsProxyMsgs.h"
#include "bsLibInternal.h"

Go to the source code of this file.

Functions
int	bsPackMsgHdr (BsProxyMsgHdr_T *pMsgHdr, byte_t buf[], size_t bufSize)
	Pack BotSense bsProxy message header. More...
int	bsUnpackMsgHdr (byte_t buf[], size_t bufSize, BsProxyMsgHdr_T *pMsgHdr)
	Unpack BotSense bsProxy message header. More...
void	bsLogBuf (const char *sBufName, byte_t buf[], size_t uCount)
	Log data bytes. More...
void	bsLogAsciiBuf (const char *sBufName, byte_t buf[], size_t uCount)
	Log ascii data bytes. More...

Detailed Description

Library utilities.

LastChangedDate

2010-08-20 11:36:38 -0600 (Fri, 20 Aug 2010)

Rev

568

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2009-2017. RoadNarrows LLC.
http://www.roadnarrows.com
All Rights Reserved

Definition in file bsLibUtils.c.

Function Documentation

void bsLogAsciiBuf	(	const char *	sBufName,
		byte_t	buf[],
		size_t	uCount
	)

Log ascii data bytes.

Print diagnostic logging of the contents of a buffer of ASCII bytes.

Parameters

sBufName	Name of buffer.
buf	Buffer.
uCount	Number of bytes to log.

Definition at line 175 of file bsLibUtils.c.

{
  FILE   *fp;   // log file pointer
  size_t  i;    // working index

  fp = LOG_GET_LOGFP();

  fprintf(fp, "%sDiag%d: %s=", LOG_PREFACE, LOG_GET_THRESHOLD()-1, sBufName);
  for(i=0; i<uCount; ++i)
  {
    if( isprint(buf[i]) || isspace(buf[i]) )
    {
      switch(buf[i])
      {
        case '\f':
          fprintf(fp, "\\f");
          break;
        case '\n':
          fprintf(fp, "\\n");
          break;
        case '\r':
          fprintf(fp, "\\r");
          break;
        case '\t':
          fprintf(fp, "\\t");
          break;
        case '\v':
          fprintf(fp, "\\v");
          break;
        default:
          fprintf(fp, "%c", buf[i]);
          break;
      }
    }
    else
    {
      fprintf(fp, "\\x%02x", buf[i]);
    }
  }
  fprintf(fp, "\n");
}

void bsLogBuf	(	const char *	sBufName,
		byte_t	buf[],
		size_t	uCount
	)

Log data bytes.

Print diagnostic logging of the contents of a buffer of bytes.

Parameters

sBufName	Name of buffer.
buf	Buffer.
uCount	Number of bytes to log.

Definition at line 145 of file bsLibUtils.c.

{
  FILE   *fp;   // log file pointer
  size_t  i;    // working index

  fp = LOG_GET_LOGFP();

  fprintf(fp, "%sDiag%d: %s=", LOG_PREFACE, LOG_GET_THRESHOLD()-1, sBufName);
  for(i=0; i<uCount; ++i)
  {
    if( (i % 16) == 0 )
    {
      fprintf(fp, "\n");
    }
    fprintf(fp, " 0x%02x", buf[i]);
  }
  fprintf(fp, "\n");
}

int bsPackMsgHdr	(	BsProxyMsgHdr_T *	pMsgHdr,
		byte_t	buf[],
		size_t	bufSize
	)

Pack BotSense bsProxy message header.

Parameters

[in]	pMsgHdr	Pointer to message header structure.
[out]	buf	Output message buffer.
	bufSize	Size of output buffer.

Returns

On success, returns the number of bytes packed.

On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 85 of file bsLibUtils.c.

References BS_ECODE_INTERNAL, BSPROXY_MSG_HDR_LEN, BsProxyMsgHdr_T::m_hdrBodyLen, BsProxyMsgHdr_T::m_hdrMagic, BsProxyMsgHdr_T::m_hdrMsgId, BsProxyMsgHdr_T::m_hdrTid, and BsProxyMsgHdr_T::m_hdrVConn.

{
  int   n = 0;

  if( bufSize < BSPROXY_MSG_HDR_LEN )
  {
    LOGERROR("Buffer size=%zu too small.", bufSize);
    return -BS_ECODE_INTERNAL;
  }

  n += nmPackU16(pMsgHdr->m_hdrMagic, buf+n, bufSize-(size_t)n, NMEndianBig);
  n += nmPackU8(pMsgHdr->m_hdrTid, buf+n, bufSize-(size_t)n, NMEndianBig);
  n += nmPackU8(pMsgHdr->m_hdrVConn, buf+n, bufSize-(size_t)n, NMEndianBig);
  n += nmPackU16(pMsgHdr->m_hdrMsgId, buf+n, bufSize-(size_t)n, NMEndianBig);
  n += nmPackU16(pMsgHdr->m_hdrBodyLen, buf+n, bufSize-(size_t)n, NMEndianBig);

  return n;
}

int bsUnpackMsgHdr	(	byte_t	buf[],
		size_t	bufSize,
		BsProxyMsgHdr_T *	pMsgHdr
	)

Unpack BotSense bsProxy message header.

Parameters

[in]	buf	Input message buffer.
	bufSize	Size of input buffer.
[out]	pMsgHdr	Pointer to message header structure.

Returns

On success, returns the number of bytes unpacked.

On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 115 of file bsLibUtils.c.

References BS_ECODE_INTERNAL, BSPROXY_MSG_HDR_LEN, BsProxyMsgHdr_T::m_hdrBodyLen, BsProxyMsgHdr_T::m_hdrMagic, BsProxyMsgHdr_T::m_hdrMsgId, BsProxyMsgHdr_T::m_hdrTid, and BsProxyMsgHdr_T::m_hdrVConn.

{
  int   n = 0;

  if( bufSize < BSPROXY_MSG_HDR_LEN )
  {
    LOGERROR("Buffer size=%zu too small.", bufSize);
    return -BS_ECODE_INTERNAL;
  }

  n += nmUnpackU16(buf+n, bufSize-(size_t)n, &pMsgHdr->m_hdrMagic, NMEndianBig);
  n += nmUnpackU8(buf+n,  bufSize-(size_t)n, &pMsgHdr->m_hdrTid, NMEndianBig);
  n += nmUnpackU8(buf+n,  bufSize-(size_t)n, &pMsgHdr->m_hdrVConn, NMEndianBig);
  n += nmUnpackU16(buf+n, bufSize-(size_t)n, &pMsgHdr->m_hdrMsgId, NMEndianBig);
  n += nmUnpackU16(buf+n, bufSize-(size_t)n, &pMsgHdr->m_hdrBodyLen,
                                                                  NMEndianBig);

  return n;
}