Search documentation of megaco

# megaco (megaco v4.7.2.1)

View Source

Main API of the Megaco application

Interface module for the Megaco application

# Summary

## Types

action_reply()
action_reps()
action_reqs()
action_request()
conn_handle()
conn_info_item()

This type is a basic (atom) lookup key (for info on an active connection). The corresponding value can be of any type.

counter()
counter_value()
digit_map_event()
digit_map_kind()
digit_map_letter()
digit_map_value()
error_desc()
global_counter()
megaco_message()
megaco_timer()
mid()

The Megaco Identifier.

property_group()
property_groups()
property_parm()
protocol_version()
receive_handle()
sdp()
sdp_property_group()
sdp_property_groups()
sdp_property_parm()
segment_no()
send_handle()

Opaque send handle whose contents is internal for the send module. May be any term.

system_info_item()

trace_data()

The trace data passed to the trace handler fun (in the second argument) and returned by same. For instance this could be a file descriptor, that the trace handler fun can use to print the event to a file.

trace_event()

The trace event generated by dbg.

trace_handler()

The trace handler fun is used to "process" each trace event (for instance print to file or to stdout after formating).

trace_level()

How much trace events should be produced. `min` (=`0`) means no trace events are produced, which is the default.

transaction_id()
transaction_reply()
user_info_item()

- `connections` - Lists all active connections for this user. Returns a list of megaco_conn_handle records.

void()

The type is used when a functions return is to be ignored.

## Functions

call(ConnHandle, ActionRequests, SendOptions)

Sends one or more transaction request(s) and waits for the reply.

cancel(ConnHandle, CancelReason)

Cancel all outstanding messages for this connection

cast(ConnHandle, ActionRequests, SendOptions)

Sends one or more transaction request(s) but does NOT wait for a reply

conn_info(ConnHandle)

Equivalent to `conn_info/2`.

conn_info(ConnHandle, ConnInfo)

Lookup information about an active connection

connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid)

Equivalent to `connect/5`.

connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid, Extra)

Establish a "virtual" connection

decode_sdp(PP)

Decode (parse) a property parameter construct.

disable_trace()

This function is used to stop megaco tracing.

disconnect(ConnHandle, DiscoReason)

Tear down a "virtual" connection

enable_trace(Level, Destination)

This function is used to start megaco tracing at a given `Level` and direct result to the given `Destination`.

encode_actions(ConnHandle, ActionRequests, Options)

Encodes lists of action requests for one or more transaction request(s).

encode_sdp(SDP)

Encode (generate) an SDP construct.

eval_digit_map(DigitMap)

Equivalent to `eval_digit_map/2`.

eval_digit_map(DigitMap, Timers)

Collect digit map letters according to the digit map.

get_stats()

Retreive all (SNMP) statistic counters maintained by the megaco application.

get_stats(ConnHandleOrGCounter)

Retreive a (SNMP) (global) statistic counter maintained by the megaco application.

get_stats(ConnHandle, Counter)

Retreive a (SNMP) statistic counter maintained by the megaco application.

info()

This function produces a list of information about the megaco application. Such as users and their config, connections and their config, statistics and so on.

parse_digit_map(DigitMapBody)

Parses a digit map body

print_version_info()

Equivalent to `print_version_info/1`.

print_version_info(Versions)

Utility function to produce a formated printout of the versions info generated by the `versions1` and `versions2` functions.

process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg)

Equivalent to `process_received_message/5`.

process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra)

Process a received message

receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg)

Equivalent to `receive_message/5`.

receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra)

Process a received message

report_digit_event(DigitMapEvalPid, Events)

Send one or more events to the event collector process.

reset_stats()

Reset all (SNMP) statistics counters.

reset_stats(ConnHandleOrGCounter)

Reset the specified (SNMP) statistics counter.

set_trace(Level)

This function is used to change the megaco trace level.

start()

Starts the Megaco application

start_user(UserMid, Config)

Initial configuration of a user

stop()

Stops the Megaco application

stop_user(UserMid)

Delete the configuration of a user

system_info()

Equivalent to `system_info/1`.

system_info(Item)

Lookup system information.

test_digit_event(DigitMap, Events)

Feed digit map collector with events and return the result

test_reply(ConnHandle, Version, EncodingMod, EncodingConfig, Reply)

Tests if the Reply argument is correctly composed.

test_request(ConnHandle, Version, EncodingMod, EncodingConfig, ActionRequests)

Tests if the Actions argument is correctly composed.

token_tag2string(Tag)

Equivalent to `token_tag2string/3`.

token_tag2string(Tag, EncodingMod)

Equivalent to `token_tag2string/3`.

token_tag2string(Tag, EncodingMod, Version)

Convert a token tag to a string

update_conn_info(ConnHandle, Item, Value)

Update information about an active connection

update_user_info(UserMid, Item, Value)

Update information about a user

user_info(UserMid)

Equivalent to `user_info/2`.

user_info(UserMid, Input)

Lookup user information

versions1()

Equivalent to `versions2/0`.

versions2()

Utility functions used to retrieve some system and application info.

# Types

# action_reply()

    -type action_reply() :: megaco_encoder:action_reply().

# action_reps()

(not exported)

    -type action_reps() :: [action_reply()].

# action_reqs()

(not exported)

    -type action_reqs() :: binary() | [action_request()].

# action_request()

    -type action_request() :: megaco_encoder:action_request().

# conn_handle()

    -type conn_handle() :: megaco_user:conn_handle().

# conn_info_item()

(not exported)

    -type conn_info_item() ::
              control_pid | send_handle | local_mid | remote_mid | receive_handle | trans_id |
              max_trans_id | request_timer | long_request_timer | request_keep_alive_timeout |
              long_request_resend | reply_timer | call_proxy_gc_timeout | auto_ack | trans_ack |
              trans_ack_maxcount | trans_req | trans_req_maxcount | trans_req_maxsize | trans_timer |
              pending_timer | sent_pending_limit | recv_pending_limit | send_mod | encoding_mod |
              encoding_config | protocol_version | strict_version | reply_data | threaded |
              resend_indication | segment_reply_ind | segment_recv_timer | segment_send | max_pdu_size.

This type is a basic (atom) lookup key (for info on an active connection). The corresponding value can be of any type.

- `control_pid` - The process identifier of the controlling process for a connection.

  Value type: pid()

- `send_handle` - Opaque send handle whose contents is internal for the send module.

  Value type: `send_handle/0`

- `local_mid` - The local mid (of the connection, i.e. the own mid).

  Value type: `mid/0`

- `remote_mid` - The remote mid (of the connection).

  Value type: `mid/0`

- `receive_handle` - Construct a megaco_receive_handle record.

  Value type: `receive_handle/0`

- `trans_id` - Next transaction id.

  Note that transaction id's are (currently) maintained on a per user basis so there is no way to be sure that the value returned will actually be used for a transaction sent on this connection (in case a user has several connections, which is not at all unlikely).

  Value type: `transaction_id/0` | `undefined_serial`

- `max_trans_id` - Last transaction id.

  Value type: `transaction_id/0` | `infinity`

- `request_timer` - Wait for reply.

  The timer is cancelled when a reply is received.

  When a pending message is received, the timer is cancelled and the `long_request_timer` is started instead (see below). No resends will be performed from this point (since we now know that the other side has received the request).

  When the timer reaches an intermediate expire, the request is resent and the timer is restarted.

  When the timer reaches the final expire, either the function `megaco:call` will return with `{error, timeout}` or the callback function `handle_trans_reply` will be called with `UserReply = {error, timeout}` (if `megaco:cast` was used).

  Value type: `megaco_timer/0`

  Defaults to `#megaco_incr_timer{}`.

- `long_request_timer` - Wait for reply after having received a pending message.

  When the timer reaches an intermediate expire, the timer restarted.

  When a pending message is received, and the `long_request_timer` is not "on its final leg", the timer will be restarted, and, if `long_request_resend = true`, the request will be re-sent.

  Value type: `megaco_timer/0`

  Defaults to `60 seconds`.

