gecko/netwerk/cache2/CacheIndexIterator.h
Birunthan Mohanathas 47ed3a3675 Bug 1182996 - Fix and add missing namespace comments. rs=ehsan
The bulk of this commit was generated by running:

  run-clang-tidy.py \
    -checks='-*,llvm-namespace-comment' \
    -header-filter=^/.../mozilla-central/.* \
    -fix
2015-07-13 08:25:42 -07:00

61 lines
1.6 KiB
C++

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef CacheIndexIterator__h__
#define CacheIndexIterator__h__
#include "nsTArray.h"
#include "nsCOMPtr.h"
#include "nsAutoPtr.h"
#include "mozilla/SHA1.h"
namespace mozilla {
namespace net {
class CacheIndex;
struct CacheIndexRecord;
class CacheIndexIterator
{
public:
NS_INLINE_DECL_THREADSAFE_REFCOUNTING(CacheIndexIterator)
CacheIndexIterator(CacheIndex *aIndex, bool aAddNew);
protected:
virtual ~CacheIndexIterator();
public:
// Returns a hash of a next entry. If there is no entry NS_ERROR_NOT_AVAILABLE
// is returned and the iterator is closed. Other error is returned when the
// iterator is closed for other reason, e.g. shutdown.
nsresult GetNextHash(SHA1Sum::Hash *aHash);
// Closes the iterator. This means the iterator is removed from the list of
// iterators in CacheIndex.
nsresult Close();
protected:
friend class CacheIndex;
nsresult CloseInternal(nsresult aStatus);
bool ShouldBeNewAdded() { return mAddNew; }
virtual void AddRecord(CacheIndexRecord *aRecord);
virtual void AddRecords(const nsTArray<CacheIndexRecord *> &aRecords);
bool RemoveRecord(CacheIndexRecord *aRecord);
bool ReplaceRecord(CacheIndexRecord *aOldRecord,
CacheIndexRecord *aNewRecord);
nsresult mStatus;
nsRefPtr<CacheIndex> mIndex;
nsTArray<CacheIndexRecord *> mRecords;
bool mAddNew;
};
} // namespace net
} // namespace mozilla
#endif