---

nml.hh

Go to the documentation of this file.

/*************************************************************************
* File: nml.hh                                                           *
* Authors: Fred Proctor, Will Shackleford                                *
* Purpose: C++ Header file for the Neutral Manufacturing Language (NML). *
*          Includes:                                                     *
*               1. class NML.                                            *
*               2. typedef for NMLTYPE.                                  *
*               3. typedef for NML_FORMAT_PTR                            *
*               4. enum NML_ERROR_TYPE                                   *
*************************************************************************/

#ifndef NML_HH
#define NML_HH

/* Include Files */
#include "rcs_defs.hh"          /* EXTERN_C_STD_HEADERS */


#ifdef EXTERN_C_STD_HEADERS
extern "C"
{
#endif

#ifndef UNDER_CE
#include <stddef.h>             /* size_t */
#endif

#ifdef EXTERN_C_STD_HEADERS
}
#endif


#include "cms_user.hh"          /* class CMS_USER */
#include "linklist.hh"          /* class RCS_LINKED_LIST */

/* Generic NML Stuff */

#ifndef NMLTYPE_TYPEDEFED
#define NMLTYPE_TYPEDEFED
typedef long NMLTYPE;           /* Also defined in nmlmsg.hh */
#endif

class RCS_EXPORT NMLmsg;        /* Use only partial definition to avoid */
                                /* depending on nmlmsg.hh. */

/* Typedef for pointer to the function used to decode a message */
 /* by its id number. */
typedef int (*NML_FORMAT_PTR) (NMLTYPE, void RCS_FAR *, CMS RCS_FAR *);

/* Values for NML::error_type. */
enum NML_ERROR_TYPE
{
  NML_NO_ERROR,
  NML_BUFFER_NOT_READ,
  NML_TIMED_OUT,
  NML_INVALID_CONFIGURATION,
  NML_FORMAT_ERROR,
  NML_INTERNAL_CMS_ERROR,
  NML_NO_MASTER_ERROR,
  NML_INVALID_MESSAGE_ERROR,
  NML_QUEUE_FULL_ERROR
};


enum NML_CHANNEL_TYPE
{
  INVALID_NML_CHANNEL_TYPE = 0,
  NML_GENERIC_CHANNEL_TYPE,
  RCS_CMD_CHANNEL_TYPE,
  RCS_STAT_CHANNEL_TYPE,
  NML_QUERY_CHANNEL_TYPE,
  NML_ID_CHANNEL_TYPE
};


extern char NML_ERROR_TYPE_STRINGS[8][80];
class NML_DIAGNOSTICS_INFO;

/* nml interface to CMS. */
class RCS_EXPORT NML:public virtual CMS_USER
{
protected:
  int run_format_chain (NMLTYPE, void *);
  int format_input (NMLmsg * nml_msg);  /* Format message if neccessary */
  int format_output ();         /* Decode message if neccessary. */

public:
  void *operator new (size_t);
  void operator delete (void *);
  RCS_LINKED_LIST *format_chain;
  void register_with_server (); /* Add this channel to the server's list. */
  void add_to_channel_list ();  /* Add this channel to the main list.  */
  int channel_list_id;          /* List id of this channel. */
  NML_ERROR_TYPE error_type;    /* check here if an NML function returns -1 */
#ifdef VXWORKS
  int pid;
#endif
#ifdef _Windows
  // HANDLE replaced with void RCS_FAR *
  void RCS_FAR *task_handle;
#endif
  /* Get Address of message for user after read. */
    NMLTYPE (*phantom_read) ();
    NMLTYPE (*phantom_peek) ();
  int (*phantom_write) (NMLmsg * nml_msg);
  int (*phantom_write_if_read) (NMLmsg * nml_msg);
  int (*phantom_check_if_read) ();
  int (*phantom_clear) ();
  int ignore_format_chain;

  NMLmsg *get_address ();
  void delete_channel ();

  /* Read and Write Functions. */
  NMLTYPE read ();              /* Read the buffer. */
  NMLTYPE blocking_read (double timeout);       /* Read the buffer. (Wait for new data). */
  NMLTYPE peek ();              /* Read buffer without changing was_read */
  NMLTYPE read (void *, long);
  NMLTYPE peek (void *, long);
  int write (NMLmsg & nml_msg); /* Write a message. (Use reference) */
  int write (NMLmsg * nml_msg); /* Write a message. (Use pointer) */
  int write_if_read (NMLmsg & nml_msg); /* Write only if buffer was_read */
  int write_if_read (NMLmsg * nml_msg); /*  '' */
  NMLTYPE blocking_read_extended (double timeout, double poll_interval);


