stream.h revision 256281 
1230479Snetchild/*-
2230479Snetchild * Copyright (c) 2003-2006, Maxime Henrion <mux@FreeBSD.org>
3230479Snetchild * All rights reserved.
4230479Snetchild *
5230479Snetchild * Redistribution and use in source and binary forms, with or without
6230479Snetchild * modification, are permitted provided that the following conditions
7230479Snetchild * are met:
8230479Snetchild * 1. Redistributions of source code must retain the above copyright
9230479Snetchild *    notice, this list of conditions and the following disclaimer.
10230479Snetchild * 2. Redistributions in binary form must reproduce the above copyright
11230479Snetchild *    notice, this list of conditions and the following disclaimer in the
12230479Snetchild *    documentation and/or other materials provided with the distribution.
13230479Snetchild *
14230479Snetchild * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15230479Snetchild * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16230479Snetchild * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17230479Snetchild * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18230479Snetchild * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19230479Snetchild * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20230479Snetchild * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21230479Snetchild * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22230479Snetchild * 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: stable/10/usr.bin/csup/stream.h 204556 2010-03-02 07:26:07Z lulf $
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_MD5RCS
39} stream_filter_t;
40
41struct stream;
42struct buf;
43
44typedef ssize_t	stream_readfn_t(void *, void *, size_t);
45typedef ssize_t	stream_writefn_t(void *, const void *, size_t);
46typedef int	stream_closefn_t(void *);
47
48/* Convenience functions for handling file descriptors. */
49stream_readfn_t		stream_read_fd;
50stream_writefn_t	stream_write_fd;
51stream_closefn_t	stream_close_fd;
52
53/* Convenience functions for handling character buffers. */
54stream_readfn_t		stream_read_buf;
55stream_writefn_t	stream_append_buf;
56stream_closefn_t	stream_close_buf;
57
58struct stream	*stream_open(void *, stream_readfn_t *, stream_writefn_t *,
59		     stream_closefn_t *);
60struct stream	*stream_open_fd(int, stream_readfn_t *, stream_writefn_t *,
61		     stream_closefn_t *);
62struct stream	*stream_open_buf(struct buf *);
63struct stream	*stream_open_file(const char *, int, ...);
64int		 stream_fileno(struct stream *);
65ssize_t		 stream_read(struct stream *, void *, size_t);
66ssize_t		 stream_read_blocking(struct stream *, void *, size_t);
67ssize_t		 stream_write(struct stream *, const void *, size_t);
68char		*stream_getln(struct stream *, size_t *);
69int		 stream_printf(struct stream *, const char *, ...)
70		     __printflike(2, 3);
71int		 stream_flush(struct stream *);
72int		 stream_sync(struct stream *);
73int		 stream_truncate(struct stream *, off_t);
74void		 stream_truncate_buf(struct buf *, off_t);
75int		 stream_truncate_rel(struct stream *, off_t);
76int		 stream_rewind(struct stream *);
77int		 stream_eof(struct stream *);
78int		 stream_close(struct stream *);
79int		 stream_filter_start(struct stream *, stream_filter_t, void *);
80void		 stream_filter_stop(struct stream *);
81
82struct buf	*buf_new(size_t);
83void		 buf_free(struct buf *);
84#endif /* !_STREAM_H_ */
85