progress.h File Reference

#include "squid/stopwatch.h"

Include dependency graph for progress.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	progress_t

Functions
void	NewProgress (progress_t **pprProgress, FILE *prFile, char *pcPrefix, bool bPrintCR)
	Allocates a new progress structure and initialises its members. Free with FreeProgress().
void	FreeProgress (progress_t **pprProgress)
	Frees progress structure and its members.
void	ProgressLog (progress_t *prProgress, unsigned long int iStep, unsigned long int iTotalSteps, bool bForceOutput)
	Prints a progress update (and a carriage return).
void	ProgressDone (progress_t *pprProgress)
	Finishes progress output by printing the elapsed time.

Function Documentation

FreeProgress()

void FreeProgress ( progress_t ** pprProgress )

extern

Frees progress structure and its members.

Parameters

[out]

pprProgress

Pointer pointer to progress structure

See also

NewProgress()

NewProgress()

void NewProgress ( progress_t ** pprProgress, FILE * prFile, char * pcPrefix, bool bPrintCR )

extern

Allocates a new progress structure and initialises its members. Free with FreeProgress().

Note

Starts the internal stopwatch immediatly!

See also

FreeProgress()

Parameters

[out]	pprProgress	Pointer pointer to progress structure. Progress structure will be allocated here.
[in]	prFile	Where to log messages to
[in]	pcPrefix	What prefix to use for messages
[in]	bPrintCR	If TRUE carriage return instead of newline will be printed between log messages

ProgressDone()

void ProgressDone ( progress_t * prProgress )

extern

Finishes progress output by printing the elapsed time.

Parameters

[in]

prProgress

Pointer to the progress structure

ProgressLog()

void ProgressLog ( progress_t * prProgress, unsigned long int iStep, unsigned long int iTotalSteps, bool bForceOutput )

extern

Prints a progress update (and a carriage return).

Parameters

[in]	prProgress	Pointer to the progress structure
[in]	iStep	Current step number
[in]	iTotalSteps	Total step number
[in]	bForceOutput	If percentage hasn't changed output is normally supressed normally. Output can be forced with this flag.