nsICycleCollectorListener

by 2 contributors:

Interface to pass to the cycle collector to get information about the cycle collector graph while it is being built.
1.0
28
Introduced
Gecko 2.0
Inherits from: nsISupports Last changed in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

The order of calls will be call to begin(); then for every node in the graph a call to noteObject() and calls to noteEdge() for every edge starting at that node; then a call to beginDescriptions(); then for every black node in the cycle collector graph a call to either describeRefcountedObject() or to describeGCedObject(); and then a call to end(). If begin() returns an error none of the other functions will be called.

Method overview

void begin();
void beginDescriptions();
void describeGCedObject(in unsigned long long aAddress, in boolean aMarked);
void describeRefcountedObject(in unsigned long long aAddress, in unsigned long aKnownEdges, in unsigned long aTotalEdges);
void end();
void noteEdge(in unsigned long long aFromAddress, in unsigned long long aToAddress, in string aEdgeName);
void noteObject(in unsigned long long aAddress, in string aObjectDescription);

Methods

begin()

void begin();
Parameters

None.

beginDescriptions()

void beginDescriptions();
Parameters

None.

describeGCedObject()

void describeGCedObject(
  in unsigned long long aAddress,
  in boolean aMarked
);
Parameters
aAddress
aMarked

describeRefcountedObject()

void describeRefcountedObject(
  in unsigned long long aAddress,
  in unsigned long aKnownEdges,
  in unsigned long aTotalEdges
);
Parameters
aAddress
aKnownEdges
aTotalEdges

end()

void end();
Parameters

None.

noteEdge()

void noteEdge(
  in unsigned long long aFromAddress,
  in unsigned long long aToAddress,
  in string aEdgeName
);
Parameters
aFromAddress
aToAddress
aEdgeName

noteObject()

void noteObject(
  in unsigned long long aAddress,
  in string aObjectDescription
);
Parameters
aAddress
aObjectDescription

Document Tags and Contributors

Contributors to this page: Sheppy, trevorh
Last updated by: Sheppy,