api/streams_8h_source.html

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2021 Mike Becker, Olaf Wintermann 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 COPYRIGHT HOLDERS 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 COPYRIGHT HOLDER 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.

 */


#ifndef UCX_STREAMS_H

#define UCX_STREAMS_H


#include "common.h"


#ifdef __cplusplus

extern "C" {

#endif


cx_attr_nonnull_arg(1, 2, 3, 4)

cx_attr_access_r(1)

cx_attr_access_w(2)

cx_attr_access_w(5)

cx_attr_export

size_t cx_stream_bncopy(

        void *src,

        void *dest,

        cx_read_func rfnc,

        cx_write_func wfnc,

        char *buf,

        size_t bufsize,

        size_t n

);


#define cx_stream_bcopy(src, dest, rfnc, wfnc, buf, bufsize) \

    cx_stream_bncopy(src, dest, rfnc, wfnc, buf, bufsize, SIZE_MAX)


cx_attr_nonnull

cx_attr_access_r(1)

cx_attr_access_w(2)

cx_attr_export

size_t cx_stream_ncopy(

        void *src,

        void *dest,

        cx_read_func rfnc,

        cx_write_func wfnc,

        size_t n

);


#define cx_stream_copy(src, dest, rfnc, wfnc) \

    cx_stream_ncopy(src, dest, rfnc, wfnc, SIZE_MAX)


#ifdef __cplusplus

}

#endif


#endif // UCX_STREAMS_H

common.h
Common definitions and feature checks.

cx_attr_export
#define cx_attr_export
Only used for building Windows DLLs.
Definition common.h:285

cx_attr_nonnull
#define cx_attr_nonnull
All pointer arguments must be non-NULL.
Definition common.h:136

cx_write_func
size_t(* cx_write_func)(const void *, size_t, size_t, void *)
Function pointer compatible with fwrite-like functions.
Definition common.h:295

cx_read_func
size_t(* cx_read_func)(void *, size_t, size_t, void *)
Function pointer compatible with fread-like functions.
Definition common.h:305

cx_attr_access_w
#define cx_attr_access_w(...)
Specifies that the function will only write through the given pointer.
Definition common.h:241

cx_attr_access_r
#define cx_attr_access_r(...)
Specifies that the function will only read through the given pointer.
Definition common.h:225

cx_attr_nonnull_arg
#define cx_attr_nonnull_arg(...)
The specified pointer arguments must be non-NULL.
Definition common.h:141

cx_stream_ncopy
size_t cx_stream_ncopy(void *src, void *dest, cx_read_func rfnc, cx_write_func wfnc, size_t n)
Reads data from a stream and writes it to another stream.

cx_stream_bncopy
size_t cx_stream_bncopy(void *src, void *dest, cx_read_func rfnc, cx_write_func wfnc, char *buf, size_t bufsize, size_t n)
Reads data from a stream and writes it to another stream.