---

rcs_oi.cc

Go to the documentation of this file.

extern "C"
{
#include <stdlib.h>             /* malloc() */
#include <string.h>             /* strcpy(), strcat(), strlen() */
}

#include "nml.hh"
#include "nmlmsg.hh"
#include "cms.hh"

#include "node.hh"              /* class NODE */
#include "rcs_oi.hh"

/* Constructor */
RCS_OI::RCS_OI (NML_FORMAT_PTR fptr, char *_name, char *_process,
                char *file, NODE * _node)
{
  char *request_buffer_name;
  char *reply_buffer_name;

  node = _node;
  request_channel = NULL;
  reply_channel = NULL;
  request_msg = NULL;
  reply_msg = NULL;
  new_request_msg = 0;
  new_reply_msg = 0;
  mode = OI_ACCEPTING_REQUESTS;

  /* Construct request_buffer_name */
  request_buffer_name = (char *) malloc (strlen (_name)
                                         + strlen (node->suffix.req) + 1);
  strcpy (request_buffer_name, _name);
  strcat (request_buffer_name, node->suffix.req);

  /* Open request channel. */
  request_channel = new RCS_OI_REQUEST_CHANNEL (fptr,
                                                request_buffer_name, _process,
                                                file);
  delete request_buffer_name;

  /* Construct reply_buffer_name */
  reply_buffer_name = (char *) malloc (strlen (_name)
                                       + strlen (node->suffix.reply) + 1);
  strcpy (reply_buffer_name, _name);
  strcat (reply_buffer_name, node->suffix.reply);

  /* Open reply channel. */
  reply_channel = new RCS_OI_REPLY_CHANNEL (fptr,
                                            reply_buffer_name, _process,
                                            file);
  delete reply_buffer_name;

  /* Add this RCS_OI to the list in the parent node. */
  if (NULL != node)
    {
      if (NULL != node->operator_interface_list)
        {
          oi_list_id =
            node->operator_interface_list->store_at_tail (this,
                                                          sizeof (RCS_OI), 0);
        }
    }
}

RCS_OI::RCS_OI ()
{
  node = NULL;
  request_channel = NULL;
  reply_channel = NULL;
  request_msg = NULL;
  reply_msg = NULL;
  request_flag = 0;
  cmd_for_node = NULL;
  cmd_for_node_new = 0;
  new_request_msg = 0;
  new_reply_msg = 0;
}

/* Destructor */
RCS_OI::~RCS_OI ()
{
  if (NULL != request_channel)
    {
      delete request_channel;
      request_channel = NULL;
    }
  if (NULL != reply_channel)
    {
      delete reply_channel;
      reply_channel = NULL;
    }
  if (NULL != node)
    {
      if (NULL != node->operator_interface_list)
        {
          node->operator_interface_list->delete_node (oi_list_id);
        }
    }
}

/* interpret incoming requests */
void
RCS_OI::interpret_request ()
{
}

/* convert request to command  */
void
RCS_OI::choose_command_for_node ()
{
}

/* form replies */
void
RCS_OI::choose_reply ()
{
}

/************************************************************
  Function: get_requests()
  Purpose: To read communications channels to determine if the
    operator has made a request.

  Returns:
    0 No new request.
    -1 A communications error occured.
    1 A new request was recieved.
************************************************************/
int
RCS_OI::get_request ()
{
  NMLTYPE temp;
  if (NULL != request_channel)
    {
      switch (temp = request_channel->read ())
        {
        case -1:                /* error */
          return -1;
        case 0:         /* old */
          new_request_msg = 0;
          return 0;
        default:                /* new */
          request_flag = 1;
          new_request_msg = 1;
          request_type = temp;
          request_msg = request_channel->get_address ();
          return 1;
        }
    }
  else
    {
      return -1;
    }
}

/************************************************************
  Function: get_requests()
  Purpose: To inform the OI that the NODE has moved to a new
  mode.
************************************************************/
void
RCS_OI::set_mode (OI_MODE_TYPE new_mode)
{
  mode = new_mode;
}

/************************************************************
  Function: acknowledge_request()
  Purpose: To inform the OI that the NODE has acknowledged it's
  request.
************************************************************/
void
RCS_OI::acknowledge_request ()
{
  request_flag = 0;
}

/************************************************************
  Function: acknowledge_request()
  Purpose: To inform the OI that the NODE has completed  it's
  request.
************************************************************/
void
RCS_OI::request_done ()
{
}


/************************************************************
  Function: acknowledge_request()
  Purpose: To allow the OI to process it's
  request.

  Note: It will be called every cycle whether or not the NODE
  will actually accept requests from the OI.
************************************************************/
void
RCS_OI::cycle ()
{
  interpret_request ();
  choose_command_for_node ();
  choose_reply ();
}

/************************************************************
  Function: send_replies()
  Purpose: Send the operator(s) some info.

  Returns:
  -1 if an error occurred.
  0 otherwise.
************************************************************/
int
RCS_OI::send_reply ()
{
  if (NULL != reply_channel)
    {
      if (new_reply_msg)
        {
          return (reply_channel->write (reply_msg));
        }
      return 0;
    }
  else
    {
      return -1;
    }
}

---