File: megaco_flex_scanner.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 (30 lines) | stat: -rw-r--r-- 1,158 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
.TH megaco_flex_scanner 3 "megaco  3.8" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
megaco_flex_scanner \- Interface module to the flex scanner linked in driver\&.
.SH DESCRIPTION
.LP
This module contains the public interface to the flex scanner linked in driver\&. The flex scanner performs the scanning phase of text message decoding\&.
.LP
The flex scanner is written using a tool called \fIflex\fR\&. In order to be able to compile the flex scanner driver, this tool has to be available\&. 
.LP
By default the flex scanner reports line-number of an error\&. But it can be built without line-number reporting\&. Instead token number is used\&. This will speed up the scanning some 5-10%\&. Use \fI--disable-megaco-flex-scanner-lineno\fR when configuring the application\&.

.SH EXPORTS
.LP
.B
start() -> {ok, Port} | {error, Reason}
.br
.RS
.TP
Types
Port = port()
.br
Reason = term()
.br
.RE
.RS
.LP
This function is used to start the flex scanner\&. It locates the library and loads the linked in driver\&.
.LP
Note that the process that calls this function \fImust\fR be permament\&. If it dies, the port will exit and the driver unload\&.
.RE