<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.14">
  <compounddef id="classCisRpc" kind="class" language="C++" prot="public">
    <compoundname>CisRpc</compoundname>
    <derivedcompoundref refid="classCisRpcClient" prot="public" virt="non-virtual">CisRpcClient</derivedcompoundref>
    <derivedcompoundref refid="classCisRpcServer" prot="public" virt="non-virtual">CisRpcServer</derivedcompoundref>
    <includes refid="CisInterface_8hpp" local="no">CisInterface.hpp</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classCisRpc_1a04e90eb6d57173fa6c98544f445b7c5f" prot="private" static="no" mutable="no">
        <type>cisRpc_t</type>
        <definition>cisRpc_t CisRpc::_pi</definition>
        <argsstring></argsstring>
        <name>_pi</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="261" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="261" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classCisRpc_1a91e65146ad3b4d1a3999835003b1cf37" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>CisRpc::CisRpc</definition>
        <argsstring>(const char *name, const char *outFormat, const char *inFormat)</argsstring>
        <name>CisRpc</name>
        <param>
          <type>const char *</type>
          <declname>name</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>outFormat</declname>
        </param>
        <param>
          <type>const char *</type>
          <declname>inFormat</declname>
        </param>
        <briefdescription>
<para>Constructor for <ref refid="classCisRpc" kindref="compound">CisRpc</ref>. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">name</parametername>
</parameternamelist>
<parameterdescription>
<para>constant character pointer name of the output queue. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">outFormat</parametername>
</parameternamelist>
<parameterdescription>
<para>character pointer to format that should be used for formatting output. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">inFormat</parametername>
</parameternamelist>
<parameterdescription>
<para>character pointer to format that should be used for parsing input. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="272" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="272" bodyend="273"/>
      </memberdef>
      <memberdef kind="function" id="classCisRpc_1aca7fcde600dcb7b42ef93a5e9405358b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>CisRpc::CisRpc</definition>
        <argsstring>(cisRpc_t x)</argsstring>
        <name>CisRpc</name>
        <param>
          <type>cisRpc_t</type>
          <declname>x</declname>
        </param>
        <briefdescription>
<para>Empty constructor for inheritance. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="276" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="276" bodyend="276"/>
      </memberdef>
      <memberdef kind="function" id="classCisRpc_1a29148e3e2924edc61aeec247ed939161" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void CisRpc::_destroy_pi</definition>
        <argsstring>()</argsstring>
        <name>_destroy_pi</name>
        <briefdescription>
<para>Alias to allow freeing of underlying C struct at the class level. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="281" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="281" bodyend="281"/>
      </memberdef>
      <memberdef kind="function" id="classCisRpc_1accbcccd1fd223660be6e8cf54cace2a8" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>CisRpc::~CisRpc</definition>
        <argsstring>()</argsstring>
        <name>~CisRpc</name>
        <briefdescription>
<para>Destructor for <ref refid="classCisRpc" kindref="compound">CisRpc</ref>. See cis_free in <ref refid="CisInterface_8h_source" kindref="compound">CisInterface.h</ref> for details. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="287" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="287" bodyend="287"/>
      </memberdef>
      <memberdef kind="function" id="classCisRpc_1ac58fc44e28ea378a1ef6b12684371aef" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>cisRpc_t</type>
        <definition>cisRpc_t CisRpc::pi</definition>
        <argsstring>()</argsstring>
        <name>pi</name>
        <briefdescription>
<para>Return the cisRpc_t structure. </para>        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>cisRpc_t structure underlying the class. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="293" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="293" bodyend="295"/>
      </memberdef>
      <memberdef kind="function" id="classCisRpc_1afb4143aa59acfe94df91435262cde01e" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>int CisRpc::send</definition>
        <argsstring>(const int nargs,...)</argsstring>
        <name>send</name>
        <param>
          <type>const int</type>
          <declname>nargs</declname>
        </param>
        <param>
          <type>...</type>
        </param>
        <briefdescription>
