mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Imported Upstream version 5.10.0.47

Browse Source 
Former-commit-id: d0813289fa2d35e1f8ed77530acb4fb1df441bc0
This commit is contained in:
Xamarin Public Jenkins (auto-signing)
2018-01-24 17:04:36 +00:00
parent 88ff76fe28
commit e46a49ecf1
5927 changed files with 226314 additions and 129848 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
docs/deploy/mono-api-gc.html
View File

@@ -48,6 +48,16 @@
line-height: 0px;
}
.mapi-codeblock {
display: block;
padding: 5pt 5pt;
margin: 10pt;
white-space: pre;
font-family: monospace;
border: 1px solid rgba(233,233,233,1);
background-color: rgba(249,249,249,1);
}
.mapi-entry code {
border: none;
background-color: transparent;
@@ -212,7 +222,15 @@ mono_gc_collect (int generation)
<p />
<div class="mapi-section">Parameters</div>
<table class="mapi-parameters"><tbody><tr><td><i>generation</i></td><td> GC generation identifier</td></tr></tbody></table> <div class="mapi-section">Description</div>
<div> <p /> Perform a garbage collection for the given generation, higher numbers mean usually older objects. Collecting a high-numbered generation implies collecting also the lower-numbered generations. The maximum value for <i>generation</i> can be retrieved with a call to <code>mono_gc_max_generation</code>, so this function is usually called as: <p /> <code>mono_gc_collect (mono_gc_max_generation ());</code></div>
<div>
<p />
Perform a garbage collection for the given generation, higher numbers
mean usually older objects. Collecting a high-numbered generation
implies collecting also the lower-numbered generations.
The maximum value for <i>generation</i> can be retrieved with a call to
<code>mono_gc_max_generation</code>, so this function is usually called as:
<p />
<code>mono_gc_collect (mono_gc_max_generation ());</code></div>
</div><!--mapi-description -->
</div><!--height container -->
</div> <!-- class=mapi -->
@@ -236,7 +254,11 @@ mono_gc_collection_count (int generation)
<div> the number of garbage collections
</div>
<div class="mapi-section">Description</div>
<div> <p /> Get how many times a garbage collection has been performed for the given <i>generation</i> number. <p /></div>
<div>
<p />
Get how many times a garbage collection has been performed
for the given <i>generation</i> number.
<p /></div>
</div><!--mapi-description -->
</div><!--height container -->
</div> <!-- class=mapi -->
@@ -259,7 +281,12 @@ mono_gc_max_generation (void)
<div> the maximum generation number.
</div>
<div class="mapi-section">Description</div>
<div> <p /> Get the maximum generation number used by the current garbage collector. The value will be 0 for the Boehm collector, 1 or more for the generational collectors. <p /></div>
<div>
<p />
Get the maximum generation number used by the current garbage
collector. The value will be 0 for the Boehm collector, 1 or more
for the generational collectors.
<p /></div>
</div><!--mapi-description -->
</div><!--height container -->
</div> <!-- class=mapi -->
@@ -283,7 +310,11 @@ mono_gc_get_generation (MonoObject *object)
<div> a garbage collector generation number
</div>
<div class="mapi-section">Description</div>
<div> <p /> Get the garbage collector's generation that <i>object</i> belongs to. Use this has a hint only. <p /></div>
<div>
<p />
Get the garbage collector's generation that <i>object</i> belongs to.
Use this has a hint only.
<p /></div>
</div><!--mapi-description -->
</div><!--height container -->
</div> <!-- class=mapi -->
@@ -306,7 +337,10 @@ mono_gc_get_heap_size (void)
<div> the size of the heap in bytes
</div>
<div class="mapi-section">Description</div>
<div> <p /> Get the amount of memory used by the garbage collector. <p /></div>
<div>
<p />
Get the amount of memory used by the garbage collector.
<p /></div>
</div><!--mapi-description -->
</div><!--height container -->
</div> <!-- class=mapi -->
@@ -329,7 +363,10 @@ mono_gc_get_used_size (void)
<div> the amount of memory used in bytes
</div>
<div class="mapi-section">Description</div>
<div> <p /> Get the approximate amount of memory used by managed objects. <p /></div>
<div>
<p />
Get the approximate amount of memory used by managed objects.
<p /></div>
</div><!--mapi-description -->
</div><!--height container -->
</div> <!-- class=mapi -->
@@ -353,7 +390,17 @@ mono_gc_walk_heap (int flags, MonoGCReferences callback, void *data)
<div> a non-zero value if the GC doesn't support heap walking
</div>
<div class="mapi-section">Description</div>
<div> This function can be used to iterate over all the live objects in the heap; for each object, <i>callback</i> is invoked, providing info about the object's location in memory, its class, its size and the objects it references. For each referenced object its offset from the object address is reported in the offsets array. The object references may be buffered, so the callback may be invoked multiple times for the same object: in all but the first call, the size argument will be zero. Note that this function can be only called in the <code>MONO_GC_EVENT_PRE_START_WORLD</code> profiler event handler.</div>
<div>
This function can be used to iterate over all the live objects in the heap;
for each object, <i>callback</i> is invoked, providing info about the object's
location in memory, its class, its size and the objects it references.
For each referenced object its offset from the object address is
reported in the offsets array.
The object references may be buffered, so the callback may be invoked
multiple times for the same object: in all but the first call, the size
argument will be zero.
Note that this function can be only called in the <code>MONO_GC_EVENT_PRE_START_WORLD</code>
profiler event handler.</div>
</div><!--mapi-description -->
</div><!--height container -->
@@ -380,7 +427,12 @@ mono_gc_reference_queue_add (MonoReferenceQueue *queue, MonoObject *obj, void *u
<div> <code>FALSE</code> if the queue is scheduled to be freed.
</div>
<div class="mapi-section">Description</div>
<div> <p /> Queue an object to be watched for collection, when the <i>obj</i> is collected, the callback that was registered for the <i>queue</i> will be invoked with <i>user_data</i> as argument. <p /></div>
<div>
<p />
Queue an object to be watched for collection, when the <i>obj</i> is
collected, the callback that was registered for the <i>queue</i> will
be invoked with <i>user_data</i> as argument.
<p /></div>
</div><!--mapi-description -->
</div><!--height container -->
</div> <!-- class=mapi -->
@@ -401,7 +453,13 @@ mono_gc_reference_queue_free (MonoReferenceQueue *queue)
<p />
<div class="mapi-section">Parameters</div>
<table class="mapi-parameters"><tbody><tr><td><i>queue</i></td><td> the queue that should be freed.</td></tr></tbody></table> <div class="mapi-section">Description</div>
<div> <p /> This operation signals that <i>queue</i> should be freed. This operation is deferred as it happens on the finalizer thread. <p /> After this call, no further objects can be queued. It's the responsibility of the caller to make sure that no further attempt to access queue will be made.</div>
<div>
<p />
This operation signals that <i>queue</i> should be freed. This operation is deferred
as it happens on the finalizer thread.
<p />
After this call, no further objects can be queued. It's the responsibility of the
caller to make sure that no further attempt to access queue will be made.</div>
</div><!--mapi-description -->
</div><!--height container -->
</div> <!-- class=mapi -->
@@ -425,7 +483,19 @@ mono_gc_reference_queue_new (mono_reference_queue_callback callback)
<div> the new queue.
</div>
<div class="mapi-section">Description</div>
<div> <p /> Create a new reference queue used to process collected objects. A reference queue let you add a pair of (managed object, user data) using the <code>mono_gc_reference_queue_add</code> method. <p /> Once the managed object is collected <i>callback</i> will be called in the finalizer thread with 'user data' as argument. <p /> The callback is called from the finalizer thread without any locks held. When an AppDomain is unloaded, all callbacks for objects belonging to it will be invoked. <p /></div>
<div>
<p />
Create a new reference queue used to process collected objects.
A reference queue let you add a pair of (managed object, user data)
using the <code>mono_gc_reference_queue_add</code> method.
<p />
Once the managed object is collected <i>callback</i> will be called
in the finalizer thread with 'user data' as argument.
<p />
The callback is called from the finalizer thread without any locks held.
When an AppDomain is unloaded, all callbacks for objects belonging to it
will be invoked.
<p /></div>
</div><!--mapi-description -->
</div><!--height container -->
@@ -622,7 +692,9 @@ mono_gc_wbarrier_generic_store_atomic (gpointer ptr, GCObject *value)
</div>
<p />
<div class="mapi-section">Description</div>
<div> Same as <code>mono_gc_wbarrier_generic_store</code> but performs the store as an atomic operation with release semantics.</div>
<div>
Same as <code>mono_gc_wbarrier_generic_store</code> but performs the store
as an atomic operation with release semantics.</div>
</div><!--mapi-description -->
</div><!--height container -->
</div> <!-- class=mapi -->
@@ -642,7 +714,9 @@ mono_gc_wbarrier_object_copy (MonoObject* obj, MonoObject *src)
</div>
<p />
<div class="mapi-section">Description</div>
<div> <p /> Write barrier to call when <i>obj</i> is the result of a clone or copy of an object.</div>
<div>
<p />
Write barrier to call when <i>obj</i> is the result of a clone or copy of an object.</div>
</div><!--mapi-description -->
</div><!--height container -->
</div> <!-- class=mapi -->