DiskFile.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef SQUID_SRC_DISKIO_DISKFILE_H
#define SQUID_SRC_DISKIO_DISKFILE_H
 
#include "base/RefCount.h"
#include "time/gadgets.h"
 
class IORequestor;
 
class ReadRequest;
 
class WriteRequest;
 
class DiskFile : public RefCountable
{
 
public:
 
    class Config
    {
    public:
        Config(): ioTimeout(0), ioRate(-1) {}
 
        time_msec_t ioTimeout; // not enforced if zero, which is the default
 
        int ioRate; // not enforced if negative, which is the default
    };
 
    typedef RefCount<DiskFile> Pointer;
 
    virtual void configure(const Config &) {}
 
    virtual void open(int flags, mode_t mode, RefCount<IORequestor> callback) = 0;
    virtual void create(int flags, mode_t mode, RefCount<IORequestor> callback) = 0;
    virtual void read(ReadRequest *) = 0;
    virtual void write(WriteRequest *) = 0;
    virtual void close() = 0;
    virtual bool canRead() const = 0;
    virtual bool canWrite() const {return true;}
 
    virtual int getFD() const {return -1;}
 
    virtual bool error() const = 0;
 
    virtual bool ioInProgress() const = 0;
};
 
#endif /* SQUID_SRC_DISKIO_DISKFILE_H */