megaco_flex_scanner(3)

MODULE
megaco_flex_scanner - Interface module to the flex scanner linked in driver.

DESCRIPTION

This module contains the public interface to the flex scanner linked in driver. The flex scanner performs the scanning phase of text message decoding.

The flex scanner is written using a tool called flex. In order to be able to compile the flex scanner driver, this tool has to be available.

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 --disable-megaco-flex-scanner-lineno when configuring the application.

EXPORTS

start() -> {ok, Port} | {error, Reason}

    Types
        Port = port()
        Reason = term()

    This function is used to start the flex scanner. It locates the library and loads the linked in driver.

    Note that the process that calls this function must be permament. If it dies, the port will exit and the driver unload.