- `request_keep_alive_timeout` - Specifies the timeout time for the request-keep-alive timer.

  This timer is started when the first reply to an asynchronous request (issued using the `megaco:cast/3` function) arrives. As long as this timer is running, replies will be delivered via the handle_trans_reply/4,5 callback function, with their "arrival number" (see `UserReply` of the handle_trans_reply/4,5 callback function).

  Replies arriving after the timer has expired, will be delivered using the handle_unexpected_trans/3,4 callback function.

  Value type: `plain` | non_neg_integer()

  Defaults to `plain`.

- `long_request_resend` - This option indicates weather the request should be resent until the reply is received, even though a pending message has been received.

  Normally, after a pending message has been received, the request is not resent (since a pending message is an indication that the request has been received). But since the reply (to the request) can be lost, this behaviour has its values.

  It is of course pointless to set this value to true unless the `long_request_timer` (see above) is also set to an incremental timer (`#megaco_incr_timer{}`).

  Value type: boolean()

  Defaults to `false`.

- `reply_timer` - Wait for an ack.

  When a request is received, some info related to the reply is store internally (e.g. the binary of the reply). This info will live until either an ack is received or this timer expires. For instance, if the same request is received again (e.g. a request with the same transaction id), the (stored) reply will be (re-) sent automatically by megaco.

  If the timer is of type `#megaco_incr_timer{}`, then for each intermediate timout, the reply will be resent (this is valid until the ack is received or the timer expires).

  Value type: `megaco_timer/0`

  Defaults to `30000`.

- `call_proxy_gc_timeout` - Timeout time for the call proxy.

  When a request is sent using the `call/3` function, a proxy process is started to handle all replies. When the reply has been received and delivered to the user, the proxy process continue to exist for as long as this option specifies. Any received messages, is passed on to the user via the handle_unexpected_trans callback function.

  The timeout time is in milliseconds. A value of 0 (zero) means that the proxy process will exit directly after the reply has been delivered.

  Value type: non_neg_integer()

  Defaults to `5000` (= 5 seconds).

- `auto_ack` - Automatic send transaction ack when the transaction reply has been received (see `trans_ack` below).

  This is used for three-way-handshake.

  Value type: boolean()

  Defaults to `false`.

- `trans_ack` - Shall ack's be accumulated or not.

  This property is only valid if `auto_ack` is true.

  If `auto_ack` is true, then if `trans_ack` is `false`, ack's will be sent immediately. If `trans_ack` is `true`, then ack's will instead be sent to the transaction sender process for accumulation and later sending (see `trans_ack_maxcount`, `trans_req_maxcount`, `trans_req_maxsize`, `trans_ack_maxcount` and `trans_timer`).

  See also transaction sender for more info.

  Value type: boolean()

  Defaults to `false`.

