pop3__client_8h.html

Freescale mcu OpenTCP-1.0.4.doc.html.zip 文档

    <td>
      &nbsp;
    </td>
    <td>

<p>
POP3 state: RETR sent by us 
<p>
Definition at line <a class="el" href="pop3__client_8h-source.html#l00126">126</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>.    </td>
  </tr>
</table>
<a name="a23" doxytag="pop3_client.h::POP3C_RECEIVING_MSG_HEADER"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define POP3C_RECEIVING_MSG_HEADER&nbsp;&nbsp;&nbsp;21
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
POP3 state: We are reading the message header 
<p>
Definition at line <a class="el" href="pop3__client_8h-source.html#l00127">127</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>.    </td>
  </tr>
</table>
<a name="a24" doxytag="pop3_client.h::POP3C_RECEIVING_MSG"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define POP3C_RECEIVING_MSG&nbsp;&nbsp;&nbsp;22
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
POP3 state: Receiving the message 
<p>
Definition at line <a class="el" href="pop3__client_8h-source.html#l00128">128</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>.    </td>
  </tr>
</table>
<a name="a25" doxytag="pop3_client.h::POP3C_MESSAGE_RECEIVED"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define POP3C_MESSAGE_RECEIVED&nbsp;&nbsp;&nbsp;23
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
POP3 state: Received the message 
<p>
Definition at line <a class="el" href="pop3__client_8h-source.html#l00129">129</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>.    </td>
  </tr>
</table>
<a name="a26" doxytag="pop3_client.h::POP3C_DELE_SENT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define POP3C_DELE_SENT&nbsp;&nbsp;&nbsp;24
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
POP3 state: DELE sent by us 
<p>
Definition at line <a class="el" href="pop3__client_8h-source.html#l00130">130</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>.    </td>
  </tr>
</table>
<a name="a27" doxytag="pop3_client.h::POP3C_DELE_ACKED"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define POP3C_DELE_ACKED&nbsp;&nbsp;&nbsp;25
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
POP3 state: Server has replied dele +OK 
<p>
Definition at line <a class="el" href="pop3__client_8h-source.html#l00131">131</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>.    </td>
  </tr>
</table>
<a name="a28" doxytag="pop3_client.h::POP3C_QUIT_SENT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define POP3C_QUIT_SENT&nbsp;&nbsp;&nbsp;26
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
POP3 state: QUIT sent by us 
<p>
Definition at line <a class="el" href="pop3__client_8h-source.html#l00132">132</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>.    </td>
  </tr>
</table>
<a name="a29" doxytag="pop3_client.h::POP3C_QUIT_ACKED"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define POP3C_QUIT_ACKED&nbsp;&nbsp;&nbsp;27
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
POP3 state: Server has replied quit +OK 
<p>
Definition at line <a class="el" href="pop3__client_8h-source.html#l00133">133</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>.    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a31" doxytag="pop3_client.h::pop3c_connect"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> INT8 pop3c_connect </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">UINT32&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>ip</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>UINT16&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>port</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>
<dl compact><dt><b>Author: </b></dt><dd>
 <ul>
<li> Jari Lahti (<a href="mailto:[e-mail]">[e-mail]</a>) </ul>
</dl><dl compact><dt><b>Date: </b></dt><dd>
11.09.2002 </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ip</em>&nbsp;</td><td>
IP address of POP3 server from which to read the e-mails </td></tr>
<tr><td valign=top><em>port</em>&nbsp;</td><td>
Port on the server </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
 <ul>
<li> -1 - Error <li> &gt;0 - Connection procedure started (OK)</ul>
</dl>This function is called by user when she wants to start E-mail  reading procedure. The function is responsible of establishing connection to POP3 server. After connection is established the POP3 client engine starts to make callbacks to user functions in order to get username information, data etc. 
<p>
Definition at line <a class="el" href="pop3__client_8c-source.html#l00114">114</a> of file <a class="el" href="pop3__client_8c-source.html">pop3_client.c</a>.
<p>
References <a class="el" href="pop3__client_8h-source.html#l00108">POP3C_CLOSED</a>, <a class="el" href="pop3__client_8h-source.html#l00109">POP3C_OPEN_REQUESTED</a>, <a class="el" href="pop3__client_8h-source.html#l00088">pop3c_struct::remip</a>, <a class="el" href="pop3__client_8h-source.html#l00089">pop3c_struct::remport</a>, <a class="el" href="pop3__client_8h-source.html#l00090">pop3c_struct::sochandle</a>, and <a class="el" href="pop3__client_8h-source.html#l00087">pop3c_struct::state</a>.    </td>
  </tr>
