prj/tech/libsrc/res/resarq.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // $Source: x:/prj/tech/libsrc/res/RCS/resarq.h $
   3 // $Author: TOML $
   4 // $Date: 1997/08/12 12:19:14 $
   5 // $Revision: 1.9 $
   6 //
   7
   8 #ifndef __RESARQ_H
   9 #define __RESARQ_H
  10
  11 EXTERN void LGAPI ResARQClearPreload(Id id);
  12
  13 #if defined(__ARQAPI_H) && defined(__cplusplus)
  14
  15 #include <pool.h>
  16 #include <hashset.h>
  17
  18 #include <pshpack4.h>
  19
  20 ///////////////////////////////////////////////////////////////////////////////
  21 //
  22 // CLASS: cResARQ
  23 //
  24
  25 class cResARQFulfiller : public IAsyncReadFulfiller
  26     {
  27 public:
  28     cResARQFulfiller();
  29     ~cResARQFulfiller();
  30
  31     ///////////////////////////////////
  32
  33     void    Init();
  34     void    Term();
  35
  36     ///////////////////////////////////
  37
  38     BOOL    Lock(Id id, int priority);
  39     BOOL    Extract(Id id, int priority, void *buf, long bufSize);
  40     BOOL    Preload(Id id);
  41     BOOL    IsFulfilled(Id id);
  42     HRESULT Kill(Id id);
  43     HRESULT GetResult(Id id, void **);
  44
  45     void ClearPreload(Id id);
  46     BOOL IsAsynchronous();
  47
  48     ///////////////////////////////////
  49
  50     STDMETHOD (DoFulfill)(const sARQRequest *, sARQResult *);
  51     STDMETHOD (DoKill)(const sARQRequest *, BOOL fDiscard);
  52
  53     DECLARE_UNAGGREGATABLE();
  54
  55     ///////////////////////////////////
  56
  57 private:
  58
  59     struct sResRequest;
  60     class cResControlTable : public cHashSet<sResRequest *, Id *, cHashFunctions>
  61         {
  62     private:
  63         virtual tHashSetKey GetKey(tHashSetNode node) const;
  64         };
  65
  66     ///////////////////////////////////
  67     //
  68     // Asynchronous resource requests are tracked using a hash table of
  69     // sResRequest structures
  70     //
  71
  72     struct sResRequest
  73         {
  74         enum eRequestKind
  75             {
  76             kLock,
  77             kExtract,
  78             kPreload
  79             };
  80
  81         ///////////////////////////////
  82
  83         sResRequest(cResControlTable &  owningControlTable,
  84                     Id id, int priority, eRequestKind kind,
  85                     void * pBuf = NULL, long bufSize = 0)
  86           : pControl(NULL),
  87             id(id),
  88             priority(priority),
  89             pBuf(pBuf),
  90             bufSize(bufSize),
  91             nRequests(0),
  92             kind(kind),
  93             m_OwningControlTable(owningControlTable)
  94             {
  95             m_OwningControlTable.Insert(this);
  96             }
  97
  98         ~sResRequest()
  99             {
 100             Verify(m_OwningControlTable.Remove(this));
 101             if (pControl)
 102                 pControl->Release();
 103             memset(this, 0xfe, sizeof(sResRequest));
 104             }
 105
 106         ///////////////////////////////
 107
 108         IAsyncReadControl * pControl;
 109         Id                  id;
 110         int                 priority;
 111         eRequestKind        kind;
 112         void *              pBuf;
 113         long                bufSize;
 114         unsigned            nRequests;
 115
 116         cResControlTable &  m_OwningControlTable;
 117
 118         ///////////////////////////////
 119
 120         DECLARE_POOL();
 121
 122         };
 123
 124     ///////////////////////////////////
 125
 126     BOOL    QueueRequest(Id id, int priority, sResRequest::eRequestKind, void *buf = NULL, long bufSize = 0);
 127     HRESULT SatisfyRequest(sResRequest *, void **);
 128
 129     ///////////////////////////////////
 130
 131     IAsyncReadQueue *       m_pAsyncReadQueue;
 132     cResControlTable        m_Controls;
 133
 134     BOOL                    m_fSatisfyingPreload;
 135
 136     };
 137
 138 ///////////////////////////////////////
 139
 140 inline BOOL cResARQFulfiller::Lock(Id id, int priority)
 141     {
 142     return QueueRequest(id, priority, sResRequest::kLock);
 143     }
 144
 145 ///////////////////////////////////////
 146
 147 inline BOOL cResARQFulfiller::Extract(Id id, int priority, void *buf, long bufSize)
 148     {
 149     return QueueRequest(id, priority, sResRequest::kExtract, buf, bufSize);
 150     }
 151
 152 ///////////////////////////////////////
 153
 154 inline BOOL cResARQFulfiller::Preload(Id id)
 155     {
 156     return QueueRequest(id, kPriorityLowest, sResRequest::kPreload);
 157     }
 158
 159 ///////////////////////////////////////
 160
 161 inline BOOL cResARQFulfiller::IsAsynchronous()
 162     {
 163     return !!m_pAsyncReadQueue;
 164     }
 165
 166 ///////////////////////////////////////////////////////////////////////////////
 167
 168 #include <poppack.h>
 169
 170 #endif
 171
 172
 173 #endif /* !__RESARQ_H */