author Alessio Placitelli <>
Mon, 22 May 2017 12:52:19 +0200
changeset 360776 ad54e4734e9b4d8e76fd72bcc5bdb8fec17ec17e
parent 351398 c1ae2c3b3905ff1dce6918edfc01affacf7acf00
child 388790 905239391e05483e8fb221378dd2092c5a0df8b7
permissions -rw-r--r--
Bug 1364068 - Enable the 'new-profile' ping. r=gfritzsche MozReview-Commit-ID: 6DXa20aCOBr

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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 */

// nsRepeatService
#ifndef nsRepeatService_h__
#define nsRepeatService_h__

#include "nsCOMPtr.h"
#include "nsITimer.h"


#ifdef XP_MACOSX
#define REPEAT_DELAY        25
#define REPEAT_DELAY        50

class nsIDocument;
class nsITimer;

class nsRepeatService final
  typedef void (* Callback)(void* aData);


  // Start dispatching timer events to the callback. There is no memory
  // management of aData here; it is the caller's responsibility to call
  // Stop() before aData's memory is released.
  // aCallbackName is the label of the callback, used to pass to
  // InitWithNamedCallbackFunc.
  // aDocument is used to get the event target in Start(). We need an event
  // target to init mRepeatTimer.
  void Start(Callback aCallback, void* aCallbackData,
             nsIDocument* aDocument, const nsACString& aCallbackName,
             uint32_t aInitialDelay = INITAL_REPEAT_DELAY);
  // Stop dispatching timer events to the callback. If the repeat service
  // is not currently configured with the given callback and data, this
  // is just ignored.
  void Stop(Callback aCallback, void* aData);

  static nsRepeatService* GetInstance();
  static void Shutdown();


  // helper function to initialize callback function to mRepeatTimer
  void InitTimerCallback(uint32_t aInitialDelay);

  Callback           mCallback;
  void*              mCallbackData;
  nsCString          mCallbackName;
  nsCOMPtr<nsITimer> mRepeatTimer;

}; // class nsRepeatService