File: CWLocalCacheManager.h

package info (click to toggle)
pantomime 1.3.0%2Bdfsg1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster
  • size: 2,332 kB
  • sloc: objc: 22,026; makefile: 11; sh: 4
file content (106 lines) | stat: -rw-r--r-- 3,209 bytes parent folder | download
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
/*
**  CWLocalCacheManager.h
**
**  Copyright (c) 2001-2007 Ludovic Marcotte
**  Copyright (C) 2013-2018 Riccardo Mottola
**
**  Author: Ludovic Marcotte <ludovic@Sophos.ca>
**          Riccardo Mottola
**          Sebastan Reitenbach
**
**  This library is free software; you can redistribute it and/or
**  modify it under the terms of the GNU Lesser General Public
**  License as published by the Free Software Foundation; either
**  version 2.1 of the License, or (at your option) any later version.
**  
**  This library is distributed in the hope that it will be useful,
**  but WITHOUT ANY WARRANTY; without even the implied warranty of
**  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
**  Lesser General Public License for more details.
**  
** You should have received a copy of the GNU General Public License
** along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef _Pantomime_H_CWLocalCacheManager
#define _Pantomime_H_CWLocalCacheManager

#include <Pantomime/CWCacheManager.h>

@class CWFolder;
@class CWLocalMessage;
@class NSDate;

/*!
  @class CWLocalCacheManager
  @discussion This class provides trivial extensions to the
              CWCacheManager superclass for CWLocalFolder instances.
*/
@interface CWLocalCacheManager: CWCacheManager
{
  @private
    CWFolder *_folder;

    unsigned int _modification_date; // FIXME this should become NSTimeInterval or at least longer
    unsigned int _size;
}

- (void) readAllMessages;
- (void) readMessagesInRange: (NSRange) theRange;

/*!
  @method initWithPath:folder:
  @discussion This is the designated initialization method
              for the local cache manager.
  @param thePath The path where the cache file is.
  @param theFolder The CWLocalFolder instance to be used together
                   with the cache file.
  @result A CWLocalCacheManager instance, nil otherwise.
*/
- (id) initWithPath: (NSString *) thePath  folder: (id) theFolder;

/*!
  @method modificationDate
  @discussion This method is used to obtain the modification date
              of the receiver. That is, the last time the cache
	      was written to disk.
  @result The date.
*/
- (NSDate *) modificationDate;

/*!
  @method setModificationDate:
  @discussion This method is used to set the modification date
              of the receiver. Normally you should not invoke
              this method directly.
  @param theDate The new date value.
*/
- (void) setModificationDate: (NSDate *) theDate;

/*!
  @method fileSize
  @discussion This method is used to obtain the size of the
              associated CWLocalFolder's mailbox.
  @result The size.
*/
- (unsigned int) fileSize;

/*!
  @method setFileSize:
  @discussion This method is used to set the size of the
              associated LocalFolder's mailbox.
	      Normally you should not invoke
              this method directly.
  @param theSize The new size value.
*/
- (void) setFileSize: (unsigned int) theSize;

/*!
  @method writeRecord:
  @discussion This method is used to write a cache record to disk.
  @param theRecord The record to write.
*/
- (void) writeRecord: (cache_record *) theRecord;
@end

#endif // _Pantomime_H_LocalCacheManager