1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
|
/*
* cook - file construction tool
* Copyright (C) 2004, 2006, 2007 Peter Miller;
* All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
*
* MANIFEST: interface definition for fflush_slow.c
*/
#ifndef COMMON_FFLUSH_SLOW_H
#define COMMON_FFLUSH_SLOW_H
#include <common/ac/stdio.h>
#include <common/main.h>
/**
* The fflush_slowly function is used to flush a file stream and check
* success. If errors are encountered allow for a pause and retry.
*
* The functionality and calling interface is identical to the fflush()
* function:
*
* "The function fflush forces a write of all user-space buffered
* data for the given output or update stream via the stream's
* underlying write function. The open status of the stream is
* unaffected."
*
* If errors are encountered allow for a pause and retry. This is
* cultural imperialist tourist mode: When English doesn't work try
* loud, slow English.
*
* @param stream.
* The stream to flush If the stream argument is NULL this function
* flushes all open output streams.
* @returns
* Upon successful completion 0 is returned. Otherwise, EOF is
* returned and the global variable errno is set to indicate the
* error.
*/
int fflush_slowly(FILE *stream);
/**
* The fflush_slowly_report function is used to print how many fflush
* retries were required by the program. Usually only printed in DEBUG
* mode.
*/
void fflush_slowly_report(void);
#endif /* COMMON_FFLUSH_SLOW_H */
|