</table>
<a name="a32" doxytag="pop3_client.h::pop3c_init"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void pop3c_init </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&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>
<dl compact><dt><b>Author: </b></dt><dd>
 <ul>
<li> Jari Lahti (<a href="mailto:[e-mail]">[e-mail]</a>) </ul>
</dl><dl compact><dt><b>Date: </b></dt><dd>
12.08.2002</dl>This function should be called once when system starts. Make sure that system services e.g. timers, TCP are initialized before initializing applications! 
<p>
Definition at line <a class="el" href="pop3__client_8c-source.html#l00148">148</a> of file <a class="el" href="pop3__client_8c-source.html">pop3_client.c</a>.
<p>
References <a class="el" href="pop3__client_8h-source.html#l00098">pop3c_struct::charsinheaderbuf</a>, <a class="el" href="pop3__client_8h-source.html#l00096">pop3c_struct::curmsghlen</a>, <a class="el" href="pop3__client_8h-source.html#l00094">pop3c_struct::curmsgindex</a>, <a class="el" href="pop3__client_8h-source.html#l00095">pop3c_struct::curmsgtotlen</a>, <a class="el" href="pop3__client_8h-source.html#l00099">pop3c_struct::from</a>, <a class="el" href="timers_8c-source.html#l00131">get_timer()</a>, <a class="el" href="pop3__client_8h-source.html#l00097">pop3c_struct::headerbuf</a>, <a class="el" href="pop3__client_8h-source.html#l00093">pop3c_struct::msgtotal</a>, <a class="el" href="pop3__client_8h-source.html#l00108">POP3C_CLOSED</a>, <a class="el" href="pop3__client_8c-source.html#l00077">pop3c_init_done</a>, <a class="el" href="pop3__client_8h-source.html#l00088">pop3c_struct::remip</a>, <a class="el" href="pop3__client_8h-source.html#l00089">pop3c_struct::remport</a>, <a class="el" href="system_8h-source.html#l00163">RESET_SYSTEM</a>, <a class="el" href="pop3__client_8h-source.html#l00090">pop3c_struct::sochandle</a>, <a class="el" href="pop3__client_8h-source.html#l00100">pop3c_struct::subject</a>, <a class="el" href="tcp__ip_8h-source.html#l00225">TCP_DEF_TOUT</a>, <a class="el" href="tcp_8c-source.html#l00155">tcp_getsocket()</a>, <a class="el" href="tcp__ip_8h-source.html#l00214">TCP_TOS_NORMAL</a>, <a class="el" href="tcp__ip_8h-source.html#l00320">TCP_TYPE_CLIENT</a>, <a class="el" href="pop3__client_8h-source.html#l00091">pop3c_struct::tmrhandle</a>, and <a class="el" href="pop3__client_8h-source.html#l00092">pop3c_struct::unacked</a>.    </td>
  </tr>
</table>
<a name="a33" doxytag="pop3_client.h::pop3c_getstate"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> UINT8 pop3c_getstate </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&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>
<dl compact><dt><b>Author: </b></dt><dd>
 <ul>
<li> Jari Lahti (<a href="mailto:[e-mail]">[e-mail]</a>) </ul>
</dl><dl compact><dt><b>Date: </b></dt><dd>
10.10.2002 </dl><dl compact><dt><b>Returns: </b></dt><dd>
Current POP3 client state</dl>Invoke this function to get current state of the POP3 client 
<p>
Definition at line <a class="el" href="pop3__client_8c-source.html#l00194">194</a> of file <a class="el" href="pop3__client_8c-source.html">pop3_client.c</a>.
<p>
References <a class="el" href="pop3__client_8h-source.html#l00087">pop3c_struct::state</a>.    </td>
  </tr>
</table>
<a name="a47" doxytag="pop3_client.h::pop3c_error"></a><p>