- `trans_ack_maxcount` - Maximum number of accumulated ack's. At most this many ack's will be accumulated by the transaction sender (if started and configured to accumulate ack's).

  See also transaction sender for more info.

  Value type: non_neg_integer()

  Defaults to `10`.

- `trans_req` - Shall requests be accumulated or not.

  If `trans_req` is `false`, then request(s) will be sent immediately (in its own message).

  If `trans_req` is true, then request(s) will instead be sent to the transaction sender process for accumulation and later sending (see `trans_ack_maxcount`, `trans_req_maxcount`, `trans_req_maxsize`, `trans_ack_maxcount` and `trans_timer`).

  See also transaction sender for more info.

  Value type: boolean()

  Defaults to `false`.

- `trans_req_maxcount` - Maximum number of accumulated requests. At most this many requests will be accumulated by the transaction sender (if started and configured to accumulate requests).

  See also transaction sender for more info.

  Value type: non_neg_integer()

  Defaults to `10`.

- `trans_req_maxsize` - Maximum size of the accumulated requests. At most this much requests will be accumulated by the transaction sender (if started and configured to accumulate requests).

  See also transaction sender for more info.

  Value type: non_neg_integer()

  Defaults to `2048`.

- `trans_timer` - Transaction sender timeout time. Has two functions. First, if the value is 0, then transactions will not be accumulated (e.g. the transaction sender process will not be started). Second, if the value is greater then 0 and `auto_ack` and `trans_ack` is true or if `trans_req` is true, then transaction sender will be started and transactions (which is depending on the values of `auto_ack`, `trans_ack` and `trans_req`) will be accumulated, for later sending.

  See also transaction sender for more info.

  Value type: non_neg_integer()

  Defaults to `0`.

- `pending_timer` - Automatic send transaction pending if the timer expires before a transaction reply has been sent. This timer is also called provisional response timer.

  Value type: `megaco_timer/0`

  Defaults to `30000` (= 30 seconds).

- `sent_pending_limit` - Sent pending limit (see the MGOriginatedPendingLimit and the MGCOriginatedPendingLimit of the megaco root package). This parameter specifies how many pending messages that can be sent (for a given received transaction request). When the limit is exceeded, the transaction is aborted (see handle_trans_request_abort) and an error message is sent to the other side.

  Note that this has no effect on the actual sending of pending transactions. This is either implicit (e.g. when receiving a re-sent transaction request for a request which is being processed) or controlled by the pending_timer, see above.

  Value type: pos_integer() | `infinity`

  Defaults to `infinity`.

- `recv_pending_limit` - Receive pending limit (see the MGOriginatedPendingLimit and the MGCOriginatedPendingLimit of the megaco root package). This parameter specifies how many pending messages that can be received (for a sent transaction request). When the limit is exceeded, the transaction is considered lost, and an error returned to the user (through the call-back function handle_trans_reply).

  Value type: pos_integer() | `infinity`

  Defaults to `infinity`.

- `send_mod` - Send callback module which exports send_message/2. The function SendMod:send_message(SendHandle, Binary) is invoked when the bytes needs to be transmitted to the remote user.

  Value type: module().

  Defaults to `megaco_tcp`.

- `encoding_mod` - Encoding callback module which exports encode_message/2 and decode_message/2. The function EncodingMod:encode_message(EncodingConfig, MegacoMessage) is invoked whenever a 'MegacoMessage' record needs to be translated into an Erlang binary. The function EncodingMod:decode_message(EncodingConfig, Binary) is invoked whenever an Erlang binary needs to be translated into a 'MegacoMessage' record.

  Value type: module().

  Defaults to `megaco_pretty_text_encoder`.

- `encoding_config` - Encoding module config.

  Value type: loist().

  Defaults to `[]`.

- `protocol_version` - Actual protocol version.

  Value type: `protocol_version/0`

  Defaults to `1`.

- `strict_version` - Strict version control, i.e. when a message is received, verify that the version is that which was negotiated.

  Value type: boolean()

  Defaults to `true`.

- `reply_data` - Default reply data.

  Value type: term()

  Defaults to `undefined`.

- `threaded` - If a received message contains several transaction requests, this option indicates whether the requests should be handled sequentially in the same process (`false`), or if each request should be handled by its own process (`true` i.e. a separate process is spawned for each request).

  Value type: boolean()

  Defaults to `false`.

- `resend_indication` - This option indicates weather the transport module should be told if a message send is a resend or not.

  If false, megaco messages are sent using the send_message/2 function.

  If true, megaco message re-sends are made using the resend_message function. The initial message send is still done using the send_message function.

  The special value flag instead indicates that the function send_message/3 shall be used.

  Value type: `flag` | boolean()

  Defaults to `false`.

- `segment_reply_ind` - This option specifies if the user shall be notified of received segment replies or not.

  See handle_segment_reply callback function for more information.

  Value type: boolean()

  Defaults to `false`.

- `segment_recv_timer` - This timer is started when the segment indicated by the `segmentation complete token` (e.g. the last of the segment which makes up the reply) is received, but all segments has not yet been received.

  When the timer finally expires, a "megaco segments not received" (459) error message is sent to the other side and the user is notified with a `segment timeout` `UserReply` in either the handle_trans_reply callback function or the return value of the `call/2` function.

  Value type: `megaco_timer/0`

  Defaults to `10000` (= 10 seconds).

- `segment_send` - Shall outgoing messages be segmented or not.

  Value type: `none` | pos_integer() | `infinity`

  - `none` - Do not segment outgoing reply messages. This is useful when either it is known that messages are never to large or that the transport protocol can handle such things on its own (e.g. TCP or SCTP).

  - `pos_integer/0` - Outgoing reply messages will be segmented as needed (see `max_pdu_size` below). This value, K, indicate the outstanding window, i.e. how many segments can be outstanding (not acknowledged) at any given time.

  - `infinity` - Outgoing reply messages will be segmented as needed (see `max_pdu_size` below). Segment messages are sent all at once (i.e. no acknowledgement awaited before sending the next segment).

  Defaults to `none`.

- `max_pdu_size` - Max message size. If the encoded message (PDU) exceeds this size, the message should be segmented, and then encoded.

  Value type: `infinity` | pos_integer()

  Defaults to `infinity`.

# counter()

(not exported)

    -type counter() :: medGwyGatewayNumTimerRecovery | medGwyGatewayNumErrors.

# counter_value()

(not exported)

    -type counter_value() :: non_neg_integer().

# digit_map_event()

    -type digit_map_event() :: megaco_digit_map:event().

# digit_map_kind()

    -type digit_map_kind() :: megaco_digit_map:kind().

# digit_map_letter()

    -type digit_map_letter() :: megaco_digit_map:letter().

# digit_map_value()

    -type digit_map_value() :: megaco_digit_map:value().

# error_desc()

    -type error_desc() :: megaco_encoder:error_desc().

# global_counter()

(not exported)

    -type global_counter() :: medGwyGatewayNumErrors.

# megaco_message()

(not exported)

    -type megaco_message() :: megaco_encoder:megaco_message().

# megaco_timer()

(not exported)

    -type megaco_timer() :: megaco_user:megaco_timer().

# mid()

    -type mid() ::
              {ip4Address, megaco_encoder:ip4Address()} |
              {ip6Address, megaco_encoder:ip6Address()} |
              {domainName, megaco_encoder:domainName()} |
              {deviceName, megaco_encoder:deviceName()} |
              {mtpAddress, megaco_encoder:mtpAddress()}.

The Megaco Identifier.

# property_group()

    -type property_group() :: megaco_sdp:property_group().

# property_groups()

    -type property_groups() :: megaco_sdp:property_groups().

# property_parm()

    -type property_parm() :: megaco_sdp:property_parm().

# protocol_version()

    -type protocol_version() :: megaco_encoder:protocol_version().

# receive_handle()

    -type receive_handle() :: megaco_user:receive_handle().

# sdp()

    -type sdp() :: megaco_sdp:sdp().

# sdp_property_group()

(not exported)

    -type sdp_property_group() :: megaco_sdp:sdp_property_group().

# sdp_property_groups()

(not exported)

    -type sdp_property_groups() :: megaco_sdp:sdp_property_groups().

# sdp_property_parm()

(not exported)

    -type sdp_property_parm() :: megaco_sdp:sdp_property_parm().

# segment_no()

(not exported)

    -type segment_no() :: megaco_encoder:segment_no().

# send_handle()

(not exported)

    -type send_handle() :: term().

Opaque send handle whose contents is internal for the send module. May be any term.

# system_info_item()

(not exported)

    -type system_info_item() ::
              text_config | connections | users | n_active_requests | n_active_replies |
              n_active_connections | reply_counters | pending_counters.

- `text_config` - The text encoding config.

  Value type: term()

- `connections` - Lists all active connections. Returns a list of megaco_conn_handle records.

  Value type: [`conn_handle/0`]

- `users` - Lists all active users.

  Value type: [`mid/0`]

- `n_active_requests` - Returns number of requests that has originated from this Erlang node and still are active (and therefore consumes system resources).

  Value type: non_neg_integer()

- `n_active_replies` - Returns the number of replies that has originated from this Erlang node and still are active (and therefore consumes system resources).

  Value type: non_neg_integer()

- `n_active_connections` - Returns the number of active connections.

  Value type: non_neg_integer()

- `reply_counters` - Returns a list of the reply counters.

  Value type: [{`conn_handle/0`, `transaction_id/0`, non_neg_integer()}]

- `pending_counters` - Returns a list of the receive and sent pending counters.

  Value type: [{recv | sent, [{`transaction_id/0`, non_neg_integer()}]}]

# trace_data()

(not exported)

    -type trace_data() :: term().

The trace data passed to the trace handler fun (in the second argument) and returned by same. For instance this could be a file descriptor, that the trace handler fun can use to print the event to a file.

# trace_event()

(not exported)

    -type trace_event() :: term().

The trace event generated by dbg.

# trace_handler()

(not exported)

    -type trace_handler() :: fun((trace_event(), trace_data()) -> trace_data()).

The trace handler fun is used to "process" each trace event (for instance print to file or to stdout after formating).

# trace_level()

    -type trace_level() :: min | max | 0..100.

How much trace events should be produced. `min` (=`0`) means no trace events are produced, which is the default.

# transaction_id()

(not exported)

    -type transaction_id() :: pos_integer().

# transaction_reply()

    -type transaction_reply() :: megaco_encoder:transaction_reply().

# user_info_item()

(not exported)

    -type user_info_item() ::
              connections | receive_handle | trans_id | min_trans_id | max_trans_id | request_timer |
              long_request_timer | long_request_resend | reply_timer | request_keep_alive_timeout |
              call_proxy_gc_timeout | auto_ack | trans_ack | trans_ack_maxcount | trans_req |
              trans_req_maxcount | trans_req_maxsize | trans_timer | pending_timer | sent_pending_limit |
              recv_pending_limit | send_mod | encoding_mod | encoding_config | protocol_version |
              strict_version | reply_data | user_mod | user_args | threaded | resend_indication |
              segment_reply_ind | segment_recv_timer | segment_send | max_pdu_size.

- `connections` - Lists all active connections for this user. Returns a list of megaco_conn_handle records.

  Value type: [`conn_handle/0`]

- `receive_handle` - Construct a receive_handle from user config.

  Value type: `receive_handle/0`

- `trans_id` - Current transaction id.

  Value type: `transaction_id/0` | `undefined_serial`

- `min_trans_id` - First transaction id.

  Value type: `transaction_id/0`

  Defaults to `1`.

- `max_trans_id` - Last transaction id.

  Value type: `transaction_id/0` | `infinity`

  Defaults to `infinity`.

- `request_timer` - Wait for reply.

  The timer is cancelled when a reply is received.

  When a pending message is received, the timer is cancelled and the `long_request_timer` is started instead (see below). No resends will be performed from this point (since we now know that the other side has received the request).

  When the timer reaches an intermediate expire, the request is resent and the timer is restarted.

  When the timer reaches the final expire, either the function `megaco:call` will return with `{error, timeout}` or the callback function `handle_trans_reply` will be called with `UserReply = {error, timeout}` (if `megaco:cast` was used).

  Value type: `megaco_timer/0`

  Defaults to `#megaco_incr_timer{}`.

- `long_request_timer` - Wait for reply after having received a pending message.

  When the timer reaches an intermediate expire, the timer is restarted.

  When a pending message is received, and the `long_request_timer` is not "on its final leg", the timer will be restarted, and, if `long_request_resend = true`, the request will be re-sent.

  Value type: `megaco_timer/0`

  Defaults to `60000` (= 60 seconds).

- `long_request_resend` - This option indicates weather the request should be resent until the reply is received, even though a pending message has been received.

  Normally, after a pending message has been received, the request is not resent (since a pending message is an indication that the request has been received). But since the reply (to the request) can be lost, this behaviour has its values.

  It is of course pointless to set this value to true unless the `long_request_timer` (see above) is also set to an incremental timer (`#megaco_incr_timer{}`).

  Value type: boolean()

  Defaults to `false`.

- `reply_timer` - Wait for an ack.

  When a request is received, some info related to the reply is store internally (e.g. the binary of the reply). This info will live until either an ack is received or this timer expires. For instance, if the same request is received again (e.g. a request with the same transaction id), the (stored) reply will be (re-) sent automatically by megaco.

  If the timer is of type `#megaco_incr_timer{}`, then for each intermediate timout, the reply will be resent (this is valid until the ack is received or the timer expires).

  Value type: `megaco_timer/0`

  Defaults to `30 seconds`.

- `request_keep_alive_timeout` - Specifies the timeout time for the request-keep-alive timer.

  This timer is started when the first reply to an asynchronous request (issued using the `megaco:cast/3` function) arrives. As long as this timer is running, replies will be delivered via the handle_trans_reply/4,5 callback function, with their "arrival number" (see `UserReply` of the handle_trans_reply/4,5 callback function).

  Replies arriving after the timer has expired, will be delivered using the handle_unexpected_trans/3,4 callback function.

  Value type: `plain` | non_neg_integer()

  Defaults to `plain`.

- `call_proxy_gc_timeout` - Timeout time for the call proxy.

  When a request is sent using the `call/3` function, a proxy process is started to handle all replies. When the reply has been received and delivered to the user, the proxy process continue to exist for as long as this option specifies. Any received messages, is passed on to the user via the handle_unexpected_trans callback function.

  The timeout time is in milliseconds. A value of 0 (zero) means that the proxy process will exit directly after the reply has been delivered.

  Value type: pos_integer()

  Defaults to `5000` (= 5 seconds).

- `auto_ack` - Automatic send transaction ack when the transaction reply has been received (see `trans_ack` below).

  This is used for three-way-handshake.

  Value type: boolean()

  Defaults to `false`.

- `trans_ack` - Shall ack's be accumulated or not.

  This property is only valid if `auto_ack` is true.

  If `auto_ack` is true, then if `trans_ack` is `false`, ack's will be sent immediately. If `trans_ack` is `true`, then ack's will instead be sent to the transaction sender process for accumulation and later sending (see `trans_ack_maxcount`, `trans_req_maxcount`, `trans_req_maxsize`, `trans_ack_maxcount` and `trans_timer`).

  See also transaction sender for more info.

  Value type: boolean()

  Defaults to `false`.

- `trans_ack_maxcount` - Maximum number of accumulated ack's. At most this many ack's will be accumulated by the transaction sender (if started and configured to accumulate ack's).

  See also transaction sender for more info.

  Value type: integer()

  Defaults to `10`.

- `trans_req` - Shall requests be accumulated or not.

  If `trans_req` is `false`, then request(s) will be sent immediately (in its own message).

  If `trans_req` is true, then request(s) will instead be sent to the transaction sender process for accumulation and later sending (see `trans_ack_maxcount`, `trans_req_maxcount`, `trans_req_maxsize`, `trans_ack_maxcount` and `trans_timer`).

  See also transaction sender for more info.

  Value type: boolean()

  Defaults to `false`.

- `trans_req_maxcount` - Maximum number of accumulated requests. At most this many requests will be accumulated by the transaction sender (if started and configured to accumulate requests).

  See also transaction sender for more info.

  Value type: integer()

  Defaults to `10`.

- `trans_req_maxsize` - Maximum size of the accumulated requests. At most this much requests will be accumulated by the transaction sender (if started and configured to accumulate requests).

  See also transaction sender for more info.

  Value type: integer()

  Defaults to `2048`.

- `trans_timer` - Transaction sender timeout time. Has two functions. First, if the value is 0, then transactions will not be accumulated (e.g. the transaction sender process will not be started). Second, if the value is greater then 0 and `auto_ack` and `trans_ack` are both true or if `trans_req` is true, then transaction sender will be started and transactions (which is depending on the values of `auto_ack`, `trans_ack` and `trans_req`) will be accumulated, for later sending.

  See also transaction sender for more info.

  Value type: integer()

  Defaults to `0`.

- `pending_timer` - Automatically send pending if the timer expires before a transaction reply has been sent. This timer is also called provisional response timer.

  Value type: `megaco_timer/0`

  Defaults to `30000`.

- `sent_pending_limit` - Sent pending limit (see the MGOriginatedPendingLimit and the MGCOriginatedPendingLimit of the megaco root package). This parameter specifies how many pending messages that can be sent (for a given received transaction request). When the limit is exceeded, the transaction is aborted (see handle_trans_request_abort) and an error message is sent to the other side.

  Note that this has no effect on the actual sending of pending transactions. This is either implicit (e.g. when receiving a re-sent transaction request for a request which is being processed) or controlled by the pending_timer, see above.

  Value type: `infinity` | pos_integer()

  Defaults to `infinity`.

- `recv_pending_limit` - Receive pending limit (see the MGOriginatedPendingLimit and the MGCOriginatedPendingLimit of the megaco root package). This parameter specifies how many pending messages that can be received (for a sent transaction request). When the limit is exceeded, the transaction is considered lost, and an error returned to the user (through the call-back function handle_trans_reply).

  Value type: `infinity` | pos_integer()

  Defaults to `infinity`.

- `send_mod` - Send callback module which exports send_message/2. The function SendMod:send_message(SendHandle, Binary) is invoked when the bytes needs to be transmitted to the remote user.

  Value type: module()

  Defaults to `megaco_tcp`.

- `encoding_mod` - Encoding callback module which exports encode_message/2 and decode_message/2. The function EncodingMod:encode_message(EncodingConfig, MegacoMessage) is invoked whenever a 'MegacoMessage' record needs to be translated into an Erlang binary. The function EncodingMod:decode_message(EncodingConfig, Binary) is invoked whenever an Erlang binary needs to be translated into a 'MegacoMessage' record.

  Value type: module()

  Defaults to `megaco_pretty_text_encoder`.

- `encoding_config` - Encoding module config.

  Value type: list()

  Defaults to `[]`.

- `protocol_version` - Actual protocol version.

  Value type: `protocol_version/0`

  Defaults to `1`.

- `strict_version` - Strict version control, i.e. when a message is received, verify that the version is that which was negotiated.

  Value type: boolean()

  Defaults to `true`.

- `reply_data` - Default reply data.

  Value type: term()

  Defaults to `undefined`.

- `user_mod` - Name of the user callback module. See the the reference manual for megaco_user for more info.

  Value type: module()

  Has no default value since its an mandatory config option.

- `user_args` - List of extra arguments to the user callback functions. See the the reference manual for megaco_user for more info.

  Value type: list()

- `threaded` - If a received message contains several transaction requests, this option indicates whether the requests should be handled sequentially in the same process (`false`), or if each request should be handled by its own process (`true` i.e. a separate process is spawned for each request).

  Value type: boolean()

  Defaults to `false`.

- `resend_indication` - This option indicates weather the transport module should be told if a message send is a resend or not.

  If false, megaco messages are sent using the send_message function.

  If true, megaco message re-sends are made using the resend_message function. The initial message send is still done using the send_message function.

  The special value flag instead indicates that the function send_message/3 shall be used.

  Value type: boolean()

  Defaults to `false`.

- `segment_reply_ind` - This option specifies if the user shall be notified of received segment replies or not.

  See handle_segment_reply callback function for more information.

  Value type: boolean()

  Defaults to `false`.

- `segment_recv_timer` - This timer is started when the segment indicated by the `segmentation complete token` is received, but all segments has not yet been received.

  When the timer finally expires, a "megaco segments not received" (459) error message is sent to the other side and the user is notified with a `segment timeout` `UserReply` in either the handle_trans_reply callback function or the return value of the `call/3` function.

  Value type: `megaco_timer/0`

  Defaults to `10000`.

- `segment_send` - Shall outgoing messages be segmented or not.

  Value type: `none` | pos_integer() | `infinity`

  - `none` - Do not segment outgoing reply messages. This is useful when either it is known that messages are never to large or that the transport protocol can handle such things on its own (e.g. TCP or SCTP).

  - `pos_integer/0` - Outgoing reply messages will be segmented as needed (see `max_pdu_size` below). This value, K, indicate the outstanding window, i.e. how many segments can be outstanding (not acknowledged) at any given time.

  - `infinity` - Outgoing reply messages will be segmented as needed (see `max_pdu_size` below). Segment messages are sent all at once (i.e. no acknowledgement awaited before sending the next segment).

  Defaults to `none`.

- `max_pdu_size` - Max message size. If the encoded message (PDU) exceeds this size, the message should be segmented, and then encoded.

  Value type: `infinity` | pos_integer()

  Defaults to `infinity`.

# void()

    -type void() :: term().

The type is used when a functions return is to be ignored.

# Functions

# call(ConnHandle, ActionRequests, SendOptions)

    -spec call(ConnHandle, ActionRequests, SendOptions) -> {ProtocolVersion, UserReply | [UserReply]}
                  when
                      ConnHandle :: conn_handle(),
                      ActionRequests :: action_reqs() | [action_reqs()],
                      SendOptions :: [SendOption],
                      SendOption ::
                          {request_timer, megaco_timer()} |
                          {long_request_timer, megaco_timer()} |
                          {send_handle, send_handle()} |
                          {protocol_version, protocol_version()} |
                          {call_proxy_gc_timeout, non_neg_integer()},
                      ProtocolVersion :: protocol_version(),
                      UserReply :: Success | Failure,
                      Success :: {ok, Result} | {ok, Result, SuccessExtra},
                      Result :: MessageResult | SegmentResult,
                      MessageResult :: action_reps(),
                      SegmentResult :: SegmentsOk,
                      SegmentsOk :: [{segment_no(), action_reps()}],
                      Failure :: {error, Reason} | {error, Reason, ErrorExtra},
                      Reason :: MessageReason | SegmentReason | UserCancelReason | SendReason | OtherReason,
                      MessageReason :: error_desc(),
                      SegmentReason ::
                          {segment, SegmentsOk, SegmentsErr} |
                          {segment_timeout, MissingSegments, SegmentsOk, SegmentsErr},
                      SegmentsErr :: {segment_no(), error_desc()},
                      MissingSegments :: [segment_no()],
                      UserCancelReason :: {user_cancel, ReasonForUserCancel},
                      ReasonForUserCancel :: term(),
                      SendReason :: SendCancelledReason | SendFailedReason,
                      SendCancelledReason :: {send_message_cancelled, term()},
                      SendFailedReason :: {send_message_failed, term()},
                      OtherReason ::
                          {wrong_mid, WrongMid :: mid(), RightMid :: mid(), transaction_reply()} | term(),
                      SuccessExtra :: term(),
                      ErrorExtra :: term().

Sends one or more transaction request(s) and waits for the reply.

When sending one transaction in a message, `ActionRequests` should be `action_reqs/0` (the reply will then be `UserReply`). When sending several transactions in a message, `ActionRequests` should be `[action_reqs()]` (the reply will then be `[UserReply]`). Each element of the list is part of one transaction.

For some of our codecs (not binary), it is also possible to pre-encode the actions, in which case `ActionRequests` will be either a `binary/0` or `[binary()]`.

The function returns when the reply arrives, when the request timer eventually times out or when the outstanding requests are explicitly cancelled.

The default values of the send options are obtained by `megaco:conn_info(ConnHandle, Item)`. But the send options above, may explicitly be overridden.

The `ProtocolVersion` version is the version actually encoded in the reply message.

At `Success`, the `UserReply` contains a list of 'ActionReply' records possibly containing error indications.

A `Failure`, indicates that the remote user has replied with an explicit transactionError.

A `UserCancelReason`, indicates that the request has been canceled by the user. `ReasonForUserCancel` is the reason given in the call to the `cancel/2` function.

A send error (`SendReason`), indicates that the send function of the megaco transport callback module failed to send the request. There are two separate cases: `SendCancelledReason` and `SendFailedReason`. The first is the result of the send function returning `{cancel, Reason}` and the second is some other kind of erroneous return value. See the send_message function for more info.

An `OtherReason`, indicates some other error such as timeout.

For more info about the 'extra' part of the result (`SuccessExtra` and `ErrorExtra`), see the note in the user callback module documentation.

# cancel(ConnHandle, CancelReason)

    -spec cancel(ConnHandle, CancelReason) -> ok | {error, Reason}
                    when ConnHandle :: conn_handle(), CancelReason :: term(), Reason :: term().

Cancel all outstanding messages for this connection

This causes outstanding megaco:call/3 requests to return. The callback functions UserMod:handle_reply/4 and UserMod:handle_trans_ack/4 are also invoked where it applies. See the megaco_user module for more info about the callback arguments.

# cast(ConnHandle, ActionRequests, SendOptions)

    -spec cast(ConnHandle, ActionRequests, SendOptions) -> ok | {error, Reason}
                  when
                      ConnHandle :: conn_handle(),
                      ActionRequests :: action_reqs() | [action_reqs()],
                      SendOptions :: [SendOption],
                      SendOption ::
                          {request_keep_alive_timeout, RequestKeepAliveTimer} |
                          {request_timer, megaco_timer()} |
                          {long_request_timer, megaco_timer()} |
                          {send_handle, send_handle()} |
                          {reply_data, ReplyData} |
                          {protocol_version, ProtocolVersion},
                      RequestKeepAliveTimer :: plain | non_neg_integer(),
                      ReplyData :: term(),
                      ProtocolVersion :: protocol_version(),
                      Reason :: term().

Sends one or more transaction request(s) but does NOT wait for a reply

When sending one transaction in a message, `ActionRequests` should be `action_reqs/0`. When sending several transactions in a message, `ActionRequests` should be `[action_reqs()]`. Each element of the list is part of one transaction.

For some of our codecs (not binary), it is also possible to pre-encode the actions, in which case `Actions` will be either a `binary/0` or `[binary()]`.

The default values of the send options are obtained by megaco:conn_info(ConnHandle, Item). But the send options above, may explicitly be overridden.

The ProtocolVersion version is the version actually encoded in the reply message.

The callback function UserMod:handle_trans_reply/4 is invoked when the reply arrives, when the request timer eventually times out or when the outstanding requests are explicitly cancelled. See the megaco_user module for more info about the callback arguments.

Given as `ReplyData` argument to UserMod:handle_trans_reply/4.

# conn_info(ConnHandle)

    -spec conn_info(ConnHandle) -> [{Item, Value}]
                       when
                           ConnHandle :: conn_handle(),
                           Item :: requests | replies | conn_info_item(),
                           Value :: term().

Equivalent to `conn_info/2`.

# conn_info(ConnHandle, ConnInfo)

    -spec conn_info(ConnHandle, ConnInfo) -> Value
                       when
                           ConnHandle :: conn_handle(),
                           ConnInfo :: all | requests | replies | conn_info_item(),
                           Value :: term().

Lookup information about an active connection

Requires that the connection is active.

Failure: `exit` if, for instance, `ConnHandle` refers to a connection that no longer exists.

# connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid)

    -spec connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid) -> {ok, ConnHandle} | {error, Reason}
                     when
                         ReceiveHandle :: receive_handle(),
                         RemoteMid :: preliminary_mid | mid(),
                         SendHandle :: send_handle(),
                         ControlPid :: pid(),
                         ConnHandle :: conn_handle(),
                         Reason :: ConnectReason | HandleConnectReason | term(),
                         ConnectReason ::
                             {no_such_user, LocalMid} | {already_connected, ConnHandle} | term(),
                         LocalMid :: mid(),
                         HandleConnectReason :: {connection_refused, ConnData, ErrorInfo} | term(),
                         ConnData :: term(),
                         ErrorInfo :: term().

Equivalent to `connect/5`.

# connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid, Extra)

    -spec connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid, Extra) ->
                     {ok, ConnHandle} | {error, Reason}
                     when
                         ReceiveHandle :: receive_handle(),
                         RemoteMid :: preliminary_mid | mid(),
                         SendHandle :: send_handle(),
                         ControlPid :: pid(),
                         Extra :: term(),
                         ConnHandle :: conn_handle(),
                         Reason :: ConnectReason | HandleConnectReason | term(),
                         ConnectReason ::
                             {no_such_user, LocalMid} | {already_connected, ConnHandle} | term(),
                         LocalMid :: mid(),
                         HandleConnectReason :: {connection_refused, ConnData, ErrorInfo} | term(),
                         ConnData :: term(),
                         ErrorInfo :: term().

