nmExample.c File Reference

Example NetMsgs message packing/unpacking application. More...

#include <stdio.h>
#include <unistd.h>
#include <stdlib.h>
#include <libgen.h>
#include <string.h>
#include "rnr/rnrconfig.h"
#include "rnr/new.h"
#include "rnr/opts.h"
#include "rnr/log.h"
#include "rnr/netmsgs.h"
#include "nmExample.h"
#include "AstroMsgs.h"
#include "version.h"

Go to the source code of this file.

Macros
#define	APP_EC_OK   0
	success exit code
#define	APP_EC_USAGE   2
	usage error exit code
#define	APP_EC_EXEC   4
	execution error exit code
#define	MSG_NS   "Astro"
	message namespace
#define	CAT(a, b)   a ## b
	Concatenate two tokens. More...
#define	CAT3(a, b, c)   a ## b ## c
	Concatenate three tokens. More...
#define	PRCMP(mem, fmt)
	Print side-by-side comparision of prepacked tx and post-unpacked rx member. More...
#define	IDENTITY(xmlname, txmsg, rxmsg)
	Execute the pack, unpack identiy function. More...

Typedefs
typedef int(*	Packer_T) (void *, byte_t[], size_t, bool_t)
	packer type
typedef int(*	Unpacker_T) (byte_t[], size_t, void *, bool_t)
	unpacker type
typedef int(*	tstfunc_t) ()

Functions
static int	MainInit (int argc, char *argv[])
	Initialize simple_khr2 command. More...
int	Identity (const char *sXmlName, Packer_T fnPacker, void *pTxMsg, Unpacker_T fnUnpacker, void *pRxMsg)
	Execute the pack, unpack identiy function. More...
int	tstRspErr ()
	Test AstroRspMsg message packing and unpacking. More...
int	tstCmdZodiac ()
	Test CmdZodiac message packing and unpacking. More...
int	tstCmdUniverse ()
	Test CmdUniverse message packing and unpacking. More...
int	main (int argc, char *argv[])
	Simple NetMsg example main. More...

Variables
static char *	Argv0
	this command basename
static bool_t	OptsTrace = false
	do [not] trace packing/unpacking
static OptsPgmInfo_T	PgmInfo
	Program information. More...
static OptsInfo_T	OptsInfo []
	Command-line options information. More...
tstfunc_t	TstTbl []

Detailed Description

Example NetMsgs message packing/unpacking application.

LastChangedDate

2010-05-03 13:49:15 -0600 (Mon, 03 May 2010)

Rev

365

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

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

Definition in file nmExample.c.

Macro Definition Documentation

#define CAT	(		a,
			b
	)		a ## b

Concatenate two tokens.

Parameters

a	Token a.
b	Token b.

Definition at line 169 of file nmExample.c.

#define CAT3	(		a,
			b,
			c
	)		a ## b ## c

Concatenate three tokens.

Parameters

a	Token a.
b	Token b.
c	Token c.

Definition at line 177 of file nmExample.c.

#define IDENTITY	(		xmlname,
			txmsg,
			rxmsg
	)

Value:

Identity(#xmlname, (Packer_T)CAT3(Astro, Pack,   xmlname), &txmsg, \
                     (Unpacker_T)CAT3(Astro, Unpack, xmlname), &rxmsg)

Execute the pack, unpack identiy function.

Parameters

xmlname	XML name token
txmsg	Pre-packed, populated message structure.
rxmsg	Post-unacked, populated message structure.

Definition at line 209 of file nmExample.c.

Referenced by tstCmdUniverse(), tstCmdZodiac(), and tstRspErr().

#define PRCMP	(		mem,
			fmt
	)

Value:

