← Back to branch summary

~statik/ubuntu/maverick/erlang/erlang-merge-testing

« back to all changes in this revision

Viewing changes to lib/et/doc/src/et_viewer.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-05-01 10:14:38 UTC
  • mfrom: (3.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20090501101438-6qlr6rsdxgyzrg2z
Tags: 1:13.b-dfsg-2
* Cleaned up patches: removed unneeded patch which helped to support
  different SCTP library versions, made sure that changes for m68k
  architecture applied only when building on this architecture.
* Removed duplicated information from binary packages descriptions.
* Don't require libsctp-dev build-dependency on solaris-i386 architecture
  which allows to build Erlang on Nexenta (thanks to Tim Spriggs for
  the suggestion).

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/et/doc/src/et_viewer.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE erlref SYSTEM "erlref.dtd">
 
3
 
 
4
<erlref>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>2002</year><year>2009</year>
 
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
 
9
    </copyright>
 
10
    <legalnotice>
 
11
      The contents of this file are subject to the Erlang Public License,
 
12
      Version 1.1, (the "License"); you may not use this file except in
 
13
      compliance with the License. You should have received a copy of the
 
14
      Erlang Public License along with this software. If not, it can be
 
15
      retrieved online at http://www.erlang.org/.
 
16
    
 
17
      Software distributed under the License is distributed on an "AS IS"
 
18
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
19
      the License for the specific language governing rights and limitations
 
20
      under the License.
 
21
    
 
22
    </legalnotice>
 
23
 
 
24
    <title>et_viewer</title>
 
25
    <prepared>H&aring;kan Mattsson</prepared>
 
26
    <responsible>H&aring;kan Mattsson</responsible>
 
27
    <docno></docno>
 
28
    <approved>H&aring;kan Mattsson</approved>
 
29
    <checked></checked>
 
30
    <date></date>
 
31
    <rev>%VSN%</rev>
 
32
  </header>
 
33
  <module>et_viewer</module>
 
34
  <modulesummary>Displays a sequence chart for trace events (messages/actions)</modulesummary>
 
35
  <description>
 
36
    <p></p>
 
37
  </description>
 
38
  <funcs>
 
39
    <func>
 
40
      <name>file(FileName) -> {ok, ViewerPid} | {error, Reason}</name>
 
41
      <fsummary>Start a new event viewer and a corresponding collector and load them with trace events from a trace file.</fsummary>
 
42
      <type>
 
43
        <v>FileName() = string()</v>
 
44
        <v>ViewerPid = pid()</v>
 
45
        <v>Reason = term()</v>
 
46
      </type>
 
47
      <desc>
 
48
        <p>Start a new event viewer and a corresponding collector
 
49
          and load them with trace events from a trace file.</p>
 
50
      </desc>
 
51
    </func>
 
52
    <func>
 
53
      <name>start() -> ok</name>
 
54
      <fsummary>Simplified start of a sequence chart viewer with global tracing activated.</fsummary>
 
55
      <desc>
 
56
        <p>Simplified start of a sequence chart viewer with
 
57
          global tracing activated.</p>
 
58
        <p>Convenient to be used from the command line
 
59
          (erl -s et_viewer).</p>
 
60
      </desc>
 
61
    </func>
 
62
    <func>
 
63
      <name>start(Options) -> ok</name>
 
64
      <fsummary>Start of a sequence chart viewer without linking to the parent process.</fsummary>
 
65
      <desc>
 
66
        <p>Start of a sequence chart viewer without linking
 
67
          to the parent process.</p>
 
68
      </desc>
 
69
    </func>
 
70
    <func>
 
71
      <name>start_link(Options) -> {ok, ViewerPid} | {error, Reason}</name>
 
72
      <fsummary>Start a sequence chart viewer for trace events (messages/actions)</fsummary>
 
73
      <type>
 
74
        <v>Options = [option() | collector_option()]</v>
 
75
        <v>option() = {parent_pid, extended_pid()} | {title, term()} | {detail_level, detail_level()} | {is_suspended, boolean()} | {scale, integer()} | {width, integer()} | {height, integer()} | {collector_pid, extended_pid()} | {event_order, event_order()} | {active_filter, atom()} | {max_events, extended_integer()} | {max_actors, extended_integer()} | {trace_pattern, et_collector_trace_pattern()} | {trace_port, et_collector_trace_port()} | {trace_global, et_collector_trace_global()} | {trace_client, et_collector_trace_client()} | {dict_insert, {filter, filter_name()}, event_filter_fun()} | {dict_insert, et_collector_dict_key(), et_collector_dict_val()} | {dict_delete, {filter, filter_name()}} | {dict_delete, et_collector_dict_key()} | {actors, actors()} | {first_event, first_key()} | {hide_unknown, boolean()} | {hide_actions, boolean()} | {display_mode, display_mode()}</v>
 
76
        <v>extended_pid() = pid() | undefined</v>
 
77
        <v>detail_level() = min | max | integer(X) when X >=0, X =&lt; 100</v>
 
78
        <v>event_order() = trace_ts | event_ts</v>
 
79
        <v>extended_integer() = integer() | infinity</v>
 
80
        <v>display_mode() = all | {search_actors, direction(), first_key(), actors()}</v>
 
81
        <v>direction() = forward | reverse</v>
 
82
        <v>first_key() = event_key()</v>
 
83
        <v>actors() = [term()]</v>
 
84
        <v></v>
 
85
        <v>filter_name() = atom()</v>
 
86
        <v>filter_fun() =  fun(Event) -> false | true | {true, NewEvent}</v>
 
87
        <v>Event = NewEvent = record(event)</v>
 
88
        <v>ViewerPid = pid()</v>
 
89
        <v>Reason = term()</v>
 
90
      </type>
 
91
      <desc>
 
92
        <p>Start a sequence chart viewer for trace events
 
93
          (messages/actions)</p>
 
94
        <p>A filter_fun() takes an event record as sole argument
 
95
          and returns false | true | {true, NewEvent}.</p>
 
96
        <p>If the <c>collector_pid</c> is <c>undefined</c> a new 
 
97
          <c>et_collecor</c> will be started with the following
 
98
          parameter settings: <c>parent_pid</c>, <c>event_order</c>,
 
99
          <c>trace_global</c>, <c>trace_pattern</c>, <c>trace_port</c>, <c>trace_max_queue</c>,
 
100
          <c>trace_client</c>, <c>dict_insert</c> and <c>dict_delete</c>.
 
101
          The new <c>et_viewer</c> will register itself as an <c>et_collecor</c> 
 
102
          subscriber.
 
103
          </p>
 
104
        <p>Default values:</p>
 
105
        <list type="bulleted">
 
106
          <item>parent_pid - self().</item>
 
107
          <item>title - "et_viewer".</item>
 
108
          <item>detail_level - max.</item>
 
109
          <item>is_suspended - false.</item>
 
110
          <item>scale - 2.</item>
 
111
          <item>width - 800.</item>
 
112
          <item>height - 600.</item>
 
113
          <item>collector_pid - undefined.</item>
 
114
          <item>event_order - trace_ts.</item>
 
115
          <item>active_filter - collector.</item>
 
116
          <item>max_events - 100.</item>
 
117
          <item>max_actors - 5.</item>
 
118
          <item>actors - ["UNKNOWN"].</item>
 
119
          <item>first_event - first.</item>
 
120
          <item>hide_unknown - false.</item>
 
121
          <item>hide_actions - false.</item>
 
122
          <item>display_mode - all.</item>
 
123
        </list>
 
124
      </desc>
 
125
    </func>
 
126
    <func>
 
127
      <name>get_collector_pid(ViewerPid) -> CollectorPid</name>
 
128
      <fsummary>Returns the identifier of the collector process</fsummary>
 
129
      <type>
 
130
        <v>ViewerPid = pid()</v>
 
131
        <v>CollectorPid = pid()</v>
 
132
      </type>
 
133
      <desc>
 
134
        <p>Returns the identifier of the collector process.</p>
 
135
      </desc>
 
136
    </func>
 
137
    <func>
 
138
      <name>stop(ViewerPid) -> ok</name>
 
139
      <fsummary>Stops a viewer</fsummary>
 
140
      <type>
 
141
        <v>ViewerPid = pid()</v>
 
142
      </type>
 
143
      <desc>
 
144
        <p>Stops a viewer process.</p>
 
145
      </desc>
 
146
    </func>
 
147
  </funcs>
 
148
  
 
149
</erlref>
 
150
 
 
151