FileIO Class Reference

#include <ored/utilities/fileio.hpp>

Collaboration diagram for FileIO:

Public Member Functions
	FileIO ()=delete

Static Public Member Functions
static QuantLib::Size	maxRetries ()
	The maximum number of retries, defaults to 7. More...
static QuantLib::Real	backoff ()
static QuantLib::Real	maxBackoff ()
static void	setMaxRetries (QuantLib::Size)
static void	setBackoff (QuantLib::Real)
static void	setMaxBackoff (QuantLib::Real)
static FILE *	fopen (const char *, const char *)
	Retry wrapper for std::fopen. More...
static bool	create_directories (const path &)
	Retry wrapper for boost::filesystem::create_directories. More...
static bool	remove_all (const path &)
	Retry wrapper for boost::filesystem::remove_all. More...

Detailed Description

Definition at line 35 of file fileio.hpp.

Constructor & Destructor Documentation

FileIO()

FileIO ( )

delete

Member Function Documentation

maxRetries()

Size maxRetries ( )

static

The maximum number of retries, defaults to 7.

Definition at line 43 of file fileio.cpp.

{ return _s_maxRetries; }

Here is the caller graph for this function:

backoff()

Real backoff ( )

static

Definition at line 45 of file fileio.cpp.

{ return _s_backoff; }

Here is the caller graph for this function:

maxBackoff()

Real maxBackoff ( )

static

Definition at line 47 of file fileio.cpp.

{ return _s_maxBackoff; }

Here is the caller graph for this function:

setMaxRetries()

void setMaxRetries ( QuantLib::Size  )

static

Definition at line 49 of file fileio.cpp.

                                 {
    LOG("Setting FileOpen max retries to " << n);
    _s_maxRetries = n;
}

setBackoff()

void setBackoff ( QuantLib::Real  )

static

Definition at line 54 of file fileio.cpp.

                              {
    LOG("Setting FileOpen backoff to " << b);
    _s_backoff = b;
}

setMaxBackoff()

void setMaxBackoff ( QuantLib::Real  )

static

Definition at line 59 of file fileio.cpp.

                                 {
    LOG("Setting FileOpen max backoff to " << m);
    _s_maxBackoff = m;
}

fopen()

FILE * fopen ( const char *  filename, const char *  mode  )

static

Retry wrapper for std::fopen.

Definition at line 64 of file fileio.cpp.

                                                          {
    FILE* fp;
    Real currentBackoff = backoff();
 
    for (Size i = 0; i <= maxRetries(); i++) {
        if (i > 0) {
            auto em = EventMessage("Error opening file '" + std::string(filename) + "'. Retrying...", "exception_message");
            em.set("retry_count", i);
            Real backoffMillis = currentBackoff * 1000;
            em.set("retry_interval", backoffMillis);
            em.log();
            std::this_thread::sleep_for(std::chrono::duration<Real>(currentBackoff));
            Real nextBackoff = currentBackoff * 2;
            currentBackoff = (nextBackoff >= maxBackoff()) ? maxBackoff() : nextBackoff;
        }
 
        fp = std::fopen(filename, mode);
        if (fp)
            break;
    }
 
    return fp;
}

Here is the call graph for this function:

Here is the caller graph for this function:

create_directories()

bool create_directories ( const path &  p )

static

Retry wrapper for boost::filesystem::create_directories.

Definition at line 88 of file fileio.cpp.

                                             {
    bool res = false;
    Real currentBackoff = backoff();
 
    for (Size i = 0; i <= maxRetries(); i++) {
        if (i > 0) {
            auto em = EventMessage("Error creating directory '" + p.string() + "'. Retrying...", "exception_message");
            em.set("retry_count", i);
            Real backoffMillis = currentBackoff * 1000;
            em.set("retry_interval", backoffMillis);
            em.log();
            std::this_thread::sleep_for(std::chrono::duration<Real>(currentBackoff));
            Real nextBackoff = currentBackoff * 2;
            currentBackoff = (nextBackoff >= maxBackoff()) ? maxBackoff() : nextBackoff;
        }
 
        try {
            res = boost::filesystem::create_directories(p);
            if (res)
                break;
        } catch (...) {
        }
    }
 
    return res;
}

Here is the call graph for this function:

remove_all()

bool remove_all ( const path &  p )

static

Retry wrapper for boost::filesystem::remove_all.

Definition at line 115 of file fileio.cpp.

                                     {
    bool res = false;
    Real currentBackoff = backoff();
 
    for (Size i = 0; i <= maxRetries(); i++) {
        if (i > 0) {
            auto em = EventMessage("Error emptying directory '" + p.string() + "'. Retrying...", "exception_message");
            em.set("retry_count", i);
            Real backoffMillis = currentBackoff * 1000;
            em.set("retry_interval", backoffMillis);
            em.log();
            std::this_thread::sleep_for(std::chrono::duration<Real>(currentBackoff));
            Real nextBackoff = currentBackoff * 2;
            currentBackoff = (nextBackoff >= maxBackoff()) ? maxBackoff() : nextBackoff;
        }
 
        try {
            res = boost::filesystem::remove_all(p);
            if (res)
                break;
        } catch (...) {
        }
    }
 
    return res;
}

Here is the call graph for this function: