/usr/share/cone/mail-process.html is in cone 0.89-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | <html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"/>
<title>mail::account::process</title>
<link rel="stylesheet" href="manpage.css" type="text/css"/>
<link rel="home" href="index.html" title="Cone: COnsole Newsreader And Emailer"/>
<link rel="up" href="native.html" title="mail::account Native API reference"/>
<link rel="prev" href="mail-poll.html" title="mail::account::poll"/>
<link rel="next" href="mail-readmsgattr.html" title="mail::account::readMessageAttributes"/>
<link xmlns="" rel="icon" href="icon.gif" type="image/gif"/>
<meta xmlns="" name="MSSmartTagsPreventParsing" content="TRUE"/>
<!--
Copyright 2002 - 2007 Double Precision, Inc. See COPYING for distribution
information.
-->
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center" rowspan="1">
mail::account::process</th>
</tr>
<tr>
<td width="20%" align="left" rowspan="1" colspan="1">
<a accesskey="p" href="mail-poll.html" shape="rect">Prev</a> </td>
<th width="60%" align="center" rowspan="1" colspan="1">
<span class="structname">mail::account</span> Native API
reference</th>
<td width="20%" align="right" rowspan="1" colspan="1">
 <a accesskey="n" href="mail-readmsgattr.html" shape="rect">Next</a></td>
</tr>
</table>
<hr/>
</div>
<div class="refentry" title="mail::account::process">
<a id="mail-process" shape="rect" name="mail-process"> </a>
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>mail::account::process — Process pending events</p>
</div>
<div class="refsynopsisdiv" title="Synopsis">
<h2>Synopsis</h2>
<div class="literallayout">
<p><br clear="none"/>
<br clear="none"/>
<br clear="none"/>
#include <libmail/mail.H><br clear="none"/>
<br clear="none"/>
<br clear="none"/>
class myCallback : public mail::callback {<br clear="none"/>
public:<br clear="none"/>
    void success(std::string msg);<br clear="none"/>
    void fail(std::string msg);<br clear="none"/>
};<br clear="none"/></p>
</div>
<div class="literallayout">
<p><br clear="none"/>
#include <sys/time.h><br clear="none"/>
#include <sys/types.h><br clear="none"/>
#include <unistd.h><br clear="none"/>
<br clear="none"/>
mail::account::function( <em class="replaceable"><code>parameter list</code></em>,<br clear="none"/>
                         myCallback &<em class="replaceable"><code>callback</code></em>)<br clear="none"/>
