/* 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 mozilla_net_NeckoTargetHolder_h
#define mozilla_net_NeckoTargetHolder_h

#include "nsIEventTarget.h"
#include "nsThreadUtils.h"

namespace mozilla {
namespace net {

// A helper class that implements GetNeckoTarget(). Basically, all e10s child
// channels should inherit this class in order to get a labeled event target.
class NeckoTargetHolder {
 public:
  explicit NeckoTargetHolder(nsISerialEventTarget* aNeckoTarget)
      : mNeckoTarget(aNeckoTarget) {}

 protected:
  virtual ~NeckoTargetHolder() = default;
  // Get event target for processing network events.
  virtual already_AddRefed<nsISerialEventTarget> GetNeckoTarget();
  // When |mNeckoTarget| is not null, use it to dispatch the runnable.
  // Otherwise, dispatch the runnable to the main thread.
  nsresult Dispatch(
      already_AddRefed<nsIRunnable> aRunnable,
      nsIEventTarget::DispatchFlags aDispatchFlags = NS_DISPATCH_NORMAL);

  // EventTarget for labeling networking events.
  nsCOMPtr<nsISerialEventTarget> mNeckoTarget;
};

}  // namespace net
}  // namespace mozilla

#endif