Establish a "virtual" connection

Activates a connection to a remote user. When this is done the connection can be used to send messages (with `SendMod:send_message/2`). The `ControlPid` is the identifier of a process that controls the connection. That process will be supervised and if it dies, this will be detected and the `UserMod:handle_disconnect/2` callback function will be invoked. See the megaco_user module for more info about the callback arguments. The connection may also explicitly be deactivated by invoking `megaco:disconnect/2`.

The `ControlPid` may be the identity of a process residing on another Erlang node. This is useful when you want to distribute a user over several Erlang nodes. In such a case one of the nodes has the physical connection. When a user residing on one of the other nodes needs to send a request (with `megaco:call/3` or `megaco:cast/3`), the message will encoded on the originating Erlang node, and then be forwarded to the node with the physical connection. When the reply arrives, it will be forwarded back to the originator. The distributed connection may explicitly be deactivated by a local call to `megaco:disconnect/2` or implicitly when the physical connection is deactivated (with `megaco:disconnect/2`, killing the controlling process, halting the other node, ...).

The call of this function will trigger the callback function `UserMod:handle_connect/2` to be invoked. See the megaco_user module for more info about the callback arguments.

A connection may be established in several ways:

- `provisioned MID` - The MG may explicitly invoke megaco:connect/4 and use a provisioned MID of the MGC as the RemoteMid.