<br clear="none"/>
for (;;)<br clear="none"/>
{<br clear="none"/>
  std::vector<mail::pollfd> pollfds;<br clear="none"/>
  int timeout;<br clear="none"/>
<br clear="none"/>
  timeout=15 * 60 * 60 * 1000;<br clear="none"/>
</p>
</div>
<div class="funcsynopsis">
<table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table">
<tr>
<td rowspan="1" colspan="1"><code class="funcdef"><b class="fsfunc">mail::account::process</b>(</code></td>
<td rowspan="1" colspan="1"><var class="pdparam">pollfds</var>,</td>
</tr>
<tr>
<td rowspan="1" colspan="1"> </td>
<td rowspan="1" colspan="1"><var class="pdparam">timeout</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer">
 
</div>
</div>
<div class="literallayout">
<p><br clear="none"/>
<br clear="none"/>
  if (myCallback.completed())<br clear="none"/>
      break;<br clear="none"/>
<br clear="none"/>
  if (mail::account::poll(pollfds, timeout) < 0 && errno != EINTR)<br clear="none"/>
  {<br clear="none"/>
     error();<br clear="none"/>
  }<br clear="none"/>
}<br clear="none"/></p>
</div>
</div>
<div class="refsect1" title="USAGE">
<a id="id603877" shape="rect" name="id603877"> </a>
<h2>USAGE</h2>
<p>This function processes all pending events for all opened
mail accounts. Most <span class="structname">mail</span>
requests are not immediately processed (some are, but most
aren't). A <span class="structname">mail</span> request
usually includes a <span class="structname">mail::callback</span>-derived object as one of
its arguments. When the mail request completes the
<code class="function">success</code> or <code class="function">fail</code> method (some <span class="structname">mail::callback</span> subclasses use additional
or alternative methods) is invoked. If the mail request
cannot be completed immediately, <code class="function"><em class="replaceable"><code>mail::account::function</code></em></code>
still returns right away. <code class="function">mail::account::process</code> handles any pending
events for all outstanding <span class="structname">mail</span> requests. The <code class="function">success</code> or <code class="function">fail</code> method will be invoked for all
completed requests.</p>
<p>The <span class="structname">mail::pollfd</span> structure
is a C++ wrapper for the <span class="quote">“<span class="quote">struct <span class="structname">pollfd</span></span>”</span> that's used
by the <span class="citerefentry"><span class="refentrytitle">poll</span>(2)</span> system call.
<code class="function">mail::account::process</code> receives
a reference to a vector of <span class="structname">mail::pollfd</span> objects. After <code class="function">mail::account::process</code> handles any pending
events, the function initializes the vector with all open
file descriptors on which activity is expected before
<code class="function">mail::account::process</code> expects
any more events to occur.</p>
<p>Any existing contents of the <span class="structname">mail::pollfd</span> vector will be destroyed. On
the other hand, <em class="parameter"><code>timeout</code></em> must be initialized
prior to invoking <code class="function">mail::account::process</code>. <em class="parameter"><code>timeout</code></em> contains a time
interval, in milliseconds, before the calling application
expects to process any regularly-scheduled event. If
<code class="function">mail::account::process</code> expects
any regularly-scheduled event to occur earlier, it will
replace <em class="parameter"><code>timeout</code></em> with
the smaller timeout interval.</p>
<p>The expectation is that the application's main loops
alternatively invokes <code class="function">mail::account::process</code> and <span class="citerefentry"><span class="refentrytitle">poll</span>(2)</span>. <span class="citerefentry"><span class="refentrytitle">poll</span>(2)</span> waits for some I/O
occur, or a timeout expiring; <code class="function">mail::account::process</code> processes any
resulting events, then the cycle repeats.</p>
<p>The application may add its own file descriptors to the
<span class="structname">mail::pollfd</span> vector, before
calling <span class="citerefentry"><span class="refentrytitle">poll</span>(2)</span>. The application is
reponsible for handling any I/O activity from its own file
descriptors.</p>
</div>
<div class="refsect1" title="Return Codes">
<a id="id604082" shape="rect" name="id604082"> </a>
<h2>Return Codes</h2>
<p><code class="function">mail::account::process</code>
always returns succesfully.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>The application should not invoke <code class="function">mail::account::process</code> again until it
either invokes <span class="citerefentry"><span class="refentrytitle">poll</span>(2)</span> (directly or via
<a class="link" href="mail-poll.html" title="mail::account::poll" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::account::poll</span>(3x)</span></a>),
or until the application calls another <span class="application">LibMAIL</span> function.</p>
</div>
</div>
<div class="refsect1" title="SEE ALSO">
<a id="id604145" shape="rect" name="id604145"> </a>
<h2>SEE ALSO</h2>
<p><a class="link" href="mail-open.html" title="mail::account::open" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::account::open</span>(3x)</span></a>,
<a class="link" href="mail-poll.html" title="mail::account::poll" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::account::poll</span>(3x)</span></a>,
<a class="link" href="mail-resume.html" title="mail::account::resume" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::account::resume</span>(3x)</span></a>.</p>
</div>
</div>
<div class="navfooter">
<hr/>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left" rowspan="1" colspan="1">
<a accesskey="p" href="mail-poll.html" shape="rect">Prev</a> </td>
<td width="20%" align="center" rowspan="1" colspan="1">
<a accesskey="u" href="native.html" shape="rect">Up</a></td>
<td width="40%" align="right" rowspan="1" colspan="1">
 <a accesskey="n" href="mail-readmsgattr.html" shape="rect">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top" rowspan="1" colspan="1">mail::account::poll </td>
<td width="20%" align="center" rowspan="1" colspan="1">
<a accesskey="h" href="index.html" shape="rect">Home</a> | <a accesskey="t" href="bk01-toc.html" shape="rect">ToC</a></td>
<td width="40%" align="right" valign="top" rowspan="1" colspan="1"> mail::account::readMessageAttributes</td>
</tr>
</table>
</div>
</body>
</html>
|