← Back to branch summary

~ubuntu-branches/ubuntu/trusty/erlang/trusty

« back to all changes in this revision

Viewing changes to lib/megaco/doc/src/megaco_user.xml

  • Committer: Bazaar Package Importer
  • Author(s): Clint Byrum
  • Date: 2011-05-05 15:48:43 UTC
  • mfrom: (3.5.13 sid)
  • Revision ID: james.westby@ubuntu.com-20110505154843-0om6ekzg6m7ugj27
Tags: 1:14.b.2-dfsg-3ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Drop libwxgtk2.8-dev build dependency. Wx isn't in main, and not
    supposed to.
  - Drop erlang-wx binary.
  - Drop erlang-wx dependency from -megaco, -common-test, and -reltool, they
    do not really need wx. Also drop it from -debugger; the GUI needs wx,
    but it apparently has CLI bits as well, and is also needed by -megaco,
    so let's keep the package for now.
  - debian/patches/series: Do what I meant, and enable build-options.patch
    instead.
* Additional changes:
  - Drop erlang-wx from -et
* Dropped Changes:
  - patches/pcre-crash.patch: CVE-2008-2371: outer level option with
    alternatives caused crash. (Applied Upstream)
  - fix for ssl certificate verification in newSSL: 
    ssl_cacertfile_fix.patch (Applied Upstream)
  - debian/patches/series: Enable native.patch again, to get stripped beam
    files and reduce the package size again. (build-options is what
    actually accomplished this)
  - Remove build-options.patch on advice from upstream and because it caused
    odd build failures.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/megaco/doc/src/megaco_user.xml
4
4
<erlref>
5
5
  <header>
6
6
    <copyright>
7
 
      <year>2000</year><year>2009</year>
 
7
      <year>2000</year><year>2010</year>
8
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
9
9
    </copyright>
10
10
    <legalnotice>
13
13
      compliance with the License. You should have received a copy of the
14
14
      Erlang Public License along with this software. If not, it can be
15
15
      retrieved online at http://www.erlang.org/.
16
 
    
 
16
 
17
17
      Software distributed under the License is distributed on an "AS IS"
18
18
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
19
19
      the License for the specific language governing rights and limitations
20
20
      under the License.
21
 
    
 
21
 
22
22
    </legalnotice>
23
23
 
24
24
    <title>megaco_user</title>
471
471
        <v>transaction_result() = action_reps()</v>
472
472
        <v>segment_result() = {segment_no(), last_segment(), action_reps()}</v>
473
473
        <v>action_reps()   = [action_reply()]</v>
474
 
        <v>failure()       = {error, reason()}</v>
 
474
        <v>failure()       = {error, reason()} | {error, ReplyNo, reason()}</v>
475
475
        <v>reason()  = transaction_reason() | segment_reason() | user_cancel_reason() | send_reason() | other_reason()</v>
476
476
        <v>transaction_reason() = error_desc()</v>
477
477
        <v>segment_reason() = {segment_no(), last_segment(), error_desc()}</v>
486
486
        <v>send_failed_reason() = {send_message_failed, reason_for_send_failure()}</v>
487
487
        <v>reason_for_send_failure() = term()</v>
488
488
        <v>ReplyData       = reply_data()</v>
 
489
        <v>ReplyNo         = integer() > 0</v>
489
490
        <v>reply_data()    = term()</v>
490
491
        <v>Extra           = term()</v>
491
492
      </type>
503
504
          not, is also included in the <c><![CDATA[UserReply]]></c>. </p>
504
505
        <p>The <c><![CDATA[ReplyData]]></c> defaults to 
505
506
          <c><![CDATA[megaco:lookup(ConnHandle, reply_data)]]></c>, 
506
 
          but may be explicitely overridden by a
 
507
          but may be explicitly overridden by a
507
508
          <c><![CDATA[megaco:cast/3]]></c> option in order to forward info about the
508
509
          calling context of the originating process.</p>
509
510
        <p>At <c><![CDATA[success()]]></c>, the <c><![CDATA[UserReply]]></c> either contains:</p>
669
670
        <p>Invoked when a unexpected message is received</p>
670
671
        <p>If a reply to a request is not received in time, the
671
672
          megaco stack removes all info about the request from
672
 
          it's tables. If a reply should arrive after this has been
 
673
          its tables. If a reply should arrive after this has been
673
674
          done the app has no way of knowing where to send this message.
674
675
          The message is delivered to the "user" by calling this
675
676
          function on the local node (the node which has the link).</p>