File: inviso_rt_meta.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (58 lines) | stat: -rw-r--r-- 2,562 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
.TH inviso_rt_meta 3 "inviso  0.6" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
inviso_rt_meta \- Direct API to the Inviso Runtime Component\&'s meta tracer
.SH DESCRIPTION
.LP
This module provides a direct API to the inviso meta tracer\&. These functions are only meant to be used in meta tracing \fICallFunc\fR and \fIRemoveFunc\fR\&.
.LP
It can sometimes be necessary to manipulate meta match-patterns from \fICallFunc\fRs and \fIRemoveFunc\fRs\&. The problem then is that call-funcs and remove-funcs are meta trace call-backs executed inside the inviso meta tracer\&'s context\&. Hence making calls to the regular API\&'s manipulating meta trace-patterns will hang the inviso meta tracer!\&.
.LP
To remedy this problem, a number of useful tpm-functions are available in this API\&. It must e understood that theire actions are local to the Erlang node where they are called\&.

.SH EXPORTS
.LP
.B
tpm_ms(Mod,Func,Arity,MSname,MS) -> {ok,0} | {ok,1} | {error,not_initiated}
.br
.RS
.LP
See inviso:tpm_ms/6 for details\&. Note that this function only effects meta trace-patterns on the Erlang node where the function is called\&. This also implies that only the local inviso meta tracer\&'s name-database is updated with \fIMSname\fR\&.
.RE
.LP
.B
tpm_ms_tracer(Mod,Func,Arity,MSname,MS) -> {ok,0} | {ok,1} | {error,not_initiated}
.br
.RS
.LP
See inviso:tpm_ms_ms/6 for details\&. Note that this function only effects meta trace-patterns on the Erlang node where the function is called\&. This also implies that only the local inviso meta tracer\&'s name-database is updated with \fIMSname\fR\&.
.RE
.LP
.B
list_tpm_ms(Mod,Func,Arity) -> [MSname]
.br
.RS
.LP
Returns a list of all \fIMSname\fR in use for \fIMod:Func/Arity\fR\&. This can be useful instead of having to have an own-implemented database over currently in use meta match-functions for a particular function\&.
.RE
.LP
.B
ctpm_ms(Mod,Func,Arity,MSname) -> ok
.br
.RS
.LP
See inviso:ctpm_ms/5 for details\&. Note that this function only effects meta trace-patterns on the Erlang node where the function is called\&. This also implies that only the local inviso meta tracer\&'s name-database is updated with \fIMSname\fR\&.
.RE
.LP
.B
get_tracer() -> Tracer
.br
.RS
.TP
Types
Tracer = pid() | port()
.br
.RE
.RS
.LP
Returns the pid or port acting as the receiver of regular trace messages\&. This is useful if it is necessary to manipulate meta trace-patterns by hand (using \fIerlang:trace_pattern/3\fR) and the \fI{tracer, Tracer}\fR must be used in one of the match-function bodies\&.
.RE