annotate client.h @ 10:d3fb34cb8198 noffle

[svn] Added comment
author enz
date Tue, 11 Apr 2000 07:50:16 +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 client.h
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
3
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
4 Noffle acting as client to other NNTP-servers
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
5
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
6 $Id: client.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 CLIENT_H
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
10 #define CLIENT_H
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
11
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
12 #include <time.h>
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
13 #include "common.h"
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
14 #include "database.h"
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
15 #include "fetchlist.h"
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
16
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
17 /* Format of server name: <host>[:<port>] */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
18 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
19 Client_connect( const char *serv );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
20
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
21 void
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
22 Client_disconnect( void );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
23
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
24 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
25 Client_getGrps( void );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
26
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
27 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
28 Client_getDsc( void );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
29
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
30 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
31 Client_getCreationTimes( void );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
32
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
33 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
34 Client_getNewgrps( const time_t *lastTime );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
35
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
36 /*
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
37 Change to group <name> at server if it is also in current local grouplist.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
38 Returns TRUE at success.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
39 */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
40 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
41 Client_changeToGrp( const Str name );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
42
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
43 /*
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
44 Get overviews <rmtFirst> - <rmtLast> from server and append it
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
45 to the current content. For articles that are to be fetched due to FULL
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
46 or THREAD mode, store IDs in request database.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
47 */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
48 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
49 Client_getOver( int rmtFirst, int rmtLast, FetchMode mode );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
50
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
51 /*
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
52 Retrieve full article text and store it into database.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
53 */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
54 void
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
55 Client_retrieveArt( const char *msgId );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
56
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
57 /*
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
58 Same, but for a list of msgId's (new line after each msgId).
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
59 All ARTICLE commands are sent and then all answers read.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
60 */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
61 void
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
62 Client_retrieveArtList( const char *list );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
63
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
64 /*
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
65 Store IDs of first and last article of group selected by
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
66 Client_changeToGroup at remote server.
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
67 */
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
68 void
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
69 Client_rmtFirstLast( int *first, int *last );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
70
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
71 Bool
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
72 Client_postArt( const char *msgId, const char *artTxt, Str errStr );
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
73
04124a4423d4 [svn] Initial revision
enz
parents:
diff changeset
74 #endif