SourceFormat Enforcement

[thirdparty/squid.git] / src / DiskIO / DiskDaemon / DiskdIOStrategy.h

diff --git a/src/DiskIO/DiskDaemon/DiskdIOStrategy.h b/src/DiskIO/DiskDaemon/DiskdIOStrategy.h
index 433dd4b28eeb5ab4aa7c19aaf5a3a0db95d25b9e..53faa1fb881970d460ecca6363cf0d7c8bd5182f 100644 (file)
--- a/src/DiskIO/DiskDaemon/DiskdIOStrategy.h
+++ b/src/DiskIO/DiskDaemon/DiskdIOStrategy.h
@@ -1,52 +1,19 @@
-
 /*
- * $Id: DiskdIOStrategy.h,v 1.4 2007/08/16 23:32:28 hno Exp $
- *
- * DEBUG: section 79    Squid-side DISKD I/O functions.
- * AUTHOR: Duane Wessels
- *
- * SQUID Web Proxy Cache          http://www.squid-cache.org/
- * ----------------------------------------------------------
- *
- *  Squid is the result of efforts by numerous individuals from
- *  the Internet community; see the CONTRIBUTORS file for full
- *  details.   Many organizations have provided support for Squid's
- *  development; see the SPONSORS file for full details.  Squid is
- *  Copyrighted (C) 2001 by the Regents of the University of
- *  California; see the COPYRIGHT file for full details.  Squid
- *  incorporates software developed and/or copyrighted by other
- *  sources; see the CREDITS file for full details.
- *
- *  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.
+ * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
  *
- * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
  */
 
+/* DEBUG: section 79    Squid-side DISKD I/O functions. */
+
 #ifndef __STORE_DISKDIOSTRATEGY_H__
 #define __STORE_DISKDIOSTRATEGY_H__
 
-/*
- * magic2 is the point at which we start blocking on msgsnd/msgrcv.
- * If a queue has magic2 (or more) messages away, then we read the
- * queue until the level falls below magic2.  Recommended value
- * is 75% of SHMBUFS. magic1 is the number of messages away which we
- * stop allowing open/create for.
- */
-
 struct diomsg;
 
+/// \ingroup diskd
 class SharedMemory
 {
 
@@ -72,9 +39,10 @@ public:
 class DiskFile;
 
 class DiskdFile;
-
+class Lock;
 class ReadRequest;
 
+/// \ingroup diskd
 class DiskdIOStrategy : public DiskIOStrategy
 {
 
@@ -83,14 +51,16 @@ public:
     virtual bool shedLoad();
     virtual int load();
     virtual RefCount<DiskFile> newFile(char const *path);
+    virtual bool unlinkdUseful() const;
     virtual void unlinkFile (char const *);
     virtual ConfigOption *getOptionTree() const;
     virtual void init();
     virtual void sync();
     virtual int callback();
-    virtual void statfs(StoreEntry & sentry)const;
-    int send(int mtype, int id, DiskdFile *theFile, size_t size, off_t offset, ssize_t shm_offset, RefCountable_ *);
-    /* public for accessing return address's */
+    virtual void statfs(StoreEntry & sentry) const;
+    int send(int mtype, int id, DiskdFile *theFile, size_t size, off_t offset, ssize_t shm_offset, Lock *requestor);
+
+    /** public for accessing return address's */
     SharedMemory shm;
 
 private:
@@ -105,8 +75,21 @@ private:
     int SEND(diomsg * M, int mtype, int id, size_t size, off_t offset, ssize_t shm_offset);
     void handle(diomsg * M);
     void unlinkDone(diomsg * M);
+
+    /**
+     * magic1 is the number of messages away which we
+     * stop allowing open/create for.
+     */
     int magic1;
+
+    /**
+     * magic2 is the point at which we start blocking on msgsnd/msgrcv.
+     * If a queue has magic2 (or more) messages away, then we read the
+     * queue until the level falls below magic2.  Recommended value
+     * is 75% of SHMBUFS.
+     */
     int magic2;
+
     int away;
     int smsgid;
     int rmsgid;
@@ -114,11 +97,11 @@ private:
     size_t instanceID;
 };
 
+/// \ingroup diskd
 #define SHMBUF_BLKSZ SM_PAGE_SIZE
 
-
-struct diskd_stats_t
-{
+/// \ingroup diskd
+struct diskd_stats_t {
     int open_fail_queue_len;
     int block_queue_len;
     int max_away;
@@ -128,8 +111,7 @@ struct diskd_stats_t
     int recv_count;
     int sio_id;
 
-    struct
-    {
+    struct {
         int ops;
         int success;
         int fail;
@@ -138,6 +120,8 @@ struct diskd_stats_t
     open, create, close, unlink, read, write;
 };
 
+/// \ingroup diskd
 extern diskd_stats_t diskd_stats;
 
 #endif
+