Squid Web Cache master
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Static Private Member Functions | Static Private Attributes | List of all members
DiskIOModule Class Referenceabstract

#include <DiskIOModule.h>

Inheritance diagram for DiskIOModule:
[legend]
Collaboration diagram for DiskIOModule:
[legend]

Public Types

typedef std::vector< DiskIOModule * >::iterator iterator
 
typedef std::vector< DiskIOModule * >::const_iterator const_iterator
 

Public Member Functions

 DiskIOModule ()
 
virtual ~DiskIOModule ()
 
virtual void init ()=0
 
virtual void gracefulShutdown ()=0
 
virtual DiskIOStrategy * createStrategy ()=0
 
virtual char const * type () const =0
 
 DiskIOModule (DiskIOModule const &)
 
DiskIOModule & operator= (DiskIOModule const &)
 

Static Public Member Functions

static void SetupAllModules ()
 
static void ModuleAdd (DiskIOModule &)
 
static void FreeAllModules ()
 
static DiskIOModule * Find (char const *type)
 
static DiskIOModule * FindDefault ()
 
static std::vector< DiskIOModule * > const & Modules ()
 

Static Protected Member Functions

static void RegisterAllModulesWithCacheManager (void)
 

Static Private Member Functions

static std::vector< DiskIOModule * > & GetModules ()
 

Static Private Attributes

static std::vector< DiskIOModule * > * _Modules = nullptr
 

Detailed Description

Definition at line 20 of file DiskIOModule.h.

Member Typedef Documentation

◆ const_iterator

typedef std::vector<DiskIOModule*>::const_iterator DiskIOModule::const_iterator

Definition at line 37 of file DiskIOModule.h.

◆ iterator

typedef std::vector<DiskIOModule*>::iterator DiskIOModule::iterator

Definition at line 36 of file DiskIOModule.h.

Constructor & Destructor Documentation

◆ DiskIOModule() [1/2]

DiskIOModule::DiskIOModule ( )

We cannot call ModuleAdd(*this) here as the virtual methods are not yet available. We leave that to SetupAllModules() later.

Definition at line 36 of file DiskIOModule.cc.

◆ ~DiskIOModule()

virtual DiskIOModule::~DiskIOModule ( )
inlinevirtual

Definition at line 39 of file DiskIOModule.h.

◆ DiskIOModule() [2/2]

DiskIOModule::DiskIOModule ( DiskIOModule const &  )

Definition at line 25 of file stub_libdiskio.cc.

References STUB.

Member Function Documentation

◆ createStrategy()

virtual DiskIOStrategy * DiskIOModule::createStrategy ( )
pure virtual

Implemented in BlockingDiskIOModule, DiskDaemonDiskIOModule, DiskThreadsDiskIOModule, IpcIoDiskIOModule, and MmappedDiskIOModule.

◆ Find()

DiskIOModule * DiskIOModule::Find ( char const *  type)
static

Definition at line 114 of file DiskIOModule.cc.

References GetModules(), and type().

Referenced by Fs::Ufs::UFSSwapDir::UFSSwapDir(), FindDefault(), Rock::SwapDir::init(), Rock::SwapDir::needsDiskStrand(), and TestUfs::testUfsSearch().

◆ FindDefault()

DiskIOModule * DiskIOModule::FindDefault ( )
static

Find any usable disk module. This will look for the 'best' available module for this system.

Best IO options are in order:

Definition at line 124 of file DiskIOModule.cc.

References Find().

◆ FreeAllModules()

void DiskIOModule::FreeAllModules ( )
static

Called when a graceful shutdown is to occur of each fs module.

Definition at line 104 of file DiskIOModule.cc.

References GetModules(), and gracefulShutdown().

Referenced by SquidShutdown().

◆ GetModules()

std::vector< DiskIOModule * > & DiskIOModule::GetModules ( )
staticprivate

Definition at line 91 of file DiskIOModule.cc.

References _Modules.

Referenced by Find(), FreeAllModules(), ModuleAdd(), Modules(), and SetupAllModules().

◆ gracefulShutdown()

virtual void DiskIOModule::gracefulShutdown ( )
pure virtual

Implemented in BlockingDiskIOModule, DiskDaemonDiskIOModule, DiskThreadsDiskIOModule, IpcIoDiskIOModule, and MmappedDiskIOModule.

Referenced by FreeAllModules().

◆ init()

virtual void DiskIOModule::init ( )
pure virtual

Implemented in BlockingDiskIOModule, DiskDaemonDiskIOModule, DiskThreadsDiskIOModule, IpcIoDiskIOModule, and MmappedDiskIOModule.

◆ ModuleAdd()

void DiskIOModule::ModuleAdd ( DiskIOModule &  instance)
static

Definition at line 72 of file DiskIOModule.cc.

References assert, GetModules(), and type().

Referenced by BlockingDiskIOModule::BlockingDiskIOModule(), DiskDaemonDiskIOModule::DiskDaemonDiskIOModule(), DiskThreadsDiskIOModule::DiskThreadsDiskIOModule(), IpcIoDiskIOModule::IpcIoDiskIOModule(), and MmappedDiskIOModule::MmappedDiskIOModule().

◆ Modules()

std::vector< DiskIOModule * > const & DiskIOModule::Modules ( )
static

Definition at line 85 of file DiskIOModule.cc.

References GetModules().

◆ operator=()

DiskIOModule & DiskIOModule::operator= ( DiskIOModule const &  )

Definition at line 26 of file stub_libdiskio.cc.

References STUB.

◆ RegisterAllModulesWithCacheManager()

static void DiskIOModule::RegisterAllModulesWithCacheManager ( void  )
staticprotected

◆ SetupAllModules()

void DiskIOModule::SetupAllModules ( )
static

Poke all compiled modules for self-setup

Definition at line 45 of file DiskIOModule.cc.

References BlockingDiskIOModule::GetInstance(), DiskDaemonDiskIOModule::GetInstance(), DiskThreadsDiskIOModule::GetInstance(), IpcIoDiskIOModule::GetInstance(), MmappedDiskIOModule::GetInstance(), and GetModules().

Referenced by SquidMain().

◆ type()

virtual char const * DiskIOModule::type ( ) const
pure virtual

Implemented in BlockingDiskIOModule, DiskDaemonDiskIOModule, DiskThreadsDiskIOModule, IpcIoDiskIOModule, and MmappedDiskIOModule.

Referenced by Fs::Ufs::UFSSwapDir::changeIO(), Find(), and ModuleAdd().

Member Data Documentation

◆ _Modules

std::vector< DiskIOModule * > * DiskIOModule::_Modules = nullptr
staticprivate

Definition at line 57 of file DiskIOModule.h.

Referenced by GetModules().

The documentation for this class was generated from the following files: