File 2038-megaco-Types-and-spec-for-megaco-start_use... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2038-megaco-Types-and-spec-for-megaco-start_user-2.patch of Package erlang

From fa48f5e25b6839214f3ad8ca6d2198822702e019 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Thu, 4 Jan 2024 16:28:38 +0100
Subject: [PATCH 28/46] [megaco] Types and spec for megaco:start_user/2

OTP-18920
---
 lib/megaco/doc/src/megaco.xml | 656 +++++++++++++++++++++++++++++++++-
 lib/megaco/src/app/megaco.erl |  42 +++
 2 files changed, 691 insertions(+), 7 deletions(-)

diff --git a/lib/megaco/doc/src/megaco.xml b/lib/megaco/doc/src/megaco.xml
index 016b512555..3ae1bd6b8d 100644
--- a/lib/megaco/doc/src/megaco.xml
+++ b/lib/megaco/doc/src/megaco.xml
@@ -417,6 +417,653 @@
 -->
 </datatype>
 
+ <datatype>
+ <name name="user_info_item"/>
+ 
+ <desc>
+ <taglist>
+ <tag><c><![CDATA[connections]]></c></tag>
+ <item>
+ Lists all active connections for this user. Returns a
+	 list of megaco_conn_handle records.
+
+	 Value type:
+	 [<seetype marker="#conn_handle">conn_handle()</seetype>]
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[receive_handle]]></c></tag>
+ <item>
+ Construct a receive_handle from user config.
+
+	 Value type: 
+	 <seetype marker="#receive_handle">receive_handle()</seetype>
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[trans_id]]></c></tag>
+ <item>
+ Current transaction id. 
+
+	 Value type: 
+	 <seetype marker="#transaction_id">transaction_id()</seetype> |
+	 <c><![CDATA[undefined_serial]]></c>
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[min_trans_id]]></c></tag>
+ <item>
+ First transaction id. 
+
+	 Value type: 
+	 <seetype marker="#transaction_id">transaction_id()</seetype>
+	 Defaults to 1.
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[max_trans_id]]></c></tag>
+ <item>
+ Last transaction id. 
+
+	 Value type: 
+	 <seetype marker="#transaction_id">transaction_id()</seetype> |
+	 <c><![CDATA[infinity]]></c> 
+	 Defaults to <c><![CDATA[infinity]]></c>.
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[request_timer]]></c></tag>
+ <item>
+ Wait for reply. 
+ The timer is cancelled when a reply is received. 
+ When a pending message is received, the timer is 
+	 cancelled and the <c><![CDATA[long_request_timer]]></c>
+	 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 
+	 <c><![CDATA[megaco:call]]></c> will return with
+	 <c><![CDATA[{error, timeout}]]></c>
+	 or the callback function <c><![CDATA[handle_trans_reply]]></c>
+	 will be called with
+	 <c><![CDATA[UserReply = {error, timeout}]]></c> (if 
+	 <c><![CDATA[megaco:cast]]></c> was used).
+
+	 Value type: 
+	 <seetype marker="#megaco_timer">megaco_timer()</seetype>
+	 Defaults to <c><![CDATA[#megaco_incr_timer{}]]></c>.
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[long_request_timer]]></c></tag>
+ <item>
+ 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 
+	 <c><![CDATA[long_request_timer]]></c> 
+	 is not "on its final leg", the timer will be 
+	 restarted, and, if <c><![CDATA[long_request_resend = true]]></c>,
+	 the request will be re-sent. 
+
+	 Value type: 
+	 <seetype marker="#megaco_timer">megaco_timer()</seetype>
+ Defaults to <c><![CDATA[60 seconds]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[long_request_resend]]></c></tag>
+ <item>
+ 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 <c><![CDATA[long_request_timer]]></c>
+	 (see above) is also set
+	 to an incremental timer
+	 (<c><![CDATA[#megaco_incr_timer{}]]></c>). 
+
+	 Value type: 
+	 <seetype marker="erlang#boolean">boolean()</seetype>
+ Defaults to <c><![CDATA[false]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[reply_timer]]></c></tag>
+ <item>
+ 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 <c><![CDATA[#megaco_incr_timer{}]]></c>, 
+	 then for each intermediate timout, the reply will be resent
+	 (this is valid until the ack is received or 
+	 the timer expires). 
+
+	 Value type: 
+	 <seetype marker="#megaco_timer">megaco_timer()</seetype>
+ Defaults to <c><![CDATA[30 seconds]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[request_keep_alive_timeout]]></c></tag>
+ <item>
+ 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 
+	 <seeerl marker="megaco#cast">megaco:cast/3</seeerl> function)
+	 arrives. As long as this timer is running, replies will 
+	 be delivered via the 
+	 <seeerl marker="megaco_user#trans_reply">handle_trans_reply/4,5</seeerl> 
+	 callback function, with their "arrival number" 
+	 (see <c><![CDATA[UserReply]]></c> of the 
+	 <seeerl marker="megaco_user#trans_reply">handle_trans_reply/4,5</seeerl> 
+	 callback function). 
+	 Replies arriving after the timer has expired, will be 
+	 delivered using the 
+	 <seeerl marker="megaco_user#unexpected_trans">handle_unexpected_trans/3,4</seeerl> 
+	 callback function. 
+
+	 Value type: 
+	 <c><![CDATA[plain]]></c> |
+	 <seetype marker="erlang#non_neg_integer">non_neg_integer()</seetype>
+ Defaults to <c><![CDATA[plain]]></c>.
+
+ 
+ </item>
+
+
+	 <tag><c><![CDATA[call_proxy_gc_timeout]]></c></tag>
+ <item>
+ Timeout time for the call proxy. 
+ When a request is sent using the 
+	 <seeerl marker="megaco#call">call/3</seeerl> 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 
+	 <seeerl marker="megaco_user#handle_unexpected_trans">handle_unexpected_trans</seeerl> 
+	 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: 
+	 <seetype marker="erlang#pos_integer">pos_integer()</seetype>
+ Defaults to <c><![CDATA[500]]></c> (= 5 seconds).
+
+ 
+ </item>
+
+
+	 <tag><c><![CDATA[auto_ack]]></c></tag>
+ <item>
+ Automatic send transaction ack when the transaction
+	 reply has been received
+	 (see <c><![CDATA[trans_ack]]></c> below). 
+ This is used for three-way-handshake.
+
+	 Value type: 
+	 <seetype marker="erlang#boolean">boolean()</seetype>
+ Defaults to <c><![CDATA[false]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[trans_ack]]></c></tag>
+ <item>
+ Shall ack's be accumulated or not. 
+	 This property is only valid if <c><![CDATA[auto_ack]]></c>
+	 is true.
+	 If <c><![CDATA[auto_ack]]></c> is true, then if
+	 <c><![CDATA[trans_ack]]></c> is
+	 <c><![CDATA[false]]></c>, ack's will be sent immediately. 
+	 If <c><![CDATA[trans_ack]]></c> is <c><![CDATA[true]]></c>, then 
+	 ack's will instead be sent to the transaction 
+	 sender process for accumulation and later sending 
+	 (see <c><![CDATA[trans_ack_maxcount]]></c>,
+	 <c><![CDATA[trans_req_maxcount]]></c>, 
+	 <c><![CDATA[trans_req_maxsize]]></c>,
+	 <c><![CDATA[trans_ack_maxcount]]></c> and 
+	 <c><![CDATA[trans_timer]]></c>). 
+	 See also
+	 <seeguide marker="megaco_run#transaction_sender">transaction sender</seeguide>
+	 for more info.
+
+	 Value type: 
+	 <seetype marker="erlang#boolean">boolean()</seetype>
+ Defaults to <c><![CDATA[false]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[trans_ack_maxcount]]></c></tag>
+ <item>
+ 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
+	 <seeguide marker="megaco_run#transaction_sender">transaction sender</seeguide>
+	 for more info. 
+
+	 Value type: 
+	 <seetype marker="erlang#integer">integer()</seetype>
+ Defaults to <c><![CDATA[10]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[trans_req]]></c></tag>
+ <item>
+ Shall requests be accumulated or not. 
+	 If <c><![CDATA[trans_req]]></c> is <c><![CDATA[false]]></c>,
+	 then request(s) will be sent immediately (in its own message).
+ If <c><![CDATA[trans_req]]></c> is true, then request(s) will 
+	 instead be sent to the transaction sender process for 
+	 accumulation and later sending 
+	 (see <c><![CDATA[trans_ack_maxcount]]></c>, <c><![CDATA[trans_req_maxcount]]></c>, 
+	 <c><![CDATA[trans_req_maxsize]]></c>, <c><![CDATA[trans_ack_maxcount]]></c> and 
+	 <c><![CDATA[trans_timer]]></c>). 
+
+	 See also
+	 <seeguide marker="megaco_run#transaction_sender">transaction sender</seeguide>
+	 for more info. 
+
+	 Value type: 
+	 <seetype marker="erlang#boolean">boolean()</seetype>
+ Defaults to <c><![CDATA[false]]></c>.
+
+ 
+ </item>
+
+
+	 <tag><c><![CDATA[trans_req_maxcount]]></c></tag>
+ <item>
+ 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
+	 <seeguide marker="megaco_run#transaction_sender">transaction sender</seeguide>
+	 for more info.
+
+	 Value type: 
+	 <seetype marker="erlang#integer">integer()</seetype>
+ Defaults to <c><![CDATA[10]]></c>.
+
+	 
+ </item>
+
+
+ <tag><c><![CDATA[trans_req_maxsize]]></c></tag>
+ <item>
+ 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
+	 <seeguide marker="megaco_run#transaction_sender">transaction sender</seeguide>
+	 for more info.
+
+	 Value type: 
+	 <seetype marker="erlang#integer">integer()</seetype>
+ Defaults to <c><![CDATA[2048]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[trans_timer]]></c></tag>
+ <item>
+ 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
+	 <c><![CDATA[auto_ack]]></c> and <c><![CDATA[trans_ack]]></c>
+	 are both true or if <c><![CDATA[trans_req]]></c> is true, 
+	 then transaction sender will be started and transactions 
+	 (which is depending on the values of <c><![CDATA[auto_ack]]></c>, 
+	 <c><![CDATA[trans_ack]]></c> and <c><![CDATA[trans_req]]></c>)
+	 will be accumulated, for later sending. 
+	 See also
+	 <seeguide marker="megaco_run#transaction_sender">transaction sender</seeguide>
+	 for more info. 
+
+	 Value type: 
+	 <seetype marker="erlang#integer">integer()</seetype>
+ Defaults to <c><![CDATA[0]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[pending_timer]]></c></tag>
+ <item>
+ Automatically send pending if the timer expires before a
+	 transaction reply has been sent. This timer is also called 
+	 provisional response timer. 
+
+	 Value type: 
+	 <seetype marker="#megaco_timer">megaco_timer()</seetype>
+ Defaults to <c><![CDATA[30000]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[sent_pending_limit]]></c></tag>
+ <item>
+ 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
+	 <seeerl marker="megaco_user#request_abort">handle_trans_request_abort</seeerl>)
+	 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: 
+	 <c><![CDATA[infinity]]></c> |
+	 <seetype marker="erlang#pos_integer">pos_integer()</seetype>
+ Defaults to <c><![CDATA[infinity]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[recv_pending_limit]]></c></tag>
+ <item>
+ 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: 
+	 <c><![CDATA[infinity]]></c> |
+	 <seetype marker="erlang#pos_integer">pos_integer()</seetype>
+ Defaults to <c><![CDATA[infinity]]></c>.
+
+ 
+ </item>
+
+
+	 <tag><c><![CDATA[send_mod]]></c></tag>
+ <item>
+ 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: 
+	 <seetype marker="erlang#module">module()</seetype>
+ Defaults to <c><![CDATA[megaco_tcp]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[encoding_mod]]></c></tag>
+ <item>
+ 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: 
+	 <seetype marker="erlang#module">module()</seetype>
+ Defaults to <c><![CDATA[megaco_pretty_text_encoder]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[encoding_config]]></c></tag>
+ <item>
+ Encoding module config. 
+
+	 Value type: 
+	 <seetype marker="erlang#list">list()</seetype>
+ Defaults to <c><![CDATA[[]]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[protocol_version]]></c></tag>
+ <item>
+ Actual protocol version. 
+
+	 Value type: 
+	 <seetype marker="#protocol_version">protocol_version()</seetype>
+ Defaults to <c><![CDATA[1]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[strict_version]]></c></tag>
+ <item>
+ Strict version control, i.e. when a message is received,
+	 verify that the version is that which was negotiated. 
+
+	 Value type: 
+	 <seetype marker="erlang#boolean">boolean()</seetype>
+ Defaults to <c><![CDATA[true]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[reply_data]]></c></tag>
+ <item>
+ Default reply data. 
+
+	 Value type: 
+	 <seetype marker="erlang#term">term()</seetype>
+ Defaults to <c><![CDATA[undefined]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[user_mod]]></c></tag>
+ <item>
+ Name of the user callback module. See the the reference
+	 manual for megaco_user for more info.
+
+	 Value type: 
+	 <seetype marker="erlang#module">module()</seetype>
+	 Has no default value since its an mandatory config option. 
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[user_args]]></c></tag>
+ <item>
+ List of extra arguments to the user callback
+	 functions. See the the reference manual for megaco_user
+	 for more info.
+
+	 Value type: 
+	 <seetype marker="erlang#list">list()</seetype>
+	 
+ 
+ </item>
+
+
+	 <tag><c><![CDATA[threaded]]></c></tag>
+ <item>
+ If a received message contains several transaction requests, 
+	 this option indicates whether the requests should be handled
+	 sequentially in the same process (<c><![CDATA[false]]></c>),
+	 or if each request should be handled by its own process
+	 (<c><![CDATA[true]]></c> i.e. a separate process is spawned
+	 for each request). 
+
+	 Value type: 
+	 <seetype marker="erlang#boolean">boolean()</seetype>
+ Defaults to <c><![CDATA[false]]></c>.
+
+ <marker id="ui_resend_indication"></marker>
+ </item>
+
+
+	 <tag><c><![CDATA[resend_indication]]></c></tag>
+ <item>
+ 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
+	 <seeerl marker="megaco_transport#send_message">send_message</seeerl> 
+	 function. 
+	 If true,
+	 megaco message re-sends are made using the
+	 <seeerl marker="megaco_transport#resend_message">resend_message</seeerl> 
+	 function. The initial message send is still done using the
+	 <seeerl marker="megaco_transport#send_message">send_message</seeerl> 
+	 function. 
+	 The special value flag instead indicates that the 
+	 function 
+	 <seeerl marker="megaco_transport#send_message">send_message/3</seeerl> 
+	 shall be used. 
+
+	 Value type: 
+	 <seetype marker="erlang#boolean">boolean()</seetype>
+ Defaults to <c><![CDATA[false]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[segment_reply_ind]]></c></tag>
+ <item>
+ This option specifies if the user shall be notified of received
+	 segment replies or not. 
+ See 
+	 <seeerl marker="megaco_user#segment_reply">handle_segment_reply</seeerl> 
+	 callback function for more information. 
+
+	 Value type: 
+	 <seetype marker="erlang#boolean">boolean()</seetype>
+ Defaults to <c><![CDATA[false]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[segment_recv_timer]]></c></tag>
+ <item>
+ This timer is started when the segment indicated by the
+	 <c><![CDATA[segmentation complete token]]></c> 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 <c><![CDATA[segment timeout]]></c>
+	 <c><![CDATA[UserReply]]></c> in either the
+	 <seeerl marker="megaco_user#trans_reply">handle_trans_reply</seeerl>
+	 callback function or the return value of the 
+	 <seeerl marker="megaco#call">call</seeerl> function. 
+
+	 Value type: 
+	 <seetype marker="#megaco_timer">megaco_timer()</seetype>
+ Defaults to <c><![CDATA[10000]]></c>.
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[segment_send]]></c></tag>
+ <item>
+ Shall outgoing messages be segmented or not
+	 Value type: 
+	 <c><![CDATA[none]]></c> |
+	 <seetype marker="erlang#pos_integer">pos_integer()</seetype> |
+	 <c><![CDATA[infinity]]></c>
+ <taglist>
+ <tag><c><![CDATA[none]]></c></tag>
+ <item>
+ 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).
+ </item>
+ <tag><c><![CDATA[pos_integer()]]></c></tag>
+ <item>
+ Outgoing reply messages will be segmented as needed 
+		(see <c><![CDATA[max_pdu_size]]></c> below).
+		This value, K, indicate 
+		the outstanding window, i.e. how many segments can be 
+		outstanding (not acknowledged) at any given time. 
+ </item>
+ <tag><c><![CDATA[infinity]]></c></tag>
+ <item>
+ Outgoing reply messages will be segmented as needed 
+		(see <c><![CDATA[max_pdu_size]]></c> below). Segment messages 
+		are sent all at once (i.e. no acknowledgement awaited 
+		before sending the next segment). 
+ </item>
+ </taglist>
+ Defaults to <c><![CDATA[none]]></c>. 
+
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[max_pdu_size]]></c></tag>
+ <item>
+ Max message size. If the encoded message (PDU) exceeds 
+	 this size, the message should be segmented, and then 
+	 encoded. 
+
+	 Value type: 
+	 <c><![CDATA[infinity]]></c> |
+	 <seetype marker="erlang#pos_integer">pos_integer()</seetype>
+ Defaults to <c><![CDATA[infinity]]></c>.
+
+ </item>
+
+	</taglist>
+ </desc>
+ </datatype>
+
 </datatypes>
 
 <section>
