Fix modest_tny_msg_header_get_all_recipients_list (in case from is empty)
[modest] / src / modest-count-stream.h
1 /* Copyright (c) 2007, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  *   notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  *   notice, this list of conditions and the following disclaimer in the
12  *   documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Nokia Corporation nor the names of its
14  *   contributors may be used to endorse or promote products derived from
15  *   this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30
31 /* modest-count-streaml.h */
32
33 #ifndef __MODEST_COUNT_STREAM_H__
34 #define __MODEST_COUNT_STREAM_H__
35
36 #include <glib-object.h>
37 #include <tny-stream.h>
38
39 G_BEGIN_DECLS
40
41 /* convenience macros */
42 #define MODEST_TYPE_COUNT_STREAM             (modest_count_stream_get_type())
43 #define MODEST_COUNT_STREAM(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_COUNT_STREAM,ModestCountStream))
44 #define MODEST_COUNT_STREAM_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_COUNT_STREAM,ModestCountStreamClass))
45 #define MODEST_IS_COUNT_STREAM(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_COUNT_STREAM))
46 #define MODEST_IS_COUNT_STREAM_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_COUNT_STREAM))
47 #define MODEST_COUNT_STREAM_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_COUNT_STREAM,ModestCountStreamClass))
48
49 typedef struct _ModestCountStream      ModestCountStream;
50 typedef struct _ModestCountStreamClass ModestCountStreamClass;
51
52 struct _ModestCountStream {
53         GObject parent;
54 };
55
56 struct _ModestCountStreamClass {
57         GObjectClass parent_class;
58 };
59
60 GType       modest_count_stream_get_type    (void) G_GNUC_CONST;
61
62
63 /**
64  * modest_count_stream_new:
65  * 
66  * creates a new #ModestStream
67  * 
68  * Returns: a new #ModestStream
69  **/
70 TnyStream*    modest_count_stream_new         ();
71
72 /**
73  * modest_count_stream_get_count
74  * @self: the ModestCountStream
75  * 
76  * returns the number of bytes that have been written through this stream
77  * 
78  * Returns: number of bytes that have passed through this stream
79  */
80 gsize           modest_count_stream_get_count (ModestCountStream *self);
81
82 /**
83  * modest_count_stream_reset_count
84  * @self: the ModestCountStream
85  * 
86  * resets the internal counter
87  * 
88  * Returns:
89  */
90 void            modest_count_stream_reset_count (ModestCountStream *self);
91
92
93 G_END_DECLS
94
95 #endif /* __MODEST_COUNT_STREAM_H__ */