[apple/xnu.git] / osfmk / man / receive_samples.html

<h2>receive_samples</h2>
<p>
Server Interface - Handles the occurrence of a PC sampling message

<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   receive_samples</strong>
                <strong>(mach_port_t</strong>                     <var>sample_port</var>,
                 <strong>sample_array_t</strong>                      <var>samples</var>,
                 <strong>mach_msg_type_number_t</strong>         <var>sample_count</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<dt> <var>sample_port</var>
<dd>
[in sample (receive) right] The port to which the sample message was 
sent.

<dt> <var>samples</var>
<dd>
[pointer to in array of vm_address_t] An array of PC sample values.

<dt> <var>sample_count</var>
<dd>
[in scalar] The number of values in samples.
</dl>

<h3>DESCRIPTION</h3>
<p>
A <strong>receive_samples</strong> function is called by
<strong>prof_server</strong> as the result of a kernel 
message indicating that a set of program counter samples has been gathered. 
The parameter <var>sample_port</var> specifies the port named via
a previous call to <strong>task_sample</strong>
or <strong>thread_sample</strong>.

<h3>NOTES</h3>
<p>
This interface is machine word length specific because of the virtual addresses 
in the <var>samples</var> parameter.

<h3>RETURN VALUE</h3>
<p>
Irrelevant.

<h3>RELATED INFORMATION</h3>
<p>
Functions:
<a href="task_sample.html"><strong>task_sample</strong></a>,
<a href="thread_sample.html"><strong>thread_sample</strong></a>,
<a href="prof_server.html"><strong>prof_server</strong></a>.