@@ -544,13 +1191,8 @@ megaco_incr_timer() = #megaco_incr_timer{}
 </func>
 
 <func>
- <name since="">start_user(UserMid, Config) -> ok | {error, Reason}</name>
+ <name name="start_user" arity="2" clause_i="1" since=""/>
 <fsummary>Initial configuration of a user</fsummary>
- <type>
- <v>UserMid = megaco_mid()</v>
- <v>Config = [{user_info_item(), user_info_value()}]</v>
- <v>Reason = term()</v>
- </type>
 <desc>
 Initial configuration of a user
 Requires the megaco application to be started. A user is
@@ -599,7 +1241,7 @@ megaco_incr_timer() = #megaco_incr_timer{}
 <tag><c><![CDATA[connections]]></c></tag>
 <item>
 Lists all active connections for this user. Returns a
- list of megaco_conn_handle records.
+	 list of megaco_conn_handle records.
 <marker id="ui_receive_handle"></marker>
 </item>
 
diff --git a/lib/megaco/src/app/megaco.erl b/lib/megaco/src/app/megaco.erl
index e9bf93671c..f4a40fcbfe 100644
--- a/lib/megaco/src/app/megaco.erl
+++ b/lib/megaco/src/app/megaco.erl
@@ -178,6 +178,41 @@
 segment_recv_timer |
 segment_send |
 max_pdu_size.
+-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.
 
 -type send_handle() :: term().
 
@@ -232,6 +267,13 @@ stop() ->
 %% Initial configuration of a user
 %%-----------------------------------------------------------------
 
+-spec start_user(UserMid, Config) -> ok | {error, Reason} when
+ UserMid :: mid(),
+ Config :: [{Item, Value}],
+ Item :: user_info_item(),
+ Value :: term(),
+ Reason :: term().
+
 start_user(UserMid, Config) ->
 megaco_config:start_user(UserMid, Config).
 
-- 
2.35.3

Places

File 2038-megaco-Types-and-spec-for-megaco-start_user-2.patch of Package erlang

Places