stream.h revision 156231 
1/*-
2 * Copyright (c) 2003-2006, Maxime Henrion <mux@FreeBSD.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. 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 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/contrib/csup/stream.h 156231 2006-03-03 04:11:29Z mux $
27 */
28#ifndef _STREAM_H_
29#define _STREAM_H_
30
31#include "misc.h"
32
33/* Stream filters. */
34typedef enum {
35	STREAM_FILTER_NULL,
36	STREAM_FILTER_ZLIB,
37	STREAM_FILTER_MD5
38} stream_filter_t;
39
40struct stream;
41
42typedef ssize_t	stream_readfn_t(void *, void *, size_t);
43typedef ssize_t	stream_writefn_t(void *, const void *, size_t);
44typedef int	stream_closefn_t(void *);
45
46/* Convenience functions for handling file descriptors. */
47stream_readfn_t		stream_read_fd;
48stream_writefn_t	stream_write_fd;
49stream_closefn_t	stream_close_fd;
50
51struct stream	*stream_open(void *, stream_readfn_t *, stream_writefn_t *,
52		     stream_closefn_t *);
53struct stream	*stream_open_fd(int, stream_readfn_t *, stream_writefn_t *,
54		     stream_closefn_t *);
55struct stream	*stream_open_file(const char *, int, ...);
56int		 stream_fileno(struct stream *);
57ssize_t		 stream_read(struct stream *, void *, size_t);
58ssize_t		 stream_write(struct stream *, const void *, size_t);
59char		*stream_getln(struct stream *, size_t *);
60int		 stream_printf(struct stream *, const char *, ...)
61		     __printflike(2, 3);
62int		 stream_flush(struct stream *);
63int		 stream_sync(struct stream *);
64int		 stream_truncate(struct stream *, off_t);
65int		 stream_truncate_rel(struct stream *, off_t);
66int		 stream_rewind(struct stream *);
67int		 stream_eof(struct stream *);
68int		 stream_close(struct stream *);
69int		 stream_filter_start(struct stream *, stream_filter_t, void *);
70void		 stream_filter_stop(struct stream *);
71
72#endif /* !_STREAM_H_ */
73