afw_stream.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Stream Implementation Header
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_STREAM_H__
#define __AFW_STREAM_H__
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
typedef enum {
    afw_stream_number_raw_response_body,
    afw_stream_number_response_body,
    afw_stream_number_console,
    afw_stream_number_stderr,
    afw_stream_number_stdout,
    afw_stream_number_count  /* Count is also max enum value + 1 */
} afw_stream_number_t;
 
 
struct afw_stream_anchor_s {
    afw_size_t maximum_number_of_streams;
    const afw_stream_t * const *streams;
    const afw_utf8_t *last_stream_error;
};
 
 
 
AFW_DECLARE(void)
afw_stream_get_by_streamId(
    const afw_utf8_t *streamId,
    const afw_stream_t **stream,
    afw_size_t *streamNumber,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_stream_t *)
afw_stream_get_by_streamNumber(
    const afw_integer_t streamNumber,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(afw_size_t)
afw_stream_get_streamNumber_for_streamId(
    const afw_utf8_t *streamId,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(afw_size_t)
afw_stream_set(
    const afw_stream_t *stream,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_stream_t *)
afw_stream_standard_impl(afw_stream_number_t n, afw_xctx_t *xctx);
 
 
 
#define afw_stream_standard(enum_suffix, xctx) \
(((xctx)->stream_anchor->streams[afw_stream_number_ ## enum_suffix]) \
? (xctx)->stream_anchor->streams[afw_stream_number_ ## enum_suffix] \
: afw_stream_standard_impl(afw_stream_number_ ## enum_suffix, xctx) )
 
 
 
#define afw_stream_standard_is_set(enum_suffix, xctx) \
((xctx)->stream_anchor->streams[afw_stream_number_ ## enum_suffix] != NULL )
 
 
 
#define afw_stream_standard_set(enum_suffix, stream, xctx) \
if ((xctx)->stream_anchor->streams[afw_stream_number_ ## enum_suffix]) { \
    AFW_THROW_ERROR(general, "Stream already set", xctx); \
} \
(xctx)->stream_anchor->streams[afw_stream_number_ ## enum_suffix] = stream
 
 
 
#define afw_stream_standard_release(enum_suffix, xctx) \
if ((xctx)->stream_anchor->streams[afw_stream_number_ ## enum_suffix]) { \
    afw_stream_release( \
        (xctx)->stream_anchor->streams[afw_stream_number_ ## enum_suffix], \
        xctx); \
    *(afw_stream_t **)&(xctx)->stream_anchor-> \
        streams[afw_stream_number_ ## enum_suffix] = NULL; \
}
 
 
 
#define afw_stream_write_z(writer, s_z, xctx) \
afw_stream_write(writer, s_z, strlen(s_z), xctx)
 
 
 
#define afw_stream_write_eol(writer, xctx) \
afw_stream_write(writer, "\n", strlen("\n"), xctx)
 
 
 
#define afw_stream_write_utf8(writer, S, xctx) \
afw_stream_write(writer, (S)->s, (S)->len, xctx)
 
 
 
AFW_DECLARE(void)
afw_stream_write_integer(
    const afw_stream_t *writer,
    afw_integer_t integer,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_stream_write_size(
    const afw_stream_t *writer,
    afw_size_t size,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_stream_t *)
afw_stream_fd_create(
    FILE *fd,
    const afw_utf8_t *streamId,
    afw_boolean_t allow_read,
    afw_boolean_t allow_write,
    afw_boolean_t auto_flush,
    afw_boolean_t close_on_release,
    const afw_pool_t * p,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(const afw_stream_t *)
afw_stream_fd_open_and_create(
    const afw_utf8_t *streamId,
    const afw_utf8_t *path,
    const afw_utf8_t *mode,
    afw_boolean_t auto_flush,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
 
AFW_DEFINE_INTERNAL(const afw_stream_anchor_t *)
afw_stream_internal_stream_anchor_create(afw_xctx_t *xctx);
 
 
 
AFW_DEFINE_INTERNAL(void)
afw_stream_internal_release_all_streams(afw_xctx_t *xctx);
 
 
AFW_END_DECLARES
 
#endif /* __AFW_STREAM_H__ */