classcradiusattribute.html

采用 ACE 开发的 radius 应用

<p>
Get string data of Vendor-Specific attribute. 
<p>
Note that string data may contain both readable characters and non-readable binary data. In any case string will not be null-terminated, hence application should use returned p_length value to properly operate with it.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td><tt>[out]</tt>&nbsp;</td><td valign=top><em>p_data</em>&nbsp;</td><td>- pointer to the beginning of string data </td></tr>
    <tr><td><tt>[out]</tt>&nbsp;</td><td valign=top><em>p_length</em>&nbsp;</td><td>- string length </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>RC_SUCCESS or RC_FAIL </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a22" doxytag="CRadiusAttribute::getVendorType" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> unsigned char CRadiusAttribute::getVendorType           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get vendor type of Vendor-Specific attribute. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>vendor type </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a3" doxytag="CRadiusAttribute::init" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void CRadiusAttribute::init           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classCRadiusPacket.html">CRadiusPacket</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>p_packet</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>ACE_UINT16&nbsp;</td>
          <td class="mdname" nowrap> <em>p_offset</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Init attribute. 
<p>
Set associated RADIUS packet and offset in it - this will effectively init the attribute. A special usage is to pass zero p_offset - this will mark attribute "invalid".<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td><tt>[in]</tt>&nbsp;</td><td valign=top><em>p_packet</em>&nbsp;</td><td>- RADIUS packet </td></tr>
    <tr><td><tt>[in]</tt>&nbsp;</td><td valign=top><em>p_offset</em>&nbsp;</td><td>- offset inside the packet's raw data </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a11" doxytag="CRadiusAttribute::isValid" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int CRadiusAttribute::isValid           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Attribute is valid? 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>TRUE or FALSE </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a36" doxytag="CRadiusAttribute::setChapIdentifier" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int CRadiusAttribute::setChapIdentifier           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>p_chapId</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set vendor ID of CHAP-Password attribute. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td><tt>[in]</tt>&nbsp;</td><td valign=top><em>p_chapIdentifier</em>&nbsp;</td><td>- CHAP identifier value </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>RC_SUCCESS or RC_FAIL </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a38" doxytag="CRadiusAttribute::setChapString" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int CRadiusAttribute::setChapString           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char *&nbsp;</td>
          <td class="mdname" nowrap> <em>p_data</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>ACE_UINT16&nbsp;</td>
          <td class="mdname" nowrap> <em>p_length</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set string data of CHAP-Password attribute. 
<p>
Note that string data may contain both readable characters and non-readable binary data. In any case string should not be null-terminated.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td><tt>[in]</tt>&nbsp;</td><td valign=top><em>p_data</em>&nbsp;</td><td>- pointer to the beginning of string data </td></tr>
    <tr><td><tt>[in]</tt>&nbsp;</td><td valign=top><em>p_length</em>&nbsp;</td><td>- string length </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>RC_SUCCESS or RC_FAIL </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a15" doxytag="CRadiusAttribute::setIPAddress" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int CRadiusAttribute::setIPAddress           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">struct in_addr&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>p_value</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set value of the IP address attribute. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td><tt>[in]</tt>&nbsp;</td><td valign=top><em>p_value</em>&nbsp;</td><td>- IP address </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>RC_SUCCESS if attribute is successfully encode; RC_FAIL otherwise </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a10" doxytag="CRadiusAttribute::setLength" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int CRadiusAttribute::setLength           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>p_length</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set attribute length. 
<p>
Set attribute's length - refer to <a class="el" href="classCRadiusAttribute.html#a9">getLength()</a> description for details.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td><tt>[in]</tt>&nbsp;</td><td valign=top><em>p_length</em>&nbsp;</td><td>- attribute's length </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>RC_SUCCESS or RC_FAIL </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a13" doxytag="CRadiusAttribute::setNumber" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int CRadiusAttribute::setNumber           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">ACE_UINT32&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>p_value</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set value of the numeric attribute. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td><tt>[in]</tt>&nbsp;</td><td valign=top><em>p_value</em>&nbsp;</td><td>- numeric value in host order format </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>RC_SUCCESS if attribute is successfully encode; RC_FAIL otherwise </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a17" doxytag="CRadiusAttribute::setString" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int CRadiusAttribute::setString           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned char *&nbsp;</td>
          <td class="mdname" nowrap> <em>p_data</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>ACE_UINT16&nbsp;</td>
          <td class="mdname" nowrap> <em>p_length</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set value of the string attribute. 
<p>
Note that string data may contain both readable characters and non-readable binary data. In any case string should not be null-terminated.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td><tt>[in]</tt>&nbsp;</td><td valign=top><em>p_data</em>&nbsp;</td><td>- pointer to the beginning of string data </td></tr>
    <tr><td><tt>[in]</tt>&nbsp;</td><td valign=top><em>p_length</em>&nbsp;</td><td>- string length </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>RC_SUCCESS or RC_FAIL </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a7" doxytag="CRadiusAttribute::setType" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">