1 /*------------------------------------------------------------------------------ 2 * 3 * Copyright (c) 2011-2021, EURid vzw. All rights reserved. 4 * The YADIFA TM software product is provided under the BSD 3-clause license: 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 10 * * Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * * Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * * Neither the name of EURid nor the names of its contributors may be 16 * used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 * 31 *------------------------------------------------------------------------------ 32 * 33 */ 34 35 /** @defgroup streaming Streams 36 * @ingroup dnscore 37 * @brief 38 * 39 * 40 * 41 * @{ 42 * 43 *----------------------------------------------------------------------------*/ 44 #ifndef _FILE_OUTPUT_STREAM_H 45 #define _FILE_OUTPUT_STREAM_H 46 47 #include <dnscore/output_stream.h> 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 ya_result file_output_stream_open(output_stream *os, const char *filename); 54 55 /** 56 * man 2 open 57 */ 58 ya_result file_output_stream_open_ex(output_stream *os, const char *filename,int flags, mode_t mode); 59 60 /* 61 * This version of open_create_ex does NOT log anything, which is very important sometimes in the logger thread 62 */ 63 ya_result file_output_stream_open_ex_nolog(output_stream *os, const char *filename,int flags, mode_t mode); 64 65 void file_output_stream_close_nolog(output_stream* os); 66 67 ya_result file_output_stream_create(output_stream *stream, const char *filename,mode_t mode); 68 69 /** 70 * Returns MAKE_ERRNO_ERROR(EEXIST) if the file exists already. 71 */ 72 73 ya_result file_output_stream_create_excl(output_stream* stream, const char* filename, mode_t mode); 74 75 /** 76 * Enables or disables the write mode of the steam as "full" 77 * In "full" mode, the stream will stay blocked on a write if a recoverable 78 * error occurs. (ie: there is no space left). 79 * 80 * Do NOT use this for the loggers as it would make it impossible to act on HUP 81 * 82 * Main target: journal 83 * 84 * @param stream 85 * @param full_writes 86 * @return 87 */ 88 89 ya_result file_output_stream_set_full_writes(output_stream* stream, bool full_writes); 90 91 ya_result fd_output_stream_attach(output_stream *os, int fd); 92 93 ya_result fd_output_stream_attach_noclose(output_stream *os, int fd); 94 95 void fd_output_stream_detach(output_stream *os); 96 97 ya_result fd_output_stream_get_filedescriptor(output_stream *os); 98 99 s64 fd_output_stream_get_size(output_stream *os); 100 101 bool is_fd_output_stream(output_stream *os); 102 103 void file_output_steam_advise_sequential(output_stream* os); 104 105 #ifdef __cplusplus 106 } 107 #endif 108 109 #endif /* _FILE_OUTPUT_STREAM_H */ 110 /** @} */ 111 112 /*----------------------------------------------------------------------------*/ 113 114 115 116