<para>Format and send a message to an RPC output queue. See rpcSend from <ref refid="CisInterface_8h_source" kindref="compound">CisInterface.h</ref> for details. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">nargs</parametername>
</parameternamelist>
<parameterdescription>
<para>int Number of arguments being passed. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">...</parametername>
</parameternamelist>
<parameterdescription>
<para>arguments for formatting. <linebreak/>
</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>integer specifying if the send was succesful. Values &gt;= 0 indicate success. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="305" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="305" bodyend="311"/>
      </memberdef>
      <memberdef kind="function" id="classCisRpc_1a6b1acb06791551c0c3096f678690e315" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>int CisRpc::recv</definition>
        <argsstring>(const int nargs,...)</argsstring>
        <name>recv</name>
        <param>
          <type>const int</type>
          <declname>nargs</declname>
        </param>
        <param>
          <type>...</type>
        </param>
        <briefdescription>
<para>Receive and parse a message from an RPC input queue. See rpcRecv from <ref refid="CisInterface_8h_source" kindref="compound">CisInterface.h</ref> for details. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">nargs</parametername>
</parameternamelist>
<parameterdescription>
<para>int Number of arguments being passed. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">...</parametername>
</parameternamelist>
<parameterdescription>
<para>mixed arguments that should be assigned parameters extracted using the format string. Since these will be assigned, they should be pointers to memory that has already been allocated. </para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>integer specifying if the receive was succesful. Values &gt;= 0 indicate success. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="323" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="323" bodyend="329"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>C++ interface to cisRpc_t functionality. </para>    </briefdescription>
    <detaileddescription>
<para>The <ref refid="classCisRpc" kindref="compound">CisRpc</ref> class is a basic wrapper around the C cisRpc_t structure and associated functions from the <ref refid="CisInterface_8h_source" kindref="compound">CisInterface.h</ref> header. It provides the user with C++ style access to basic RPC messaging via IPC queues. </para>    </detaileddescription>
    <inheritancegraph>
      <node id="119">
        <label>CisRpc</label>
        <link refid="classCisRpc"/>
      </node>
      <node id="121">
        <label>CisRpcServer</label>
        <link refid="classCisRpcServer"/>
        <childnode refid="119" relation="public-inheritance">
        </childnode>
      </node>
      <node id="120">
        <label>CisRpcClient</label>
        <link refid="classCisRpcClient"/>
        <childnode refid="119" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <location file="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" line="260" column="1" bodyfile="/root/cis_interface/cis_interface/cis_interface/interface/CisInterface.hpp" bodystart="260" bodyend="330"/>
    <listofallmembers>
      <member refid="classCisRpc_1a29148e3e2924edc61aeec247ed939161" prot="public" virt="non-virtual"><scope>CisRpc</scope><name>_destroy_pi</name></member>
      <member refid="classCisRpc_1a04e90eb6d57173fa6c98544f445b7c5f" prot="private" virt="non-virtual"><scope>CisRpc</scope><name>_pi</name></member>
      <member refid="classCisRpc_1a91e65146ad3b4d1a3999835003b1cf37" prot="public" virt="non-virtual"><scope>CisRpc</scope><name>CisRpc</name></member>
      <member refid="classCisRpc_1aca7fcde600dcb7b42ef93a5e9405358b" prot="public" virt="non-virtual"><scope>CisRpc</scope><name>CisRpc</name></member>
      <member refid="classCisRpc_1ac58fc44e28ea378a1ef6b12684371aef" prot="public" virt="non-virtual"><scope>CisRpc</scope><name>pi</name></member>
      <member refid="classCisRpc_1a6b1acb06791551c0c3096f678690e315" prot="public" virt="non-virtual"><scope>CisRpc</scope><name>recv</name></member>
      <member refid="classCisRpc_1afb4143aa59acfe94df91435262cde01e" prot="public" virt="non-virtual"><scope>CisRpc</scope><name>send</name></member>
      <member refid="classCisRpc_1accbcccd1fd223660be6e8cf54cace2a8" prot="public" virt="non-virtual"><scope>CisRpc</scope><name>~CisRpc</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
