1et_viewer(3)               Erlang Module Definition               et_viewer(3)
2
3
4

NAME

6       et_viewer   -   Displays  a  sequence  chart  for  trace  events  (mes‐
7       sages/actions)
8

DESCRIPTION

EXPORTS

11       file(FileName) -> {ok, ViewerPid} | {error, Reason}
12
13              Types:
14
15                 FileName() = string()
16                 ViewerPid = pid()
17                 Reason = term()
18
19              Start a new event viewer and a corresponding collector and  load
20              them with trace events from a trace file.
21
22       start() -> ok
23
24              Simplified  start of a sequence chart viewer with global tracing
25              activated.
26
27              Convenient to be used from the command line (erl -s et_viewer).
28
29       start(Options) -> ok
30
31              Start of a sequence chart viewer without linking to  the  parent
32              process.
33
34       start_link(Options) -> {ok, ViewerPid} | {error, Reason}
35
36              Types:
37
38                 Options = [option() | collector_option()]
39                 option()  =  {parent_pid, extended_pid()} | {title, term()} |
40                 {detail_level, detail_level()} | {is_suspended, boolean()}  |
41                 {scale, integer()} | {width, integer()} | {height, integer()}
42                 |    {collector_pid,    extended_pid()}    |    {event_order,
43                 event_order()}   |  {active_filter,  atom()}  |  {max_actors,
44                 extended_integer()} | {trace_pattern, et_collector_trace_pat‐
45                 tern()}    |    {trace_port,   et_collector_trace_port()}   |
46                 {trace_global, et_collector_trace_global()} |  {trace_client,
47                 et_collector_trace_client()}  |  {dict_insert,  {filter, fil‐
48                 ter_name()}, event_filter_fun()} |  {dict_insert,  et_collec‐
49                 tor_dict_key(),   et_collector_dict_val()}   |  {dict_delete,
50                 {filter,   filter_name()}}   |    {dict_delete,    et_collec‐
51                 tor_dict_key()}   |   {actors,   actors()}   |  {first_event,
52                 first_key()} |  {hide_unknown,  boolean()}  |  {hide_actions,
53                 boolean()} | {display_mode, display_mode()}
54                 extended_pid() = pid() | undefined
55                 detail_level() = min | max | integer(X) when X >=0, X =< 100
56                 event_order() = trace_ts | event_ts
57                 extended_integer() = integer() | infinity
58                 display_mode()   =   all   |   {search_actors,   direction(),
59                 first_key(), actors()}
60                 direction() = forward | reverse
61                 first_key() = event_key()
62                 actors() = [term()]
63
64                 filter_name() = atom()
65                 filter_fun() = fun(Event) -> false | true | {true, NewEvent}
66                 Event = NewEvent = record(event)
67                 ViewerPid = pid()
68                 Reason = term()
69
70              Start  a  sequence  chart  viewer   for   trace   events   (mes‐
71              sages/actions)
72
73              A  filter_fun()  takes  an  event  record  as  sole argument and
74              returns false | true | {true, NewEvent}.
75
76              If the collector_pid is undefined a  new  et_collector  will  be
77              started  with  the  following  parameter  settings:  parent_pid,
78              event_order,    trace_global,     trace_pattern,     trace_port,
79              trace_max_queue,  trace_client, dict_insert and dict_delete. The
80              new et_viewer will  register  itself  as  an  et_collector  sub‐
81              scriber.
82
83              Default values:
84
85                * parent_pid - self().
86
87                * title - "et_viewer".
88
89                * detail_level - max.
90
91                * is_suspended - false.
92
93                * scale - 2.
94
95                * width - 800.
96
97                * height - 600.
98
99                * collector_pid - undefined.
100
101                * event_order - trace_ts.
102
103                * active_filter - collector.
104
105                * max_actors - 5.
106
107                * actors - ["UNKNOWN"].
108
109                * first_event - first.
110
111                * hide_unknown - false.
112
113                * hide_actions - false.
114
115                * display_mode - all.
116
117       get_collector_pid(ViewerPid) -> CollectorPid
118
119              Types:
120
121                 ViewerPid = pid()
122                 CollectorPid = pid()
123
124              Returns the identifier of the collector process.
125
126       stop(ViewerPid) -> ok
127
128              Types:
129
130                 ViewerPid = pid()
131
132              Stops a viewer process.
133
134
135
136Ericsson AB                        et 1.6.1                       et_viewer(3)