- `upgrade preliminary MID` - The MG may explicitly invoke megaco:connect/4 with the atom 'preliminary_mid' as a temporary MID of the MGC, send an intial message, the Service Change Request, to the MGC and then wait for an initial message, the Service Change Reply. When the reply arrives, the Megaco application will pick the MID of the MGC from the message header and automatically upgrade the connection to be a "normal" connection. By using this method of establishing the connection, the callback function `UserMod:handle_connect/2` to be invoked twice. First with a `ConnHandle` with the remote_mid-field set to preliminary_mid, and then when the connection upgrade is done with the remote_mid-field set to the actual MID of the MGC.

- `automatic` - When the MGC receives its first message, the Service Change Request, the Megaco application will automatically establish the connection by using the MG MID found in the message header as remote mid.

- `distributed` - When a user (MG/MGC) is distributed over several nodes, it is required that the node hosting the connection already has activated the connection and that it is in the "normal" state. The `RemoteMid` must be a real Megaco MID and not a `preliminary_mid`.

An initial megaco_receive_handle record may be obtained with `megaco:user_info(UserMid, receive_handle)`

The send handle is provided by the preferred transport module, e.g. megaco_tcp, megaco_udp. Read the documentation about each transport module about the details.

The connect is done in two steps: first an internal `connection setup` and then by calling the user handle_connect callback function. The first step could result in an error with `Reason = ConnectReason` and the second an error with `Reason = HandleConnectReason`:

- `ConnectReason` - An error with this reason is generated by the megaco application itself.

- `HandleConnectReason` - An error with this reason is caused by the user handle_connect callback function either returning an error or an invalid value.

`Extra` can be any `term/0` except the atom `ignore_extra`. It is passed (back) to the user via the callback function handle_connect/3.

# decode_sdp(PP)

    -spec decode_sdp(PP) -> {ok, SDP} | {error, Reason}
                        when
                            PP :: property_parm() | property_group() | property_groups() | asn1_NOVALUE,
                            SDP :: sdp() | DecodeSdpPropertyGroup | DecodeSdpPropertyGroups | asn1_NOVALUE,
                            DecodeSdpPropertyGroup :: [DecodeSDP],
                            DecodeSdpPropertyGroups :: [DecodeSdpPropertyGroup],
                            DecodeSDP :: sdp() | {property_parm(), DecodeError},
                            DecodeError :: term(),
                            Reason :: term().

Decode (parse) a property parameter construct.

When decoding `property_group/0` or `property_groups/0`, those property parameter constructs that cannot be decoded (either because of decode error or because they are unknown), will be returned as a two-tuple. The first element of which will be the (undecoded) property parameter and the other the actual reason. This means that the caller of this function has to expect not only sdp-records, but also this two-tuple construct.

This function performs the following transformation:

- property_parm() -> sdp()
- property_group() -> sdp_property_group()
- property_groups() -> sdp_property_groups()

# disable_trace()

    -spec disable_trace() -> void().

This function is used to stop megaco tracing.

# disconnect(ConnHandle, DiscoReason)

    -spec disconnect(ConnHandle, DiscoReason) -> ok | {error, ErrReason}
                        when ConnHandle :: conn_handle(), DiscoReason :: term(), ErrReason :: term().

Tear down a "virtual" connection

Causes the `UserMod:handle_disconnect/2` callback function to be invoked. See the megaco_user module for more info about the callback arguments.

# enable_trace(Level, Destination)

    -spec enable_trace(Level, Destination) -> void()
                          when
                              Level :: trace_level(),
                              Destination :: File | Port | HandlerSpec | io,
                              File :: string(),
                              Port :: integer(),
                              HandlerSpec :: {HandlerFun, InitialData},
                              HandlerFun :: trace_handler(),
                              InitialData :: trace_data().

This function is used to start megaco tracing at a given `Level` and direct result to the given `Destination`.

It starts a tracer server and then sets the proper match spec (according to `Level`).

In the case when `Destination` is `File`, the printable megaco trace events will be printed to the file `File` using plain `io:format/2`.

In the case when `Destination` is `io`, the printable megaco trace events will be printed on stdout using plain `io:format/2`.

See `dbg` for further information.

# encode_actions(ConnHandle, ActionRequests, Options)

    -spec encode_actions(ConnHandle, ActionRequests, Options) -> {ok, Result} | {error, Reason}
                            when
                                ConnHandle :: conn_handle(),
                                ActionRequests :: action_reqs() | [action_reqs()],
                                Options :: [Option],
                                Option ::
                                    {request_timer, megaco_timer()} |
                                    {long_request_timer, megaco_timer()} |
                                    {send_handle, send_handle()} |
                                    {protocol_version, protocol_version()},
                                Result :: binary() | [binary()],
                                Reason :: term().

Encodes lists of action requests for one or more transaction request(s).

When encoding action requests for one transaction, `Actions` should be `action_reqs/0`. When encoding action requests for several transactions, `Actions` should be `[action_reqs()]`. Each element of the list is part of one transaction.

# encode_sdp(SDP)

    -spec encode_sdp(SDP) -> {ok, PP} | {error, Reason}
                        when
                            SDP ::
                                sdp_property_parm() |
                                sdp_property_group() |
                                sdp_property_groups() |
                                asn1_NOVALUE,
                            PP :: property_parm() | property_group() | property_groups() | asn1_NOVALUE,
                            Reason :: term().

Encode (generate) an SDP construct.

If a `property_parm/0` is found as part of the input (`SDP`) then it is left unchanged.

This function performs the following transformation:

- sdp() -> property_parm()
- sdp_property_group() -> property_group()
- sdp_property_groups() -> property_groups()

# eval_digit_map(DigitMap)

    -spec eval_digit_map(DigitMap) -> {ok, MatchResult} | {error, Reason}
                            when
                                DigitMap :: digit_map_value() | ParsedDigitMap,
                                ParsedDigitMap :: term(),
                                MatchResult :: {Kind, Letters} | {Kind, Letters, Extra},
                                Kind :: digit_map_kind(),
                                Letters :: [digit_map_letter()],
                                Extra :: digit_map_letter(),
                                Reason :: term().

