annotate request.h @ 15:54f08929b195 noffle

[svn] Bring up to date
author enz
date Sat, 29 Apr 2000 13:22:25 +0100
parents 04124a4423d4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
1 /*
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
2 request.h
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
3
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
4 Collection of requested articles.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
5
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
6 $Id: request.h 3 2000-01-04 11:35:42Z enz $
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
7 */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
8
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
9 #ifndef REQ_H
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
10 #define REQ_H
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
11
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
12 #include "common.h"
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
13
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
14 /* Is request for message msgId from server serv already recorded? This
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
15 function has no error detection facility. On error, FALSE is returned.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
16 Nevertheless, errors are logged. */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
17 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
18 Req_contains( const char *serv, const char *msgId );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
19
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
20 /* Add request for message "msgId" from server "serv". Return TRUE if
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
21 successful. */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
22 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
23 Req_add( const char *serv, const char *msgId );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
24
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
25 /* Remove request for message msgIg from server serv. This function does
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
26 not return any errors. Nevertheless, they are logged. */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
27 void
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
28 Req_remove( const char *serv, const char *msgId );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
29
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
30 /* Begin iteration through all messages requested from one server. Return
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
31 TRUE if there are any requests. Save first message ID in msgId. On
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
32 error, it is logged, and FALSE is returned.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
33 */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
34 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
35 Req_first( const char *serv, Str msgId );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
36
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
37 /* Continue iteration. Return TRUE on success, FALSE when there are no more
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
38 requests. Save message ID in msgId. On error, it is logged, and FALSE is
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
39 returned. */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
40 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
41 Req_next( Str msgId );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
42
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
43 /* Get exclusive access to the request files. Refresh cache as necessary. */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
44 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
45 Req_open(void);
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
46
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
47 /* Write changes to disk */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
48 void
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
49 Req_close(void);
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
50
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
51 #endif