  int write_subdivision (int subdiv, NMLmsg & nml_msg); /* Write a message. (Use reference) */
  int write_subdivision (int subdiv, NMLmsg * nml_msg); /* Write a message. (Use pointer) */
  int write_if_read_subdivision (int subdiv, NMLmsg & nml_msg); /* Write only if buffer was_read */
  int write_if_read_subdivision (int subdiv, NMLmsg * nml_msg); /*  '' */
  NMLTYPE read_subdivision (int subdiv);        /* Read the buffer. */
  NMLTYPE blocking_read_subdivision (int subdiv, double timeout);       /* Read the buffer. (Wait for new data). */
  NMLTYPE peek_subdivision (int subdiv);        /* Read buffer without changing was_read */
  NMLmsg *get_address_subdivision (int subdiv);
  int get_total_subdivisions ();

  void clean_buffers ();
  const char *msg2str (NMLmsg & nml_msg);
  const char *msg2str (NMLmsg * nml_msg);
  NMLTYPE str2msg (const char *);
  int login (const char *name, const char *passwd);
  void reconnect ();
  void disconnect ();

  /* Function to check to see if this NML object is properly configured. */
  int valid ();

  /* Make just the check_if_read function from cms available to NML users. */
  int check_if_read ();
  int check_if_transfers_complete ();

  /* Make just the clear  function from cms available to NML users. */
  int clear ();

  /* Get the number of messages written to this buffer so far. */
  int get_msg_count ();

  /* Get Diagnostics Information. */
  NML_DIAGNOSTICS_INFO *get_diagnostics_info ();


  int prefix_format_chain (NML_FORMAT_PTR);

  /* Constructors and destructors. */
    NML (NML_FORMAT_PTR f_ptr,
         char *, char *, char *,
         int set_to_server = 0, int set_to_master = 0);
    NML (NML *, int set_to_server = 0, int set_to_master = 0);
    NML (char *buffer_line, char *proc_line);
    virtual ~ NML ();
  int reset ();

  int print_queue_info ();
  int queue_length;
  int set_error ();
  void print_info (char *bufname = NULL, char *procname =
                   NULL, char *cfg_file = NULL);
protected:
  int fast_mode;
  int *cms_status;
  long *cms_inbuffer_header_size;
    NML (char *, char *, char *, int set_to_server = 0, int set_to_master = 0);
  void reconstruct (NML_FORMAT_PTR, char *, char *, char *,
                    int set_to_server = 0,
                    int set_to_master = 0);

  int info_printed;


public:
    NML_CHANNEL_TYPE channel_type;
  long sizeof_message_header;
  int forced_type;

protected:
  int already_deleted;
  char bufname[40];
  char procname[40];
  char cfgfilename[160];
  double blocking_read_poll_interval;
  CMS *cms_for_msg_string_conversions;

    NML (NML & nml);            // Don't copy me.
};


int RCS_EXPORT create_NML (NML **, NML_FORMAT_PTR f_ptr,
                           char *buf, char *proc, char *file);

void RCS_EXPORT free_NML (NML *);


extern RCS_LINKED_LIST RCS_FAR *NML_Main_Channel_List;
extern "C"
{
  extern void RCS_EXPORT nml_start ();
  extern void RCS_EXPORT nml_cleanup ();
  extern void RCS_EXPORT nml_wipeout_lists ();
  extern void RCS_EXPORT set_default_nml_config_file (const char RCS_FAR *);
  extern const char *RCS_EXPORT get_default_nml_config_file ();
  extern NML *RCS_EXPORT nmlWaitOpen (NML_FORMAT_PTR fPtr, char *buffer,
                                      char *name, char *file,
                                      double sleepTime);

  extern void nmlSetHostAlias (const char *hostName, const char *hostAlias);
  extern void nmlClearHostAliases ();
  extern void nmlAllowNormalConnection ();
  extern void nmlForceRemoteConnection ();
  extern void nmlForceLocalConnection ();
}


extern int verbose_nml_error_messages;
extern int nml_print_hostname_on_error;
extern int nml_reset_errors_printed;

#endif /* !NML_HH */

---