Equivalent to `eval_digit_map/2`.

# eval_digit_map(DigitMap, Timers)

    -spec eval_digit_map(DigitMap, Timers) -> {ok, MatchResult} | {error, Reason}
                            when
                                DigitMap :: digit_map_value() | ParsedDigitMap,
                                ParsedDigitMap :: term(),
                                Timers :: Ignore | Reject,
                                Ignore :: ignore | {ignore, digit_map_value()},
                                Reject :: reject | {reject, digit_map_value()} | digit_map_value(),
                                MatchResult :: {Kind, Letters} | {Kind, Letters, Extra},
                                Kind :: digit_map_kind(),
                                Letters :: [digit_map_letter()],
                                Extra :: digit_map_letter(),
                                Reason :: term().

Collect digit map letters according to the digit map.

When evaluating a digit map, a state machine waits for timeouts and letters reported by megaco:report_digit_event/2. The length of the various timeouts are defined in the digit_map_value() record.

When a complete sequence of valid events has been received, the result is returned as a list of letters.

There are two options for handling syntax errors (that is when an unexpected event is received when the digit map evaluator is expecting some other event). The unexpected events may either be ignored or rejected. The latter means that the evaluation is aborted and an error is returned.

# get_stats()

    -spec get_stats() -> {ok, [TotalStats]} | {error, Reason}
                       when
                           TotalStats :: {conn_handle(), [Stats]} | {global_counter(), counter_value()},
                           Stats :: {counter(), counter_value()},
                           Reason :: term().

Retreive all (SNMP) statistic counters maintained by the megaco application.

The global counters handle events that cannot be attributed to a single connection (e.g. protocol errors that occur before the connection has been properly setup).

# get_stats(ConnHandleOrGCounter)

    -spec get_stats(GCounter) -> {ok, Value} | {error, Reason}
                       when GCounter :: global_counter(), Value :: counter_value(), Reason :: term();
                   (ConnHandle) -> {ok, [Stats]} | {error, Reason}
                       when
                           ConnHandle :: conn_handle(),
                           Stats :: {counter(), counter_value()},
                           Reason :: term().

Retreive a (SNMP) (global) statistic counter maintained by the megaco application.

The global counters handle events that cannot be attributed to a single connection (e.g. protocol errors that occur before the connection has been properly setup).

Retreive all (SNMP) statistic counters maintained by the megaco application, for a specific connection.

# get_stats(ConnHandle, Counter)

    -spec get_stats(ConnHandle, Counter) -> {ok, Value} | {error, Reason}
                       when
                           ConnHandle :: conn_handle(),
                           Counter :: counter(),
                           Value :: counter_value(),
                           Reason :: term().

Retreive a (SNMP) statistic counter maintained by the megaco application.

# info()

    -spec info() -> Info when Info :: [{Key, Value}], Key :: atom(), Value :: term().

This function produces a list of information about the megaco application. Such as users and their config, connections and their config, statistics and so on.

This information can be produced by the functions `user_info/2`, `conn_info/2`, `system_info/1` and `get_stats/2` but this is a simple way to get it all at once.

# parse_digit_map(DigitMapBody)

    -spec parse_digit_map(DigitMapBody) -> {ok, ParsedDigitMap} | {error, Reason}
                             when DigitMapBody :: string(), ParsedDigitMap :: term(), Reason :: term().

Parses a digit map body

Parses a digit map body, represented as a list of characters, into a list of state transitions suited to be evaluated by megaco:eval_digit_map/1,2.

# print_version_info()

    -spec print_version_info() -> void().

Equivalent to `print_version_info/1`.

# print_version_info(Versions)

    -spec print_version_info(Versions) -> void() when Versions :: [VersionInfo], VersionInfo :: term().

Utility function to produce a formated printout of the versions info generated by the `versions1` and `versions2` functions.

The function print_version_info/0 uses the result of function version1/0 as `VersionInfo`.

Example:

               {ok, V} = megaco:versions1(), megaco:format_versions(V).

# process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg)

    -spec process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) -> ok
                                      when
                                          ReceiveHandle :: receive_handle(),
                                          ControlPid :: pid(),
                                          SendHandle :: send_handle(),
                                          BinMsg :: binary().

Equivalent to `process_received_message/5`.

# process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra)

    -spec process_received_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) -> ok
                                      when
                                          ReceiveHandle :: receive_handle(),
                                          ControlPid :: pid(),
                                          SendHandle :: send_handle(),
                                          BinMsg :: binary(),
                                          Extra :: term().

Process a received message

This function is intended to be invoked by some transport modules when get an incoming message. Which transport that actually is used is up to the user to choose.

The message is delivered as an Erlang binary and is decoded by the encoding module stated in the receive handle together with its encoding config (also in the receive handle). Depending of the outcome of the decoding various callback functions will be invoked. See megaco_user for more info about the callback arguments.

The argument `Extra` is just an opaque data structure passed to the user via the callback functions in the user callback module. Note however that if `Extra` has the value `extra_undefined` the argument will be ignored (same as if `process_received_message/4` had been called). See the documentation for the behaviour of the callback module, `megaco_user`, for more info.

Note that all processing is done in the context of the calling process. A transport module could call this function via one of the `spawn` functions (e.g. `spawn_opt`). See also `receive_message/4,5`.

If the message cannot be decoded the following callback function will be invoked:

- UserMod:handle_syntax_error/3

If the decoded message instead of transactions contains a message error, the following callback function will be invoked:

- UserMod:handle_message_error/3

If the decoded message happens to be received before the connection is established, a new "virtual" connection is established. This is typically the case for the Media Gateway Controller (MGC) upon the first Service Change. When this occurs the following callback function will be invoked:

- UserMod:handle_connect/2

For each transaction request in the decoded message the following callback function will be invoked:

- UserMod:handle_trans_request/3

For each transaction reply in the decoded message the reply is returned to the user. Either the originating function megaco:call/3 will return. Or in case the originating function was megaco:case/3 the following callback function will be invoked:

- UserMod:handle_trans_reply/4

When a transaction acknowledgement is received it is possible that user has decided not to bother about the acknowledgement. But in case the return value from UserMod:handle_trans_request/3 indicates that the acknowledgement is important the following callback function will be invoked:

- UserMod:handle_trans_ack/4

See the megaco_user module for more info about the callback arguments.

# receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg)

    -spec receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) -> ok
                             when
                                 ReceiveHandle :: receive_handle(),
                                 ControlPid :: pid(),
                                 SendHandle :: send_handle(),
                                 BinMsg :: binary().

Equivalent to `receive_message/5`.

# receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra)

    -spec receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) -> ok
                             when
                                 ReceiveHandle :: receive_handle(),
                                 ControlPid :: pid(),
                                 SendHandle :: send_handle(),
                                 BinMsg :: binary(),
                                 Extra :: term().

Process a received message

This is a callback function intended to be invoked by some transport modules when get an incoming message. Which transport that actually is used is up to the user to choose.

In principle, this function calls the process_received_message/4,5 function via a `spawn` to perform the actual processing.

# report_digit_event(DigitMapEvalPid, Events)

    -spec report_digit_event(DigitMapEvalPid, Events) -> ok | {error, Reason}
                                when
                                    DigitMapEvalPid :: pid(),
                                    Events :: digit_map_event() | [digit_map_event()],
                                    Reason :: term().

Send one or more events to the event collector process.

Send one or more events to a process that is evaluating a digit map, that is a process that is executing megaco:eval_digit_map/1,2.

Note that the events `$s | $S`, `l | $L` and `$z | $Z` has nothing to do with the timers using the same characters.

# reset_stats()

    -spec reset_stats() -> void().

Reset all (SNMP) statistics counters.

# reset_stats(ConnHandleOrGCounter)

    -spec reset_stats(GCounter) -> void() when GCounter :: global_counter();
                     (ConnHandle) -> void() when ConnHandle :: conn_handle().

