1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/netwerk/base/public/nsILoadGroupChild.idl Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,42 @@
1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.8 +
1.9 +#include "nsISupports.idl"
1.10 +
1.11 +interface nsILoadGroup;
1.12 +
1.13 +/**
1.14 + * nsILoadGroupChild provides a hierarchy of load groups so that the
1.15 + * root load group can be used to conceptually tie a series of loading
1.16 + * operations into a logical whole while still leaving them separate
1.17 + * for the purposes of cancellation and status events.
1.18 + */
1.19 +
1.20 +[scriptable, uuid(02efe8e2-fbbc-4718-a299-b8a09c60bf6b)]
1.21 +interface nsILoadGroupChild : nsISupports
1.22 +{
1.23 + /**
1.24 + * The parent of this load group. It is stored with
1.25 + * a nsIWeakReference/nsWeakPtr so there is no requirement for the
1.26 + * parentLoadGroup to out live the child, nor will the child keep a
1.27 + * reference count on the parent.
1.28 + */
1.29 + attribute nsILoadGroup parentLoadGroup;
1.30 +
1.31 + /**
1.32 + * The nsILoadGroup associated with this nsILoadGroupChild
1.33 + */
1.34 + readonly attribute nsILoadGroup childLoadGroup;
1.35 +
1.36 + /**
1.37 + * The rootLoadGroup is the recursive parent of this
1.38 + * load group where parent is defined as parentlLoadGroup if set
1.39 + * or childLoadGroup.loadGroup as a backup. (i.e. parentLoadGroup takes
1.40 + * precedence.) The nsILoadGroup child is the root if neither parent
1.41 + * nor loadgroup attribute is specified.
1.42 + */
1.43 + readonly attribute nsILoadGroup rootLoadGroup;
1.44 +};
1.45 +
