sbRequestItem.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2011 POTI, Inc.
 * http://www.songbirdnest.com
 *
 * This file may be licensed under the terms of of the
 * GNU General Public License Version 2 (the ``GPL'').
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the GPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the GPL along with this
 * program. If not, go to http://www.gnu.org/licenses/gpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *=END SONGBIRD GPL
 */

#ifndef SBREQUESTITEM_H_
#define SBREQUESTITEM_H_

// Mozilla includes
#include <nsCOMPtr.h>

// Mozilla interfaces
#include <nsIClassInfo.h>

class sbRequestItem
{
public:

  friend class sbRequestThreadQueue;

  NS_IMETHOD_(nsrefcnt) AddRef(void);
  NS_IMETHOD_(nsrefcnt) Release(void);

  PRUint32 GetRequestId() const
  {
    return mRequestId;
  }

  PRUint32 GetType() const
  {
    return mType;
  }

  void SetType(PRUint32 aType)
  {
    mType = aType;
  }

  PRUint32 GetBatchId() const
  {
    return mBatchId;
  }

  PRUint32 GetBatchIndex() const
  {
    return mBatchIndex;
  }

  void SetBatchIndex(PRInt32 aBatchIndex)
  {
    mBatchIndex = aBatchIndex;
  }


  PRInt64 GetTimeStamp() const
  {
    return mTimeStamp;
  }

  bool GetIsCountable() const
  {
    return mIsCountable;
  }

  bool GetIsProcessed() const
  {
    return mIsProcessed;
  }

  void SetIsProcessed(bool aIsProcessed)
  {
    mIsProcessed = aIsProcessed;
  }

  static sbRequestItem * New(PRUint32 aType, bool aIsCountable = false)
  {
    sbRequestItem * requestItem;
    NS_NEWXPCOM(requestItem, sbRequestItem);
    if (requestItem) {
      requestItem->SetType(aType);
      requestItem->SetIsCountable(aIsCountable);
    }
    return requestItem;
  }

protected:
  sbRequestItem();

  virtual ~sbRequestItem();
  // Protected interface to be used by the request queue and derived classes

  void SetIsCountable(bool aIsCountable)
  {
    mIsCountable = aIsCountable;
  }

private:

  PRUint32 mRequestId;

  PRUint32 mType;

  PRUint32 mBatchId;

  PRUint32 mBatchIndex;

  PRInt64 mTimeStamp;

  bool mIsCountable;

  bool mIsProcessed;

  nsAutoRefCnt mRefCnt;
  static PRInt32 sLastRequestId;
};

#endif