stream.h
6.25 KB
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
/* GNU Mailutils -- a suite of utilities for electronic mail
Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.
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 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 Lesser General
Public License along with this library; if not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301 USA */
#ifndef _MAILUTILS_STREAM_H
# define _MAILUTILS_STREAM_H
#include <stdio.h>
#include <mailutils/types.h>
#ifdef __cplusplus
extern "C" { /*}*/
#endif
#define MU_STREAM_READ 0x00000001
#define MU_STREAM_WRITE 0x00000002
#define MU_STREAM_RDWR 0x00000004
#define MU_STREAM_APPEND 0x00000008
#define MU_STREAM_CREAT 0x00000010
#define MU_STREAM_NONBLOCK 0x00000020
/* Stream will be destroyed on stream_destroy without checking the owner. */
#define MU_STREAM_NO_CHECK 0x00000040
#define MU_STREAM_SEEKABLE 0x00000080
#define MU_STREAM_NO_CLOSE 0x00000100
#define MU_STREAM_ALLOW_LINKS 0x00000200
#define MU_STREAM_STRICT 0x00000400
/* Functions useful to users of the pre-defined stream types. */
extern int file_stream_create __P ((stream_t *stream, const char* filename,
int flags));
extern int tcp_stream_create __P ((stream_t *stream, const char* host,
int port, int flags));
extern int mapfile_stream_create __P ((stream_t *stream, const char* filename,
int flags));
extern int memory_stream_create __P ((stream_t *stream, const char* filename,
int flags));
extern int encoder_stream_create __P ((stream_t *stream, stream_t iostream,
const char *encoding));
extern int decoder_stream_create __P ((stream_t *stream, stream_t iostream,
const char *encoding));
extern int stdio_stream_create __P ((stream_t *stream, FILE* stdio,
int flags));
extern int prog_stream_create __P ((stream_t *stream, const char *progname,
int flags));
int filter_prog_stream_create __P ((stream_t *stream, const char *progname,
stream_t input));
extern void stream_destroy __P ((stream_t *, void *owner));
extern int stream_open __P ((stream_t));
extern int stream_close __P ((stream_t));
extern int stream_is_seekable __P ((stream_t));
extern int stream_get_transport2 __P ((stream_t stream,
mu_transport_t *pt,
mu_transport_t *pt2));
extern int stream_get_transport __P ((stream_t stream,
mu_transport_t *pt));
extern int stream_read __P ((stream_t, char *, size_t, off_t,
size_t *));
extern int stream_readline __P ((stream_t, char *, size_t, off_t,
size_t *));
extern int stream_size __P ((stream_t, off_t *));
extern int stream_truncate __P ((stream_t, off_t));
extern int stream_write __P ((stream_t, const char *, size_t, off_t,
size_t *));
extern int stream_setbufsiz __P ((stream_t stream, size_t size));
extern int stream_flush __P ((stream_t));
#define MU_STREAM_READY_RD 0x1
#define MU_STREAM_READY_WR 0x2
struct timeval; /* Needed for the following declaration */
extern int stream_wait __P((stream_t stream, int *pflags,
struct timeval *));
/* Functions useful to implementors of new stream types. */
extern int stream_create __P ((stream_t *stream, int flags,
void* owner));
extern void* stream_get_owner __P ((stream_t));
extern void stream_set_owner __P ((stream_t, void* owner));
extern int stream_get_flags __P ((stream_t, int *pflags));
extern int stream_set_flags __P ((stream_t, int flags));
extern int stream_get_property __P ((stream_t, property_t *));
extern int stream_set_property __P ((stream_t, property_t, void *));
#define MU_STREAM_STATE_OPEN 1
#define MU_STREAM_STATE_READ 2
#define MU_STREAM_STATE_WRITE 4
#define MU_STREAM_STATE_CLOSE 8
extern int stream_get_state __P ((stream_t, int *pstate));
extern int stream_set_destroy __P ((stream_t,
void (*_destroy) __PMT ((stream_t)), void *owner));
extern int stream_set_open __P ((stream_t,
int (*_open) __PMT ((stream_t)), void *owner));
extern int stream_set_close __P ((stream_t,
int (*_close) __PMT ((stream_t)), void *owner));
extern int stream_set_get_transport2 __P ((stream_t,
int (*_get_fd) __PMT ((stream_t, mu_transport_t *, mu_transport_t *)),
void *owner));
extern int stream_set_read __P ((stream_t,
int (*_read) __PMT ((stream_t, char *, size_t, off_t, size_t *)),
void *owner));
extern int stream_set_readline __P ((stream_t,
int (*_readline) __PMT ((stream_t, char *, size_t, off_t, size_t *)),
void *owner));
extern int stream_set_size __P ((stream_t,
int (*_size) __PMT ((stream_t, off_t *)), void *owner));
extern int stream_set_truncate __P ((stream_t,
int (*_truncate) __PMT ((stream_t, off_t)), void *owner));
extern int stream_set_write __P ((stream_t,
int (*_write) __PMT ((stream_t, const char *, size_t, off_t, size_t *)),
void *owner));
extern int stream_set_flush __P ((stream_t,
int (*_flush) __PMT ((stream_t)), void *owner));
extern int stream_set_strerror __P ((stream_t stream,
int (*fp) (stream_t, const char **), void *owner));
extern int stream_set_wait __P ((stream_t stream,
int (*wait) (stream_t, int *, struct timeval *), void *owner));
extern int stream_sequential_read __P((stream_t stream,
char *buf, size_t size, size_t *nbytes));
extern int stream_sequential_readline __P((stream_t stream,
char *buf, size_t size, size_t *nbytes));
extern int stream_sequential_write __P((stream_t stream,
const char *buf, size_t size));
extern int stream_seek __P((stream_t stream, off_t off, int whence));
extern int stream_strerror __P((stream_t stream, const char **p));
#ifdef __cplusplus
}
#endif
#endif /* _MAILUTILS_STREAM_H */