freebsd-dev/contrib/csup/stream.h

85 lines
3.2 KiB
C
Raw Normal View History

2006-03-03 04:11:29 +00:00
/*-
* Copyright (c) 2003-2006, Maxime Henrion <mux@FreeBSD.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
#ifndef _STREAM_H_
#define _STREAM_H_
#include "misc.h"
/* Stream filters. */
typedef enum {
STREAM_FILTER_NULL,
STREAM_FILTER_ZLIB,
2008-10-19 09:08:59 +00:00
STREAM_FILTER_MD5,
STREAM_FILTER_MD5RCS
2006-03-03 04:11:29 +00:00
} stream_filter_t;
struct stream;
2008-10-19 09:08:59 +00:00
struct buf;
2006-03-03 04:11:29 +00:00
typedef ssize_t stream_readfn_t(void *, void *, size_t);
typedef ssize_t stream_writefn_t(void *, const void *, size_t);
typedef int stream_closefn_t(void *);
/* Convenience functions for handling file descriptors. */
stream_readfn_t stream_read_fd;
stream_writefn_t stream_write_fd;
stream_closefn_t stream_close_fd;
2008-10-19 09:08:59 +00:00
/* Convenience functions for handling character buffers. */
stream_readfn_t stream_read_buf;
stream_writefn_t stream_append_buf;
stream_closefn_t stream_close_buf;
2006-03-03 04:11:29 +00:00
struct stream *stream_open(void *, stream_readfn_t *, stream_writefn_t *,
stream_closefn_t *);
struct stream *stream_open_fd(int, stream_readfn_t *, stream_writefn_t *,
stream_closefn_t *);
2008-10-19 09:08:59 +00:00
struct stream *stream_open_buf(struct buf *);
2006-03-03 04:11:29 +00:00
struct stream *stream_open_file(const char *, int, ...);
int stream_fileno(struct stream *);
ssize_t stream_read(struct stream *, void *, size_t);
2008-10-19 09:08:59 +00:00
ssize_t stream_read_blocking(struct stream *, void *, size_t);
2006-03-03 04:11:29 +00:00
ssize_t stream_write(struct stream *, const void *, size_t);
char *stream_getln(struct stream *, size_t *);
int stream_printf(struct stream *, const char *, ...)
__printflike(2, 3);
int stream_flush(struct stream *);
int stream_sync(struct stream *);
int stream_truncate(struct stream *, off_t);
2008-10-19 09:08:59 +00:00
void stream_truncate_buf(struct buf *, off_t);
2006-03-03 04:11:29 +00:00
int stream_truncate_rel(struct stream *, off_t);
int stream_rewind(struct stream *);
int stream_eof(struct stream *);
int stream_close(struct stream *);
int stream_filter_start(struct stream *, stream_filter_t, void *);
void stream_filter_stop(struct stream *);
2008-10-19 09:08:59 +00:00
struct buf *buf_new(size_t);
void buf_free(struct buf *);
2006-03-03 04:11:29 +00:00
#endif /* !_STREAM_H_ */