<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- et_collector</title>
</head>
<body bgcolor="white" text="#000000" link="#0000ff" vlink="#ff00ff" alink="#ff0000"><div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<img alt="Erlang logo" src="../../../../doc/erlang-logo.png"><br><small><a href="users_guide.html">User's Guide</a><br><a href="index.html">Reference Manual</a><br><a href="release_notes.html">Release Notes</a><br><a href="../pdf/et-1.4.4.2.pdf">PDF</a><br><a href="../../../../doc/index.html">Top</a></small><p><strong>Event Tracer (ET)</strong><br><strong>Reference Manual</strong><br><small>Version 1.4.4.2</small></p>
<br><a href="javascript:openAllFlips()">Expand All</a><br><a href="javascript:closeAllFlips()">Contract All</a><p><small><strong>Table of Contents</strong></small></p>
<ul class="flipMenu">
<li id="no" title="et " expanded="false">et<ul>
<li><a href="et.html">
Top of manual page
</a></li>
<li title="trace_me-5"><a href="et.html#trace_me-5">trace_me/5</a></li>
<li title="trace_me-4"><a href="et.html#trace_me-4">trace_me/4</a></li>
<li title="phone_home-4"><a href="et.html#phone_home-4">phone_home/4</a></li>
<li title="phone_home-5"><a href="et.html#phone_home-5">phone_home/5</a></li>
<li title="report_event-4"><a href="et.html#report_event-4">report_event/4</a></li>
<li title="report_event-5"><a href="et.html#report_event-5">report_event/5</a></li>
</ul>
</li>
<li id="loadscrollpos" title="et_collector " expanded="true">et_collector<ul>
<li><a href="et_collector.html">
Top of manual page
</a></li>
<li title="start_link-1"><a href="et_collector.html#start_link-1">start_link/1</a></li>
<li title="stop-1"><a href="et_collector.html#stop-1">stop/1</a></li>
<li title="save_event_file-3"><a href="et_collector.html#save_event_file-3">save_event_file/3</a></li>
<li title="load_event_file-2"><a href="et_collector.html#load_event_file-2">load_event_file/2</a></li>
<li title="report-2"><a href="et_collector.html#report-2">report/2</a></li>
<li title="report_event-5"><a href="et_collector.html#report_event-5">report_event/5</a></li>
<li title="report_event-6"><a href="et_collector.html#report_event-6">report_event/6</a></li>
<li title="make_key-2"><a href="et_collector.html#make_key-2">make_key/2</a></li>
<li title="get_table_handle-1"><a href="et_collector.html#get_table_handle-1">get_table_handle/1</a></li>
<li title="get_global_pid-0"><a href="et_collector.html#get_global_pid-0">get_global_pid/0</a></li>
<li title="change_pattern-2"><a href="et_collector.html#change_pattern-2">change_pattern/2</a></li>
<li title="dict_insert-3"><a href="et_collector.html#dict_insert-3">dict_insert/3</a></li>
<li title="dict_insert-3"><a href="et_collector.html#dict_insert-3">dict_insert/3</a></li>
<li title="dict_insert-3"><a href="et_collector.html#dict_insert-3">dict_insert/3</a></li>
<li title="dict_lookup-2"><a href="et_collector.html#dict_lookup-2">dict_lookup/2</a></li>
<li title="dict_delete-2"><a href="et_collector.html#dict_delete-2">dict_delete/2</a></li>
<li title="dict_match-2"><a href="et_collector.html#dict_match-2">dict_match/2</a></li>
<li title="multicast-2"><a href="et_collector.html#multicast-2">multicast/2</a></li>
<li title="start_trace_client-3"><a href="et_collector.html#start_trace_client-3">start_trace_client/3</a></li>
<li title="iterate-3"><a href="et_collector.html#iterate-3">iterate/3</a></li>
<li title="iterate-5"><a href="et_collector.html#iterate-5">iterate/5</a></li>
<li title="clear_table-1"><a href="et_collector.html#clear_table-1">clear_table/1</a></li>
</ul>
</li>
<li id="no" title="et_selector " expanded="false">et_selector<ul>
<li><a href="et_selector.html">
Top of manual page
</a></li>
<li title="make_pattern-1"><a href="et_selector.html#make_pattern-1">make_pattern/1</a></li>
<li title="change_pattern-1"><a href="et_selector.html#change_pattern-1">change_pattern/1</a></li>
<li title="parse_event-2"><a href="et_selector.html#parse_event-2">parse_event/2</a></li>
</ul>
</li>
<li id="no" title="et_viewer " expanded="false">et_viewer<ul>
<li><a href="et_viewer.html">
Top of manual page
</a></li>
<li title="file-1"><a href="et_viewer.html#file-1">file/1</a></li>
<li title="start-0"><a href="et_viewer.html#start-0">start/0</a></li>
<li title="start-1"><a href="et_viewer.html#start-1">start/1</a></li>
<li title="start_link-1"><a href="et_viewer.html#start_link-1">start_link/1</a></li>
<li title="get_collector_pid-1"><a href="et_viewer.html#get_collector_pid-1">get_collector_pid/1</a></li>
<li title="stop-1"><a href="et_viewer.html#stop-1">stop/1</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<!-- refpage --><center><h1>et_collector</h1></center>
<h3>MODULE</h3>
<div class="REFBODY">et_collector</div>
<h3>MODULE SUMMARY</h3>
<div class="REFBODY">Collect trace events and provide a backing storage appropriate for iteration </div>
<h3>DESCRIPTION</h3>
<div class="REFBODY"><p>
<p>Interface module for the Event Trace (ET) application</p>
</p></div>
<h3>EXPORTS</h3>
<p><a name="start_link-1"><span class="bold_code">start_link(Options) -> {ok, CollectorPid} | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Options = [option()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">option() = {parent_pid, pid()} | {event_order, event_order()} | {dict_insert, {filter, collector}, collector_fun()} | {dict_insert, {filter, event_filter_name()}, event_filter_fun()} | {dict_insert, {subscriber, pid()}, dict_val()} | {dict_insert, dict_key(), dict_val()} | {dict_delete, dict_key()} | {trace_client, trace_client()} | {trace_global, boolean()} | {trace_pattern, trace_pattern()} | {trace_port, integer()} | {trace_max_queue, integer()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">event_order() = trace_ts | event_ts</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">trace_pattern() = {report_module(), extended_dbg_match_spec()} | undefined</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">report_module() = atom() | undefined <v>extended_dbg_match_spec()() = detail_level() | dbg_match_spec()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">detail_level() = min | max | integer(X) when X =< 0, X >= 100</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">trace_client() = {event_file, file_name()} | {dbg_trace_type(), dbg_trace_parameters()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">file_name() = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">collector_fun() = trace_filter_fun() | event_filter_fun()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">trace_filter_fun() = fun(TraceData) -> false | true | {true, NewEvent}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">event_filter_fun() = fun(Event) -> false | true | {true, NewEvent}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">event_filter_name() = atom()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TraceData = erlang_trace_data()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Event = NewEvent = record(event)</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">dict_key() = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">dict_val() = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Start a collector process.</p>
<p>The collector collects trace events and keeps them ordered by their
timestamp. The timestamp may either reflect the time when the
actual trace data was generated (trace_ts) or when the trace data
was transformed into an event record (event_ts). If the time stamp
is missing in the trace data (missing timestamp option to
erlang:trace/4) the trace_ts will be set to the event_ts.</p>
<p>Events are reported to the collector directly with the report
function or indirectly via one or more trace clients. All reported
events are first filtered thru the collector filter before they are
stored by the collector. By replacing the default collector filter
with a customized dito it is possible to allow any trace data as
input. The collector filter is a dictionary entry with the
predefined key {filter, collector} and the value is a fun of
arity 1. See et_selector:make_event/1 for interface details,
such as which erlang:trace/1 tuples that are accepted.</p>
<p>The collector has a built-in dictionary service. Any term may be
stored as value in the dictionary and bound to a unique key. When
new values are inserted with an existing key, the new values will
overwrite the existing ones. Processes may subscribe on dictionary
updates by using {subscriber, pid()} as dictionary key. All
dictionary updates will be propagated to the subscriber processes
matching the pattern {{subscriber, '_'}, '_'} where the first '_'
is interpreted as a pid().</p>
<p>In global trace mode, the collector will automatically
start tracing on all connected Erlang nodes. When a node
connects, a port tracer will be started on that node and a
corresponding trace client on the collector node.</p>
<p>Default values:</p>
<ul>
<li>parent_pid - self().</li>
<li>event_order - trace_ts.</li>
<li>trace_global - false.</li>
<li>trace_pattern - undefined.</li>
<li>trace_port - 4711.</li>
<li>trace_max_queue - 50.</li>
</ul>
</p></div>
<p><a name="stop-1"><span class="bold_code">stop(CollectorPid) -> ok</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Stop a collector process.</p>
</p></div>
<p><a name="save_event_file-3"><span class="bold_code">save_event_file(CollectorPid, FileName, Options) -> ok | {error, Reason}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">FileName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Options = [option()]</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">option() = event_option() | file_option() | table_option()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">event_option() = existing</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">file_option() = write | append</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">table_option() = keep | clear</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Save the events to a file.</p>
<p>By default the currently stored events (existing) are
written to a brand new file (write) and the events are
kept (keep) after they have been written to the file.</p>
<p>Instead of keeping the events after writing them to file,
it is possible to remove all stored events after they
have successfully written to file (clear).</p>
<p>The options defaults to existing, write and keep.</p>
</p></div>
<p><a name="load_event_file-2"><span class="bold_code">load_event_file(CollectorPid, FileName) -> {ok, BadBytes} | exit(Reason)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">FileName = string()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">BadBytes = integer(X) where X >= 0</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Load the event table from a file.</p>
</p></div>
<p><a name="report-2"><span class="bold_code">report(Handle, TraceOrEvent) -> {ok, Continuation} | exit(Reason)</span></a><br><a name="report_event-5"><span class="bold_code">report_event(Handle, DetailLevel, FromTo, Label, Contents) -> {ok, Continuation} | exit(Reason)</span></a><br><a name="report_event-6"><span class="bold_code">report_event(Handle, DetailLevel, From, To, Label, Contents) -> {ok, Continuation} | exit(Reason)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Handle = Initial | Continuation</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Initial = collector_pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">collector_pid() = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Continuation = record(table_handle)</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TraceOrEvent = record(event) | dbg_trace_tuple() | end_of_trace</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">DetailLevel = integer(X) when X =< 0, X >= 100</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">From = actor()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">To = actor()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">FromTo = actor()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Label = atom() | string() | term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Contents = [{Key, Value}] | term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">actor() = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Report an event to the collector.</p>
<p>All events are filtered thru the collector filter, which
optionally may transform or discard the event. The first
call should use the pid of the collector process as
report handle, while subsequent calls should use the
table handle.</p>
</p></div>
<p><a name="make_key-2"><span class="bold_code">make_key(Type, Stuff) -> Key</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Type = record(table_handle) | trace_ts | event_ts</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Stuff = record(event) | Key</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Key = record(event_ts) | record(trace_ts)</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Make a key out of an event record or an old key.</p>
</p></div>
<p><a name="get_table_handle-1"><span class="bold_code">get_table_handle(CollectorPid) -> Handle</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Handle = record(table_handle)</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Return a table handle.</p>
</p></div>
<p><a name="get_global_pid-0"><span class="bold_code">get_global_pid() -> CollectorPid | exit(Reason)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Reason = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Return a the identity of the globally registered
collector if there is any.</p>
</p></div>
<p><a name="change_pattern-2"><span class="bold_code">change_pattern(CollectorPid, RawPattern) -> {old_pattern, TracePattern}</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">RawPattern = {report_module(), extended_dbg_match_spec()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">report_module() = atom() | undefined</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">extended_dbg_match_spec()() = detail_level() | dbg_match_spec()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">RawPattern = detail_level()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">detail_level() = min | max | integer(X) when X =< 0, X >= 100</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">TracePattern = {report_module(), dbg_match_spec_match_spec()}</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Change active trace pattern globally on all trace nodes.</p>
</p></div>
<p><a name="dict_insert-3"><span class="bold_code">dict_insert(CollectorPid, {filter, collector}, FilterFun) -> ok</span></a><br><a name="dict_insert-3"><span class="bold_code">dict_insert(CollectorPid, {subscriber, SubscriberPid}, Void) -> ok</span></a><br><a name="dict_insert-3"><span class="bold_code">dict_insert(CollectorPid, Key, Val) -> ok</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">FilterFun = filter_fun() </span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SubscriberPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Void = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Key = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Val = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Insert a dictionary entry
and send a {et, {dict_insert, Key, Val}} tuple
to all registered subscribers.</p>
<p>If the entry is a new subscriber, it will imply that
the new subscriber process first will get one message
for each already stored dictionary entry, before it
and all old subscribers will get this particular entry.
The collector process links to and then supervises the
subscriber process. If the subscriber process dies it
will imply that it gets unregistered as with a normal
dict_delete/2.</p>
</p></div>
<p><a name="dict_lookup-2"><span class="bold_code">dict_lookup(CollectorPid, Key) -> [Val]</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">FilterFun = filter_fun() </span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Key = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Val = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Lookup a dictionary entry and return zero or one value.</p>
</p></div>
<p><a name="dict_delete-2"><span class="bold_code">dict_delete(CollectorPid, Key) -> ok</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">SubscriberPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Key = {subscriber, SubscriberPid} | term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Delete a dictionary entry
and send a {et, {dict_delete, Key}} tuple
to all registered subscribers.</p>
<p>If the deleted entry is a registered subscriber, it will
imply that the subscriber process gets is unregistered as
subscriber as well as it gets it final message.</p>
</p></div>
<p><a name="dict_match-2"><span class="bold_code">dict_match(CollectorPid, Pattern) -> [Match]</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Pattern = '_' | {key_pattern(), val_pattern()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">key_pattern() = ets_match_object_pattern()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">val_pattern() = ets_match_object_pattern()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Match = {key(), val()}</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">key() = term()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">val() = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Match some dictionary entries</p>
</p></div>
<p><a name="multicast-2"><span class="bold_code">multicast(_CollectorPid, Msg) -> ok</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">CollectorPid = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Msg = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Sends a message to all registered subscribers.</p>
</p></div>
<p><a name="start_trace_client-3"><span class="bold_code">start_trace_client(CollectorPid, Type, Parameters) -> file_loaded | {trace_client_pid, pid()} | exit(Reason)</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Type = dbg_trace_client_type()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Parameters = dbg_trace_client_parameters()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Pid = dbg_trace_client_pid()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Load raw Erlang trace from a file, port or process.</p>
</p></div>
<p><a name="iterate-3"><span class="bold_code">iterate(Handle, Prev, Limit) -> NewAcc</span></a><br></p>
<div class="REFBODY"><p>
<p>Short for iterate(Handle, Prev, Limit, undefined, Prev) -> NewAcc</p>
</p></div>
<p><a name="iterate-5"><span class="bold_code">iterate(Handle, Prev, Limit, Fun, Acc) -> NewAcc</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Handle = collector_pid() | table_handle()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Prev = first | last | event_key()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Limit = done() | forward() | backward()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">collector_pid() = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">table_handle() = record(table_handle)</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">event_key() = record(event) | record(event_ts) | record(trace_ts)</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">done() = 0</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">forward() = infinity | integer(X) where X > 0</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">backward() = '-infinity' | integer(X) where X < 0</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">Fun = fun(Event, Acc) -> NewAcc <v>Acc = NewAcc = term()</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Iterate over the currently stored events.</p>
<p>Iterates over the currently stored events and applies
a function for each event. The iteration may be performed
forwards or backwards and may be limited to a maximum
number of events (abs(Limit)).</p>
</p></div>
<p><a name="clear_table-1"><span class="bold_code">clear_table(Handle) -> ok</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<div class="REFTYPES">
<span class="bold_code">Handle = collector_pid() | table_handle()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">collector_pid() = pid()</span><br>
</div>
<div class="REFTYPES">
<span class="bold_code">table_handle() = record(table_handle)</span><br>
</div>
</div>
<div class="REFBODY"><p>
<p>Clear the event table.</p>
</p></div>
</div>
<div class="footer">
<hr>
<p>Copyright © 2002-2012 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div></body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
675c8c8167236dfcf8d66da674f931e8
>
files
>
611
