File: megaco_codec_transform.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 (109 lines) | stat: -rw-r--r-- 2,411 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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
.TH megaco_codec_transform 3 "megaco  3.8" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
megaco_codec_transform \- Megaco message transformation utility\&.
.SH DESCRIPTION
.LP
This module implements a simple megaco message transformation utility\&.
.LP
\fINote\fR that this module is \fInot\fR included in the runtime part of the application\&.

.SH EXPORTS
.LP
.B
tt() -> void()
.br
.RS
.LP
Transform messages using pretty text as base\&. Transform messages from pretty text encoding to compact, ber, per and erlang encoding\&.
.LP
This call is equivalent to the call: \fIt(pretty, [compact, ber, per, erlang])\fR
.RE
.LP
.B
tb() -> void()
.br
.RS
.LP
Transform messages using ber binary as base\&. Transform messages from ber binary encoding to pretty, compact, ber, per and erlang encoding\&.
.LP
This call is equivalent to the call: \fIt(ber, [pretty, compact, per, erlang])\fR
.RE
.LP
.B
t([FromCodec, ToCodecs]) -> ok | {error, Reason}
.br
.RS
.TP
Types
FromCodec = codec_string()
.br
ToCodecs = [codec_string()]
.br
codec_string() = "pretty" | "compact" | "ber" | "per" | "erlang"
.br
.RE
.RS
.LP
Called from the command line (shell) to transform all messages in a given codec dir to a given list of codec dirs\&. The dirs will \fInot\fR be created\&.
.LP
Example: Converts from codec ber to codecs pretty, compact and per

.nf
          erl -noshell -sname megaco \&.\&./ebin \en          -run megaco_codec_transform t ber "pretty compact per" \en              -s erlang halt
        
.fi
.RE
.LP
.B
t(FromCodec, ToCodecs) -> ok | {error, Reason}
.br
.RS
.TP
Types
FromCodec = codec()
.br
ToCodecs = [codec()]
.br
codec() = pretty | compact | ber | per | erlang
.br
.RE
.RS
.LP
Transforms all messages in a given codec dir to a given list of codec dirs\&. The dirs will \fInot\fR be created\&.
.RE
.LP
.B
tmf(FromFile, FromCodec, ToCodec) -> ok | {error, Reason}
.br
.RS
.TP
Types
FromFile = string()
.br
FromCodec = codec()
.br
ToCodec = codec()
.br
.RE
.RS
.LP
Transform a message in a file encoded with the given codec to another codec\&. The resulting message is written to file, in the \fIToCodec\fR dir\&.
.RE
.LP
.B
tm(FromMsg, FromCodec, ToCodec) -> binary()
.br
.RS
.TP
Types
FromMsg = binary()
.br
FromCodec = codec()
.br
ToCodec = codec()
.br
.RE
.RS
.LP
Tranforms a message binary encoded with the given codec to another codec\&. The resulting message is returned (as a binary)\&.
.RE