<!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</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="loadscrollpos" title="et " expanded="true">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="no" title="et_collector " expanded="false">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</h1></center>
<h3>MODULE</h3>
<div class="REFBODY">et</div>
<h3>MODULE SUMMARY</h3>
<div class="REFBODY">Main API of the Event Trace (ET) application</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="trace_me-5"><span class="bold_code">trace_me(DetailLevel, From, To, Label, Contents) -> hopefully_traced</span></a><br></p>
<div class="REFBODY">
<p>Types:</p>
<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">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>A function that is intended to be traced.</p>
<p>This function is intended to be invoked at strategic places
in user applications in order to enable simplified
tracing. The functions are extremely light weight as they do
nothing besides returning an atom. The functions are designed
for being traced. The global tracing mechanism in
<span class="code">et_collector</span> defaults to set its trace pattern to these
functions.</p>
<p>The label is intended to provide a brief summary of the
event. It is preferred to use an atom but a string would also
do.</p>
<p>The contents can be any term but in order to simplify
post processing of the traced events, a plain list
of {Key, Value} tuples is preferred.</p>
<p>Some events, such as messages, are directed from some actor to another.
Other events (termed actions) may be undirected and only have one actor.</p>
</p></div>
<p><a name="trace_me-4"><span class="bold_code">trace_me(DetailLevel, FromTo, Label, Contents) -> hopefully_traced</span></a><br></p>
<div class="REFBODY"><p>
<p>Invokes <span class="code">et:trace_me/5</span> with both <span class="code">From</span> and <span class="code">To</span>
set to <span class="code">FromTo</span>.</p>
</p></div>
<p><a name="phone_home-4"><span class="bold_code">phone_home(DetailLevel, FromTo, Label, Contents) -> hopefully_traced</span></a><br><a name="phone_home-5"><span class="bold_code">phone_home(DetailLevel, From, To, Label, Contents) -> hopefully_traced</span></a><br></p>
<div class="REFBODY"><p>
<p>These functions sends a signal to the outer space and the
caller hopes that someone is listening. In other words, they
invoke <span class="code">et:trace_me/4</span> and <span class="code">et:trace_me/5</span>
respectively.</p>
</p></div>
<p><a name="report_event-4"><span class="bold_code">report_event(DetailLevel, FromTo, Label, Contents) -> hopefully_traced</span></a><br><a name="report_event-5"><span class="bold_code">report_event(DetailLevel, From, To, Label, Contents) -> hopefully_traced</span></a><br></p>
<div class="REFBODY"><p>
<p>Deprecated functions which for the time being are kept for
backwards compatibility. Invokes <span class="code">et:trace_me/4</span> and
<span class="code">et:trace_me/5</span> respectively.</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
>
610