do \
  { \
    int k; \
    k = fprintf(stderr, "%s: ", #mem); \
    if( k > 38 ) \
    { \
      fprintf(stderr, "\n"); \
      k = 0; \
    } \
    fprintf(stderr, "%*stx " fmt "\n", 40-k, "", txmsg.mem); \
    fprintf(stderr, "%*srx " fmt "\n\n", 40, "", rxmsg.mem); \
  } while(0)

Print side-by-side comparision of prepacked tx and post-unpacked rx member.

Note

Implicit use of txmsg and rxmst external variables.

Parameters

mem	Structure member of txmsg and rxmsg.
fmt	Member print format.

Definition at line 188 of file nmExample.c.

Referenced by tstCmdUniverse(), tstCmdZodiac(), and tstRspErr().

Typedef Documentation

typedef int(* tstfunc_t) ()

Test Function Type

Definition at line 248 of file nmExample.c.

Function Documentation

int Identity	(	const char *	sXmlName,
		Packer_T	fnPacker,
		void *	pTxMsg,
		Unpacker_T	fnUnpacker,
		void *	pRxMsg
	)

Execute the pack, unpack identiy function.

Parameters

sXmlName	XML name string
fnPacker	Packing function.
pTxMsg	Pointer to pre-packed, populated message structure.
fnUnpacker	Unpacking function.
pRxMsg	Pointer to post-unacked, message structure.

Returns

Number of bytes unpacked (== packed) on success.
< 0 on error.

Definition at line 227 of file nmExample.c.

References MSG_NS, and OptsTrace.

{
  byte_t        buf[2048];
  int           n;

  if( (n = fnPacker(pTxMsg, buf, sizeof(buf), OptsTrace)) < 0 )
  {
    LOGERROR("%s(ecode=%d): %sPack%s()", nmStrError(n), n, MSG_NS, sXmlName);
  }


  else if( (n = fnUnpacker(buf, (size_t)n, pRxMsg, OptsTrace)) < 0 )
  {
    LOGERROR("%s(ecode=%d): %sUnpack%s()", nmStrError(n), n, MSG_NS, sXmlName);
  }

  return n;
}

int main	(	int	argc,
		char *	argv[]
	)

Simple NetMsg example main.

Parameters

argc	Command-line argument count.
argv	Command-line argument list.

Exit Status:

Program exits with 0 success, > 0 on failure.

Definition at line 464 of file nmExample.c.

References APP_EC_EXEC, APP_EC_OK, MainInit(), NM_OK, and TstTbl.

{
  tstfunc_t   fnTst;
  int         i;
  int         n = NM_OK;

  // Initialize command.
  MainInit(argc, argv);

  for(i=0; (fnTst=TstTbl[i])!=NULL; ++i)
  {
    if( (n = fnTst()) < 0 )
    {
      break;
    }
  }

  return n>=0? APP_EC_OK: APP_EC_EXEC;
}

static int MainInit ( int  argc, char *  argv[]  )

static

Initialize simple_khr2 command.

Any command-line error immediately terminates application.

Parameters

argc	Command-line argument count.
argv	Command-line argument list.

Returns

Returns APP_EC_OK on success, >0 exit code on failure.

Definition at line 141 of file nmExample.c.

References APP_EC_OK, Argv0, OptsInfo, PgmInfo, and PkgInfo.

Referenced by main().

{
  // Name of this process.
  Argv0 = basename(argv[0]);

    // 
  // Parse input options.
  //
  argv = OptsGet(Argv0, &PkgInfo, &PgmInfo, OptsInfo, true, &argc, argv);

  return APP_EC_OK;
}

int tstCmdUniverse

(

)

Test CmdUniverse message packing and unpacking.

Returns

Number of bytes unpacked (== packed) on success.
< 0 on error.

Definition at line 363 of file nmExample.c.

References IDENTITY, and PRCMP.

{
  static char *p1 = "p-branes";
  static char *p2 = "bad captain kirk";

  AstroCmdUniverse_T txmsg =
  {
    .m_Truth = true,
    .m_Aura   = 'z',
    .m_Gluon  = 3,
    .m_Electron = -3,
    .m_Planet = 16433,
    .m_StellarObj = -31000,
    .m_StarSystem = 999999,
    .m_Galaxy = -11,
    .m_GalaxyGroup = 0xffffffff,
    .m_Filament = 85,
    .m_VisUnivLY = (float)-53.42,
    .m_FullUnivLY = 53e12,
    .m_Math.m_One = 1,
    .m_Math.m_Two = 2,
    .m_Math.m_DotDotDot = 101,
    .m_StarType = 'O',
    .m_StarInfo.m_Type = 'M',
    .m_StarInfo.m_TempK = 10000,
    .m_StarInfo.m_MassSun = (float)2.6,
  };
  AstroCmdUniverse_T  rxmsg;
  int                 n;

  txmsg.m_HiddenDim  = p1;
  txmsg.m_ParallelUniv  = p2;
  strcpy(txmsg.m_TheUnamed, "God");
  txmsg.m_Physics.m_count = 3;
  txmsg.m_Physics.u.m_buf[0] = 31415;
  txmsg.m_Physics.u.m_buf[1] = 214;
  txmsg.m_Physics.u.m_buf[2] = 317;
  txmsg.m_Physics.u.m_buf[3] = 555555;
  strcpy(txmsg.m_StarInfo.m_Name, "Rigel");
  strcpy(txmsg.m_StarInfo.m_Color, "Blue");

  n = IDENTITY(CmdUniverse, txmsg, rxmsg);

  if( n >= 0 )
  {
    fprintf(stderr, "\n--- AstroCmdUniverse_T Results\n");
    PRCMP(m_Truth, "%hhu");
    PRCMP(m_Aura, "'%c'");
    PRCMP(m_Gluon, "%hhu");
    PRCMP(m_Electron, "%hhd");
    PRCMP(m_Planet, "%hu");
    PRCMP(m_StellarObj, "%hd");
    PRCMP(m_StarSystem, "%u");
    PRCMP(m_Galaxy, "%d");
    PRCMP(m_GalaxyGroup, "%llu");
    PRCMP(m_Filament, "%lld");
    PRCMP(m_VisUnivLY, "%f");
    PRCMP(m_FullUnivLY, "%e");
    fprintf(stderr, "%*s%p->\"%s\"\n", 43, "", p1, p1);
    PRCMP(m_HiddenDim, "%p");
    fprintf(stderr, "%*s%p->\"%s\"\n", 43, "", p2, p2);
    PRCMP(m_ParallelUniv, "%p");
    PRCMP(m_TheUnamed, "%s");
    PRCMP(m_Math.m_One, "%hu");
    PRCMP(m_Math.m_Two, "%u");
    PRCMP(m_Math.m_DotDotDot, "%llu");
    PRCMP(m_Physics.m_count, "%zu");
    PRCMP(m_Physics.u.m_buf[0], "%u");
    PRCMP(m_Physics.u.m_buf[1], "%u");
    PRCMP(m_Physics.u.m_buf[2], "%u");
    PRCMP(m_StarType, "'%c'");
    PRCMP(m_StarInfo.m_Type, "'%c'");
    PRCMP(m_StarInfo.m_TempK, "%u");
    PRCMP(m_StarInfo.m_MassSun, "%f");
    PRCMP(m_StarInfo.m_Name, "%s");
    PRCMP(m_StarInfo.m_Color, "%s");
  }

  return n;
}

int tstCmdZodiac

(

)

Test CmdZodiac message packing and unpacking.

Returns

Number of bytes unpacked (== packed) on success.
< 0 on error.

Definition at line 284 of file nmExample.c.

References ALPHA, BETA, DELTA, EPSILON, GAMMA, IDENTITY, and PRCMP.

{
  int     n = 0;
  size_t  i;

  AstroCmdZodiac_T  txmsg, rxmsg;

  strcpy(txmsg.m_Family, "test const");

  strcpy(txmsg.m_Constellation.m_Name, "Orion");

  txmsg.m_Constellation.m_Designation.u.m_buf[ALPHA] = ALPHA;
  strcpy(txmsg.m_Constellation.m_Star.u.m_buf[ALPHA].m_Name, "Betelgeuse");
  txmsg.m_Constellation.m_Star.u.m_buf[ALPHA].m_Type = 'M';
  strcpy(txmsg.m_Constellation.m_Star.u.m_buf[ALPHA].m_Color, "Red");
  txmsg.m_Constellation.m_Star.u.m_buf[ALPHA].m_TempK = 3500;
  txmsg.m_Constellation.m_Star.u.m_buf[ALPHA].m_MassSun = 19.0;

  txmsg.m_Constellation.m_Designation.u.m_buf[BETA] = BETA;
  strcpy(txmsg.m_Constellation.m_Star.u.m_buf[BETA].m_Name, "Rigel");
  txmsg.m_Constellation.m_Star.u.m_buf[BETA].m_Type = 'B';
  strcpy(txmsg.m_Constellation.m_Star.u.m_buf[BETA].m_Color, "Blue");
  txmsg.m_Constellation.m_Star.u.m_buf[BETA].m_TempK = 11000;
  txmsg.m_Constellation.m_Star.u.m_buf[BETA].m_MassSun = 17.0;

  txmsg.m_Constellation.m_Designation.u.m_buf[GAMMA] = GAMMA;
  strcpy(txmsg.m_Constellation.m_Star.u.m_buf[GAMMA].m_Name, "Bellatrix");
  txmsg.m_Constellation.m_Star.u.m_buf[GAMMA].m_Type = 'B';
  strcpy(txmsg.m_Constellation.m_Star.u.m_buf[GAMMA].m_Color, "Blue");
  txmsg.m_Constellation.m_Star.u.m_buf[GAMMA].m_TempK = 21500;
  txmsg.m_Constellation.m_Star.u.m_buf[GAMMA].m_MassSun = 8.5;

  txmsg.m_Constellation.m_Designation.u.m_buf[DELTA] = DELTA;
  strcpy(txmsg.m_Constellation.m_Star.u.m_buf[DELTA].m_Name, "Mintaka");
  txmsg.m_Constellation.m_Star.u.m_buf[DELTA].m_Type = 'B';
  strcpy(txmsg.m_Constellation.m_Star.u.m_buf[DELTA].m_Color, "Blue");
  txmsg.m_Constellation.m_Star.u.m_buf[DELTA].m_TempK = 30000;
  txmsg.m_Constellation.m_Star.u.m_buf[DELTA].m_MassSun = 20.0;

  txmsg.m_Constellation.m_Designation.u.m_buf[EPSILON] = EPSILON;
  strcpy(txmsg.m_Constellation.m_Star.u.m_buf[EPSILON].m_Name, "Alnilam");
  txmsg.m_Constellation.m_Star.u.m_buf[EPSILON].m_Type = 'B';
  strcpy(txmsg.m_Constellation.m_Star.u.m_buf[EPSILON].m_Color, "Blue");
  txmsg.m_Constellation.m_Star.u.m_buf[EPSILON].m_TempK = 25000;
  txmsg.m_Constellation.m_Star.u.m_buf[EPSILON].m_MassSun = 40.0;

  txmsg.m_Constellation.m_Designation.m_count = EPSILON+1;
  txmsg.m_Constellation.m_Star.m_count = EPSILON+1;

  n = IDENTITY(CmdZodiac, txmsg, rxmsg);

  if( n >= 0 )
  {
    fprintf(stderr, "\n--- AstroCmdZodiac_T Results\n");
    PRCMP(m_Family, "%s");
    PRCMP(m_Constellation.m_Name, "%s");
    PRCMP(m_Constellation.m_Designation.m_count, "%zu");
    PRCMP(m_Constellation.m_Star.m_count, "%zu");
    for(i=0; i<txmsg.m_Constellation.m_Star.m_count; ++i)
    {
      PRCMP(m_Constellation.m_Designation.u.m_buf[i], "%hhu");
      PRCMP(m_Constellation.m_Star.u.m_buf[i].m_Name, "%s");
      PRCMP(m_Constellation.m_Star.u.m_buf[i].m_Type, "'%c'");
      PRCMP(m_Constellation.m_Star.u.m_buf[i].m_Color, "%s");
      PRCMP(m_Constellation.m_Star.u.m_buf[i].m_TempK, "%u");
      PRCMP(m_Constellation.m_Star.u.m_buf[i].m_MassSun, "%f");
    }
  }

  return n;
}

int tstRspErr

(

)

Test AstroRspMsg message packing and unpacking.

Returns

Number of bytes unpacked (== packed) on success.
< 0 on error.

Definition at line 257 of file nmExample.c.

References IDENTITY, and PRCMP.

{
  AstroRspErr_T txmsg, rxmsg;
  int           n;

  txmsg.m_ECode   = 55;
  strcpy(txmsg.m_EMsg, "this is an error message");

  n = IDENTITY(RspErr, txmsg, rxmsg);

  if( n >= 0 )
  {
    fprintf(stderr, "\n--- AstroRspErr_T Results\n");
    PRCMP(m_ECode, "%u");
    PRCMP(m_EMsg, "'%s'");
  }

  return n;
}

Variable Documentation

OptsInfo_T OptsInfo[]

static

Initial value:

=
{
  
  {
    .long_opt   = "trace",
    .short_opt  = 't',
    .has_arg    = no_argument,
    .has_default= true,
    .opt_addr   = &OptsTrace,
    .fn_cvt     = OptsCvtArgBool,
    .fn_fmt     = OptsFmtBool,
    .arg_name   = NULL,
    .opt_desc   = "Do [not] enable tracing of packing and unpacking "
                  "operations. If enabled, tracing is printed to stderr."
  },

  {NULL, }
}

Command-line options information.

Definition at line 102 of file nmExample.c.

Referenced by MainInit().

OptsPgmInfo_T PgmInfo

static

Initial value:

=
{
  .synopsis =
    "Simple example packing and unpacking NetMsgs messages.",

  .long_desc = 
    "The %P application uses the python NetMsgs package generated C code "
    "from the AstroMsgs.xml NetMsgs XML specification and the libnetmsgs "
    "library to pack and unpack the messages."
}

Program information.

Definition at line 88 of file nmExample.c.

Referenced by MainInit().

tstfunc_t TstTbl[]

Initial value:

=
{
  tstRspErr,
  tstCmdZodiac,
  tstCmdUniverse,
  NULL
}

Table of Test Functions.

Definition at line 447 of file nmExample.c.

Referenced by main().