Reset the specified (SNMP) statistics counter.

Reset all (SNMP) statistics counters for a connection.

# set_trace(Level)

    -spec set_trace(Level) -> void() when Level :: trace_level().

This function is used to change the megaco trace level.

It is assumed that tracing has already been enabled (see `enable_trace` above).

# start()

    -spec start() -> ok | {error, Reason} when Reason :: term().

Starts the Megaco application

Users may either explicitly be registered with megaco:start_user/2 and/or be statically configured by setting the application environment variable 'users' to a list of {UserMid, Config} tuples. See the function megaco:start_user/2 for details.

# start_user(UserMid, Config)

    -spec start_user(UserMid, Config) -> ok | {error, Reason}
                        when
                            UserMid :: mid(),
                            Config :: [{Item, Value}],
                            Item :: user_info_item(),
                            Value :: term(),
                            Reason :: term().

Initial configuration of a user

Requires the megaco application to be started. A user is either a Media Gateway (MG) or a Media Gateway Controller (MGC). One Erlang node may host many users.

A user is identified by its UserMid, which must be a legal Megaco MID.

Config is a list of {Item, Value} tuples. See megaco:user_info/2 about which items and values that are valid.

# stop()

    -spec stop() -> ok | {error, Reason} when Reason :: term().

Stops the Megaco application

# stop_user(UserMid)

    -spec stop_user(UserMid) -> ok | {error, Reason} when UserMid :: mid(), Reason :: term().

Delete the configuration of a user

Requires that the user does not have any active connection.

# system_info()

    -spec system_info() -> [{Item, Value}] when Item :: system_info_item(), Value :: term().

Equivalent to `system_info/1`.

# system_info(Item)

    -spec system_info(Item) -> Value when Item :: system_info_item(), Value :: term().

Lookup system information.

# test_digit_event(DigitMap, Events)

    -spec test_digit_event(DigitMap, Events) -> {ok, Kind, Letters} | {error, Reason}
                              when
                                  DigitMap :: digit_map_value() | ParsedDigitMap,
                                  ParsedDigitMap :: term(),
                                  Events :: digit_map_event() | [digit_map_event()],
                                  Kind :: digit_map_kind(),
                                  Letters :: [digit_map_letter()],
                                  Reason :: term().

Feed digit map collector with events and return the result

This function starts the evaluation of a digit map with megaco:eval_digit_map/1 and sends a sequence of events to it with megaco:report_digit_event/2 in order to simplify testing of digit maps.

# test_reply(ConnHandle, Version, EncodingMod, EncodingConfig, Reply)

    -spec test_reply(ConnHandle, Version, EncodingMod, EncodingConfig, Reply) -> {MegaMsg, EncodeRes}
                        when
                            ConnHandle :: conn_handle(),
                            Version :: protocol_version(),
                            EncodingMod :: module(),
                            EncodingConfig :: list(),
                            Reply :: error_desc() | [action_reply()],
                            MegaMsg :: megaco_message(),
                            EncodeRes :: {ok, Bin} | {error, Reason},
                            Bin :: binary(),
                            Reason :: term().

Tests if the Reply argument is correctly composed.

This function is only intended for testing purposes. It's supposed to test the `actual_reply()` return value of the callback functions handle_trans_request and handle_trans_long_request functions (with the additions of the `EncodingMod` and `EncodingConfig` arguments). It composes a complete megaco message end attempts to encode it. The return value, will be a tuple of the composed megaco message and the encode result.

# test_request(ConnHandle, Version, EncodingMod, EncodingConfig, ActionRequests)

    -spec test_request(ConnHandle, Version, EncodingMod, EncodingConfig, ActionRequests) ->
                          {MegaMsg, EncodeRes}
                          when
                              ConnHandle :: conn_handle(),
                              Version :: protocol_version(),
                              EncodingMod :: module(),
                              EncodingConfig :: list(),
                              ActionRequests :: action_reqs() | [action_reqs()],
                              MegaMsg :: megaco_message(),
                              EncodeRes :: {ok, Bin} | {error, Reason},
                              Bin :: binary(),
                              Reason :: term().

Tests if the Actions argument is correctly composed.

This function is only intended for testing purposes. It's supposed to have a same kind of interface as the `call/3` or `cast/3` functions (with the additions of the `EncodingMod` and `EncodingConfig` arguments). It composes a complete megaco message end attempts to encode it. The return value, will be a tuple of the composed megaco message and the encode result.

# token_tag2string(Tag)

    -spec token_tag2string(Tag) -> Result
                              when Tag :: atom(), Result :: string() | {error, Reason}, Reason :: term().

Equivalent to `token_tag2string/3`.

# token_tag2string(Tag, EncodingMod)

    -spec token_tag2string(Tag, EncodingMod) -> Result
                              when
                                  Tag :: atom(),
                                  EncodingMod :: pretty | compact | module(),
                                  Result :: string() | {error, Reason},
                                  Reason :: term().

Equivalent to `token_tag2string/3`.

# token_tag2string(Tag, EncodingMod, Version)

    -spec token_tag2string(Tag, EncodingMod, Version) -> Result
                              when
                                  Tag :: atom(),
                                  EncodingMod :: pretty | compact | module(),
                                  Version :: protocol_version() | v1 | v2 | v3,
                                  Result :: string() | {error, Reason},
                                  Reason :: term().

Convert a token tag to a string

If no encoder module is given, the default is used (which is pretty).

If no or an unknown version is given, the best version is used (which is v3).

If no match is found for `Tag`, `Result` will be the empty string (`[]`).

# update_conn_info(ConnHandle, Item, Value)

    -spec update_conn_info(ConnHandle, Item, Value) -> ok | {error, Reason}
                              when
                                  ConnHandle :: conn_handle(),
                                  Item :: conn_info_item(),
                                  Value :: term(),
                                  Reason :: term().

Update information about an active connection

Requires that the connection is activated. See `conn_info_item/0` about which items and values that are valid.

# update_user_info(UserMid, Item, Value)

    -spec update_user_info(UserMid, Item, Value) -> ok | {error, Reason}
                              when
                                  UserMid :: mid(),
                                  Item :: user_info_item(),
                                  Value :: term(),
                                  Reason :: term().

Update information about a user

Requires that the user is started.

# user_info(UserMid)

    -spec user_info(UserMid) -> [{Item, Value}]
                       when UserMid :: mid(), Item :: requests | replies | user_info_item(), Value :: term().

Equivalent to `user_info/2`.

# user_info(UserMid, Input)

    -spec user_info(UserMid, Input) -> Result
                       when
                           Input :: Requests | Replies | Item,
                           Requests :: requests,
                           Replies :: replies,
                           Item :: user_info_item(),
                           UserMid :: mid(),
                           Conn :: conn_handle(),
                           Result :: RequestsResult | RepliesResult | ItemResult,
                           RequestsResult :: [{Conn, [TransId]}],
                           ItemResult :: term(),
                           RepliesResult :: [{Conn, [{TransId, ReplyState, Handler}]}],
                           TransId :: transaction_id(),
                           ReplyState :: prepare | eval_request | waiting_for_ack | aborted,
                           Handler :: undefined | pid().

Lookup user information

Lookup user information about currently active requests. Expected input type `Input :: Requests` with expected output type `Result :: RequestsResult`.

Lookup user information about currently active replies. Expected input type `Input :: Replies` with expected output type `Result :: RepliesResult`.

# versions1()

    -spec versions1() -> {ok, VersionInfo} | {error, Reason} when VersionInfo :: list(), Reason :: term().

Equivalent to `versions2/0`.

# versions2()

    -spec versions2() -> {ok, VersionInfo} | {error, Reason} when VersionInfo :: list(), Reason :: term().

Utility functions used to retrieve some system and application info.

The difference between the two functions is in how they get the modules to check. `versions1` uses the app-file and `versions2` uses the function `application:get_key`.