draft-ietf-megaco-protocol-05.txt   draft-ietf-megaco-protocol-06.txt 
Internet Engineering Task Force Fernando Cuervo Internet Engineering Task Force Fernando Cuervo
INTERNET DRAFT Nortel Networks INTERNET DRAFT Nortel Networks
January 27, 2000 Bryan Hill February 8, 2000 Bryan Hill
Expires July 27, 2000 Gotham Networks Expires August 8, 2000 Gotham Networks
<draft-ietf-megaco-protocol-05.txt> Nancy Greene <draft-ietf-megaco-protocol-06.txt> Nancy Greene
Nortel Networks Nortel Networks
Christian Huitema Christian Huitema
Telcordia Technologies Telcordia Technologies
Abdallah Rayhan Abdallah Rayhan
Nortel Networks Nortel Networks
Brian Rosen Brian Rosen
Marconi Marconi
John Segers John Segers
Lucent Technologies Lucent Technologies
skipping to change at page 1, line 40 skipping to change at page 1, line 40
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet- Drafts as reference material time. It is inappropriate to use Internet- Drafts as reference material
or to cite them other than as "work in progress." or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt http://www.ietf.org/ietf/1id-abstracts.txt
The list of Internet-Draft Shadow Directories can be accessed at The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html. http://www.ietf.org/shadow.html.
This document will expire in July 2000. This document will expire in August 2000.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
1. SCOPE ..................................................... 7 1. SCOPE ..................................................... 7
2. REFERENCES ................................................ 7 2. REFERENCES ................................................ 7
2.1. Normative references ................................. 7 2.1. Normative references ................................. 7
2.2. Informative references ............................... 8 2.2. Informative references ............................... 8
3. DEFINITIONS ............................................... 9 3. DEFINITIONS ............................................... 9
4. ABBREVIATIONS ............................................. 10 4. ABBREVIATIONS ............................................. 10
5. CONVENTIONS ............................................... 10 5. CONVENTIONS ............................................... 10
6. CONNECTION MODEL .......................................... 10 6. CONNECTION MODEL .......................................... 10
6.1. Contexts ............................................. 14 6.1. Contexts ............................................. 14
skipping to change at page 2, line 40 skipping to change at page 2, line 40
7.1.5. Termination State Descriptor .................... 23 7.1.5. Termination State Descriptor .................... 23
7.1.6. Stream Descriptor ............................... 24 7.1.6. Stream Descriptor ............................... 24
7.1.7. LocalControl Descriptor ......................... 24 7.1.7. LocalControl Descriptor ......................... 24
7.1.8. Local and Remote Descriptors .................... 25 7.1.8. Local and Remote Descriptors .................... 25
7.1.9. Events Descriptor ............................... 28 7.1.9. Events Descriptor ............................... 28
7.1.10. EventBuffer Descriptor ......................... 29 7.1.10. EventBuffer Descriptor ......................... 29
7.1.11. Signals Descriptor ............................. 29 7.1.11. Signals Descriptor ............................. 29
7.1.12. Audit Descriptor ............................... 31 7.1.12. Audit Descriptor ............................... 31
7.1.13. ServiceChange Descriptor ....................... 32 7.1.13. ServiceChange Descriptor ....................... 32
7.1.14. DigitMap Descriptor ............................ 32 7.1.14. DigitMap Descriptor ............................ 32
7.1.15. Statistics Descriptor .......................... 34 7.1.15. Statistics Descriptor .......................... 35
7.1.16. Packages Descriptor ............................ 35 7.1.16. Packages Descriptor ............................ 36
7.1.17. ObservedEvents Descriptor ...................... 35 7.1.17. ObservedEvents Descriptor ...................... 36
7.1.18. Topology Descriptor ............................ 35 7.1.18. Topology Descriptor ............................ 36
7.2. Command Application Programming Interface ............ 38 7.2. Command Application Programming Interface ............ 39
7.2.1. Add ............................................. 38 7.2.1. Add ............................................. 39
7.2.2. Modify .......................................... 40 7.2.2. Modify .......................................... 41
7.2.3. Subtract ........................................ 41 7.2.3. Subtract ........................................ 42
7.2.4. Move ............................................ 42 7.2.4. Move ............................................ 43
7.2.5. AuditValue ...................................... 43 7.2.5. AuditValue ...................................... 44
7.2.6. AuditCapabilities ............................... 44 7.2.6. AuditCapabilities ............................... 45
7.2.7. Notify .......................................... 45 7.2.7. Notify .......................................... 46
7.2.8. ServiceChange ................................... 45 7.2.8. ServiceChange ................................... 46
7.2.9. Manipulating and Auditing Context Attributes .... 49 7.2.9. Manipulating and Auditing Context Attributes .... 50
7.2.10. Generic Command Syntax ......................... 50 7.2.10. Generic Command Syntax ......................... 51
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
7.3. Command Error Codes .................................. 50 7.3. Command Error Codes .................................. 51
8. TRANSACTIONS .............................................. 52 8. TRANSACTIONS .............................................. 53
8.1. Common Parameters .................................... 53 8.1. Common Parameters .................................... 54
8.1.1. Transaction Identifiers ......................... 53 8.1.1. Transaction Identifiers ......................... 54
8.1.2. Context Identifiers ............................. 53 8.1.2. Context Identifiers ............................. 55
8.2. Transaction Application Programming Interface ........ 54 8.2. Transaction Application Programming Interface ........ 55
8.2.1. TransactionRequest .............................. 54 8.2.1. TransactionRequest .............................. 55
8.2.2. TransactionReply ................................ 54 8.2.2. TransactionReply ................................ 56
8.2.3. TransactionPending .............................. 56 8.2.3. TransactionPending .............................. 57
8.3. Messages ............................................. 56 8.3. Messages ............................................. 57
9. TRANSPORT ................................................. 56 9. TRANSPORT ................................................. 58
9.1. Ordering of Commands ................................. 57 9.1. Ordering of Commands ................................. 58
9.2. Protection against Restart Avalanche ................. 58 9.2. Protection against Restart Avalanche ................. 59
10. SECURITY CONSIDERATIONS .................................. 59 10. SECURITY CONSIDERATIONS .................................. 60
10.1. Protection of Protocol Connections .................. 59 10.1. Protection of Protocol Connections .................. 60
10.2. Interim AH scheme ................................... 60 10.2. Interim AH scheme ................................... 61
10.3. Protection of Media Connections ..................... 61 10.3. Protection of Media Connections ..................... 62
11. MG-MGC CONTROL INTERFACE ................................. 61 11. MG-MGC CONTROL INTERFACE ................................. 63
11.1. Multiple Virtual MGs ................................ 62 11.1. Multiple Virtual MGs ................................ 63
11.2. Cold Start .......................................... 62 11.2. Cold Start .......................................... 64
11.3. Negotiation of Protocol Version ..................... 63 11.3. Negotiation of Protocol Version ..................... 64
11.4. Failure of an MG .................................... 63 11.4. Failure of an MG .................................... 65
11.5. Failure of an MGC ................................... 64 11.5. Failure of an MGC ................................... 65
12. PACKAGE DEFINITION ....................................... 65 12. PACKAGE DEFINITION ....................................... 66
12.1. Guidelines for defining packages .................... 65 12.1. Guidelines for defining packages .................... 66
12.1.1. Package ........................................ 65 12.1.1. Package Overall description of the package, .... 67
12.1.2. Properties ..................................... 66 12.1.2. Properties ..................................... 67
12.1.3. Events ......................................... 66 12.1.3. Events ......................................... 68
12.1.4. Signals ........................................ 67 12.1.4. Signals ........................................ 68
12.1.5. Statistics ..................................... 67 12.1.5. Statistics ..................................... 69
12.1.6. Procedures ..................................... 67 12.1.6. Procedures ..................................... 69
12.2. Guidelines to defining Properties, Statistics ....... 68 12.2. Guidelines to defining Properties, Statistics and ... 69
12.3. Lists ............................................... 68 12.3. Lists ............................................... 69
12.4. Identifiers ......................................... 68 12.4. Identifiers ......................................... 69
12.5. Package Registration ................................ 68 12.5. Package Registration ................................ 70
13. IANA CONSIDERATIONS ...................................... 68 13. IANA CONSIDERATIONS ...................................... 70
13.1. Packages ............................................ 68 13.1. Packages ............................................ 70
13.2. Error Codes ......................................... 69 13.2. Error Codes ......................................... 70
13.3. ServiceChange Reasons ............................... 70 13.3. ServiceChange Reasons ............................... 71
14. CONTACT INFORMATION ...................................... 70 14. CONTACT INFORMATION ...................................... 71
ANNEX A BINARY ENCODING OF THE PROTOCOL (NORMATIVE) ........... 71 ANNEX A BINARY ENCODING OF THE PROTOCOL (NORMATIVE) ........... 73
A.1. Coding of wildcards .................................. 71 A.1. Coding of wildcards .................................. 73
A.2. ASN.1 syntax specification ........................... 73 A.2. ASN.1 syntax specification ........................... 74
A.3. Digit maps and path names ............................ 88 A.3. Digit maps and path names ............................ 89
ANNEX B TEXT ENCODING OF THE PROTOCOL (NORMATIVE) ............. 89 ANNEX B TEXT ENCODING OF THE PROTOCOL (NORMATIVE) ............. 90
B.1. Coding of wildcards .................................. 89 B.1. Coding of wildcards .................................. 90
B.2. ABNF specification ................................... 89 B.2. ABNF specification ................................... 90
ANNEX C TAGS FOR MEDIA STREAM PROPERTIES (NORMATIVE) ..........100 ANNEX C TAGS FOR MEDIA STREAM PROPERTIES (NORMATIVE) ..........101
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
C.1. General Media Attributes .............................101 C.1. General Media Attributes .............................102
C.2. Mux Properties .......................................101 C.2. Mux Properties .......................................102
C.3. General bearer properties ............................101 C.3. General bearer properties ............................102
C.4. General ATM properties ...............................101 C.4. General ATM properties ...............................103
C.5. Frame Relay ..........................................102 C.5. Frame Relay ..........................................104
C.6. IP ...................................................103 C.6. IP ...................................................104
C.7. ATM AAL2 .............................................103 C.7. ATM AAL2 .............................................104
C.8. ATM AAL1 .............................................103 C.8. ATM AAL1 .............................................104
C.9. Bearer Capabilities ..................................104 C.9. Bearer Capabilities ..................................105
C.10. AAL5 Properties .....................................104 C.10. AAL5 Properties .....................................106
C.11. SDP Equivalents .....................................105 C.11. SDP Equivalents .....................................107
C.12. H.245 ...............................................105 C.12. H.245 ...............................................107
ANNEX D TRANSPORT OVER IP (NORMATIVE) .........................105 ANNEX D TRANSPORT OVER IP (NORMATIVE) .........................107
D.1. Transport over IP/UDP using Application Level ........105 D.1. Transport over IP/UDP using Application Level ........107
D.1.1. Providing At-Most-Once Functionality ............105 D.1.1. Providing At-Most-Once Functionality ............107
D.1.2. Transaction identifiers and three-way handshake 106 D.1.2. Transaction identifiers and three-way handshake 108
D.1.3. Computing retransmission timers .................108 D.1.3. Computing retransmission timers .................110
D.1.4. Provisional responses ...........................109 D.1.4. Provisional responses ...........................111
D.1.5. Repeating Requests, Responses and ...............109 D.1.5. Repeating Requests, Responses and ...............111
D.2. Using TCP ............................................110 D.2. Using TCP ............................................112
D.2.1. Providing the At-Most-Once functionality ........111 D.2.1. Providing the At-Most-Once functionality ........113
D.2.2. Transaction identifiers and three way handshake 111 D.2.2. Transaction identifiers and three way handshake 113
D.2.3. Computing retransmission timers .................111 D.2.3. Computing retransmission timers .................113
D.2.4. Provisional responses ...........................111 D.2.4. Provisional responses ...........................113
D.2.5. Ordering of commands ............................112 D.2.5. Ordering of commands ............................114
ANNEX E BASIC PACKAGES ........................................112 ANNEX E BASIC PACKAGES ........................................114
E.1. Generic ..............................................112 E.1. Generic ..............................................114
E.1.1. Properties ......................................112 E.1.1. Properties ......................................114
E.1.2. Events ..........................................112 E.1.2. Events ..........................................114
E.2.2. Events ..........................................116 E.2.2. Events ..........................................118
E.2.3. Signals .........................................116 E.2.3. Signals .........................................118
E.2.4. Statistics ......................................116 E.2.4. Statistics ......................................118
E.2.5. Procedures ......................................116 E.2.5. Procedures ......................................118
E.3. Tone Generator Package ...............................116 E.3. Tone Generator Package ...............................118
E.3.1. Properties ......................................116 E.3.1. Properties ......................................118
E.3.2. Events ..........................................116 E.3.2. Events ..........................................118
E.3.3. Signals .........................................116 E.3.3. Signals .........................................118
E.3.4. Statistics ......................................117 E.3.4. Statistics ......................................119
E.3.5. Procedures ......................................117 E.3.5. Procedures ......................................119
E.4. Tone Detection Package ...............................117 E.4. Tone Detection Package ...............................119
E.4.1. Properties ......................................117 E.4.1. Properties ......................................119
E.4.2. Events ..........................................117 E.4.2. Events ..........................................119
E.4.3. Signals .........................................119 E.4.3. Signals .........................................121
E.4.4. Statistics ......................................119 E.4.4. Statistics ......................................121
E.4.5. Procedures ......................................119 E.4.5. Procedures ......................................121
E.5. Basic DTMF Generator Package .........................119 E.5. Basic DTMF Generator Package .........................121
E.5.1. Properties ......................................119 E.5.1. Properties ......................................121
E.5.2. Events ..........................................119 E.5.2. Events ..........................................121
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
E.5.3. Signals .........................................120 E.5.3. Signals .........................................122
E.5.4. Statistics ......................................120 E.5.4. Statistics ......................................122
E.5.5. Procedures ......................................120 E.5.5. Procedures ......................................122
E.6. DTMF detection Package ...............................121 E.6. DTMF detection Package ...............................123
E.6.1. Properties ......................................121 E.6.1. Properties ......................................123
E.6.2. Events ..........................................121 E.6.2. Events ..........................................123
E.6.3. Signals .........................................121 E.6.3. Signals .........................................125
E.6.4. Statistics ......................................121 E.6.4. Statistics ......................................125
E.6.5. Procedures ......................................121 E.6.5. Procedures ......................................125
E.7. Call Progress Tones Generator Package ................122 E.7. Call Progress Tones Generator Package ................125
E.7.1. Properties ......................................122 E.7.1. Properties ......................................125
E.7.2. Events ..........................................122 E.7.2. Events ..........................................125
E.7.3. Signals .........................................122 E.7.3. Signals .........................................125
E.7.4. Statistics ......................................122 E.7.4. Statistics ......................................126
E.7.5. Procedures ......................................123 E.7.5. Procedures ......................................126
E.8. Call Progress Tones Detection Package ................123 E.8. Call Progress Tones Detection Package ................126
E.8.1. Properties ......................................123 E.8.1. Properties ......................................126
E.8.2. Events ..........................................123 E.8.2. Events ..........................................126
E.8.3. Signals .........................................123 E.8.3. Signals .........................................127
E.8.4. Statistics ......................................123 E.8.4. Statistics ......................................127
E.8.5. Procedures ......................................123 E.8.5. Procedures ......................................127
E.9. Analog Line Supervision Package ......................124 E.9. Analog Line Supervision Package ......................127
E.9.1. Properties ......................................124 E.9.1. Properties ......................................127
E.9.2. Events ..........................................124 E.9.2. Events ..........................................127
E.9.3. Signals .........................................124 E.9.3. Signals .........................................128
E.9.4. Statistics ......................................125 E.9.4. Statistics ......................................129
E.9.5. Procedures ......................................125 E.9.5. Procedures ......................................129
E.10. Basic Continuity Package ............................125 E.10. Basic Continuity Package ............................129
E.10.1. Properties .....................................125 E.10.1. Properties .....................................129
E.10.2. Events .........................................125 E.10.2. Events .........................................129
E.10.3. Signals ........................................126 E.10.3. Signals ........................................129
E.10.4. Statistics .....................................126 E.10.4. Statistics .....................................130
E.10.5. Procedures .....................................126 E.10.5. Procedures .....................................130
E.11. Network Package .....................................126 E.11. Network Package .....................................130
E.11.1. Properties .....................................127 E.11.1. Properties .....................................131
E.11.2. Events .........................................127 E.11.2. Events .........................................131
E.11.3. Signals ........................................128 E.11.3. Signals ........................................132
E.11.4. Statistics .....................................128 E.11.4. Statistics .....................................132
E.11.5. Procedures .....................................128 E.11.5. Procedures .....................................132
E.12. RTP Package .........................................128 E.12. RTP Package .........................................132
E.12.1. Properties .....................................128 E.12.1. Properties .....................................133
E.12.2. Events .........................................129 E.12.2. Events .........................................133
E.12.3. Signals ........................................129 E.12.3. Signals ........................................133
E.12.4. Statistics .....................................129 E.12.4. Statistics .....................................133
E.12.5. Procedures .....................................130 E.12.5. Procedures .....................................134
E.13. DS0 Package .........................................130 E.13. DS0 Package ........................................134
E.13.1. Properties .....................................130 E.13.1. Properties .....................................134
E.13.2. Events .........................................131 E.13.2. Events .........................................135
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
E.13.3. Signals ........................................131 E.13.3. Signals ........................................131
E.13.4. Statistics .....................................131 E.13.4. Statistics .....................................131
E.13.5. Procedures .....................................131 E.13.5. Procedures .....................................132
APPENDIX A EXAMPLE CALL FLOWS (INFORMATIVE) ..............131 APPENDIX A EXAMPLE CALL FLOWS (INFORMATIVE) ..............132
A.1. Residential Gateway to Residential Gateway Call ......131 A.1. Residential Gateway to Residential Gateway Call ......132
A.1.1. Programming Residential GW Analog Line ..........131 A.1.1. Programming Residential GW Analog Line ..........132
A.1.2. Collecting Digits and Initiating Termination.....132
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
TABLE OF FIGURES
Figure 1: Example of MEGACOH.248 Connection Model ...............12
Figure 3: Example Call Waiting Scenario / Alerting Applied to T1 13
Figure 4: Example Call Waiting Scenario / Answer by T1 ..........14
Figure 5: Example topologies ...................................38
Figure 6: Transactions, Actions and Commands.....................53
1. SCOPE 1. SCOPE
MEGACO defines the protocols used between elements of a physically MEGACO defines the protocols used between elements of a physically
decomposed multimedia Gateway consisting of a Media Gateway and a Media decomposed multimedia Gateway consisting of a Media Gateway and a Media
Gateway Controller. There are no functional differences from a system Gateway Controller. There are no functional differences from a system
view between a decomposed gateway, with distributed sub- components view between a decomposed gateway, with distributed sub- components
potentially on more than one physical device, and a monolithic gateway. potentially on more than one physical device, and a monolithic gateway.
This document does not define how gateways, multipoint control units or This document does not define how gateways, multipoint control units or
integrated voice response units (IVRs) work. Instead it creates a gen- integrated voice response units (IVRs) work. Instead it creates a gen-
skipping to change at page 7, line 46 skipping to change at page 8, line 5
ITU-T Recommendation H.245 (1998): "Control Protocol for Multimedia Com- ITU-T Recommendation H.245 (1998): "Control Protocol for Multimedia Com-
munication". munication".
ITU-T Recommendation H.323 (1998): "Packet Based Multimedia Communica- ITU-T Recommendation H.323 (1998): "Packet Based Multimedia Communica-
tion Systems". tion Systems".
ITU-T Recommendation I.363.1 (08/96), "B-ISDN ATM Adaptation Layer ITU-T Recommendation I.363.1 (08/96), "B-ISDN ATM Adaptation Layer
specification: Type 1 AAL". specification: Type 1 AAL".
ITU-T Recommendation I.366.1 (06/98), "Segmentation and Reassembly Internet draft MEGACO Protocol February 8, 2000
Internet draft MEGACO Protocol January 27, 2000
Service Specific Convergence Sublayer for the AAL type 2". ITU-T Recommendation I.366.1 (06/98), "Segmentation and Reassembly Ser-
vice Specific Convergence Sublayer for the AAL type 2".
ITU-T Recommendation I.366.2 (02/99), "AAL type 2 service specific con- ITU-T Recommendation I.366.2 (02/99), "AAL type 2 service specific con-
vergence sublayer for trunking". vergence sublayer for trunking".
ITU-T Recommendation Q.931 (05/98): "Digital Subscriber Signalling Sys- ITU-T Recommendation Q.931 (05/98): "Digital Subscriber Signalling Sys-
tem No. 1 (DSS 1) - ISDN User-Network Interface Layer 3 Specification tem No. 1 (DSS 1) - ISDN User-Network Interface Layer 3 Specification
for Basic Call Control" for Basic Call Control"
ITU-T Recommendation X.680 (1997): "Information technology-Abstract Syn- ITU-T Recommendation X.680 (1997): "Information technology-Abstract Syn-
tax Notation One (ASN.1): Specification of basic notation". tax Notation One (ASN.1): Specification of basic notation".
skipping to change at page 8, line 53 skipping to change at page 8, line 54
ITU-T Recommendation Q.724 (1988): "Signalling procedures" ITU-T Recommendation Q.724 (1988): "Signalling procedures"
RFC 768, "User Datagram Protocol", J.Postel, August 1980. RFC 768, "User Datagram Protocol", J.Postel, August 1980.
RFC 793, "TRANSMISSION CONTROL PROTOCOL", J.Postel, September 1981. RFC 793, "TRANSMISSION CONTROL PROTOCOL", J.Postel, September 1981.
RFC 1889, "RTP: A Transport Protocol for Real-Time Applications", H. RFC 1889, "RTP: A Transport Protocol for Real-Time Applications", H.
Schulzrinne, S. Casner, R. Frederick, V. Jacobson, January 1996. Schulzrinne, S. Casner, R. Frederick, V. Jacobson, January 1996.
RFC 1890, "RTP Profile for Audio and Video Conferences with Minimal Con- RFC 1890, "RTP Profile for Audio and Video Conferences with Minimal
trol", H. Schulzrinne, January 1996.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
Control", H. Schulzrinne, January 1996.
RFC 2401, "Security Architecture for the Internet Protocol", S. Kent, R. RFC 2401, "Security Architecture for the Internet Protocol", S. Kent, R.
Atkinson, November 1998. Atkinson, November 1998.
RFC 2543, " SIP: Session Initiation Protocol", M. Handley, H. RFC 2543, " SIP: Session Initiation Protocol", M. Handley, H.
Schulzrinne, E. Schooler, J. Rosenberg, March 1999. Schulzrinne, E. Schooler, J. Rosenberg, March 1999.
RFC 2460, "Internet Protocol, Version 6 (IPv6) Specification", S. Deer- RFC 2460, "Internet Protocol, Version 6 (IPv6) Specification", S. Deer-
ing, R. Hinden, December 1998. ing, R. Hinden, December 1998.
skipping to change at page 9, line 53 skipping to change at page 10, line 4
packet network. A residential gateway typically contains one or two packet network. A residential gateway typically contains one or two
analogue lines and is located at the customer premises. analogue lines and is located at the customer premises.
SCN FAS Signalling Gateway: This function contains the SCN Signalling SCN FAS Signalling Gateway: This function contains the SCN Signalling
Interface that terminates SS7, ISDN or other signalling links where the Interface that terminates SS7, ISDN or other signalling links where the
call control channel and bearer channels are collocated in the same phy- call control channel and bearer channels are collocated in the same phy-
sical span. sical span.
SCN NFAS Signalling Gateway: This function contains the SCN Signalling SCN NFAS Signalling Gateway: This function contains the SCN Signalling
Interface that terminates SS7 or other signalling links where the call Interface that terminates SS7 or other signalling links where the call
control channels are separated from bearer channels.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
control channels are separated from bearer channels.
Stream: Bidirectional media or control flow received/sent by a media Stream: Bidirectional media or control flow received/sent by a media
gateway as part of a call or conference. gateway as part of a call or conference.
Trunk: A communication channel between two switching systems such as a Trunk: A communication channel between two switching systems such as a
DS0 on a T1 or E1 line. DS0 on a T1 or E1 line.
Trunking Gateway: A gateway between SCN network and packet network that Trunking Gateway: A gateway between SCN network and packet network that
typically terminates a large number of digital circuits. typically terminates a large number of digital circuits.
skipping to change at page 10, line 52 skipping to change at page 10, line 54
document are to be interpreted as described in RFC2119. document are to be interpreted as described in RFC2119.
6. CONNECTION MODEL 6. CONNECTION MODEL
The connection model for the protocol describes the logical entities, or The connection model for the protocol describes the logical entities, or
objects, within the Media Gateway that can be controlled by the Media objects, within the Media Gateway that can be controlled by the Media
Gateway Controller. The main abstractions used in the connection model Gateway Controller. The main abstractions used in the connection model
are Terminations and Contexts. are Terminations and Contexts.
A Termination sources and/or sinks one or more streams. In a multimedia A Termination sources and/or sinks one or more streams. In a multimedia
conference, a Termination can be multimedia and sources or sinks multi- conference, a Termination can be multimedia and sources or sinks
ple media streams. The media stream parameters, as well as modem, and
bearer parameters are encapsulated within the Termination.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
multiple media streams. The media stream parameters, as well as modem,
and bearer parameters are encapsulated within the Termination.
A Context is an association between a collection of Terminations. There A Context is an association between a collection of Terminations. There
is a special type of Context, the null Context, which contains all Ter- is a special type of Context, the null Context, which contains all Ter-
minations that are not associated to any other Termination. For minations that are not associated to any other Termination. For
instance, in a decomposed access gateway, all idle lines are represented instance, in a decomposed access gateway, all idle lines are represented
by Terminations in the null Context. by Terminations in the null Context.
Following is a graphical depiction of these concepts. The diagram of Following is a graphical depiction of these concepts. The diagram of
Figure 1 gives several examples and is not meant to be an all-inclusive Figure 1 gives several examples and is not meant to be an all-inclusive
illustration. The asterisk box in each of the Contexts represents the illustration. The asterisk box in each of the Contexts represents the
logical association of Terminations implied by the Context. logical association of Terminations implied by the Context.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
+------------------------------------------------------+ +------------------------------------------------------+
|Media Gateway | |Media Gateway |
| +-------------------------------------------------+ | | +-------------------------------------------------+ |
| |Context +-------------+ | | | |Context +-------------+ | |
| | | Termination | | | | | | Termination | | |
| | |-------------| | | | | |-------------| | |
| | +-------------+ +->| SCN Bearer |<---+-> | | +-------------+ +->| SCN Bearer |<---+->
| | | Termination | +-----+ | | Channel | | | | | | Termination | +-----+ | | Channel | | |
| | |-------------| | |---+ +-------------+ | | | | |-------------| | |---+ +-------------+ | |
skipping to change at page 13, line 5 skipping to change at page 13, line 5
| +-------------------------------------------------+ | | +-------------------------------------------------+ |
| ___________________________________________________ | | ___________________________________________________ |
+------------------------------------------------------+ +------------------------------------------------------+
Figure 1: Example of MEGACO Connection Model Figure 1: Example of MEGACO Connection Model
The example below shows an example of one way to accomplish a call- The example below shows an example of one way to accomplish a call-
waiting scenario in a decomposed access gateway, illustrating the relo- waiting scenario in a decomposed access gateway, illustrating the relo-
cation of a Termination between Contexts. Terminations T1 and T2 belong cation of a Termination between Contexts. Terminations T1 and T2 belong
to Context C1 in a two-way audio call. A second audio call is waiting to Context C1 in a two-way audio call. A second audio call is waiting
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
for T1 from Termination T3. T3 is alone in Context C2. T1 accepts the for T1 from Termination T3. T3 is alone in Context C2. T1 accepts the
call from T3, placing T2 on hold. This action results in T1 moving into call from T3, placing T2 on hold. This action results in T1 moving into
Context C2, as shown below. Context C2, as shown below.
+------------------------------------------------------+ +------------------------------------------------------+
|Media Gateway | |Media Gateway |
| +-------------------------------------------------+ | | +-------------------------------------------------+ |
| |Context C1 | | | |Context C1 | |
| | +-------------+ +-------------+ | | | | +-------------+ +-------------+ | |
skipping to change at page 14, line 5 skipping to change at page 14, line 5
| | +-------------+ | | | | +-------------+ | |
| | +-----+ | Term. T3 | | | | | +-----+ | Term. T3 | | |
| | | | |-------------| | | | | | | |-------------| | |
| | | * |------| SCN Bearer |<---+-> | | | * |------| SCN Bearer |<---+->
| | | | | Channel | | | | | | | | Channel | | |
| | +-----+ +-------------+ | | | | +-----+ +-------------+ | |
| +-------------------------------------------------+ | | +-------------------------------------------------+ |
+------------------------------------------------------+ +------------------------------------------------------+
Figure 2 Example Call Waiting Scenario / Alerting Applied to T1 Figure 2 Example Call Waiting Scenario / Alerting Applied to T1
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
+------------------------------------------------------+ +------------------------------------------------------+
|Media Gateway | |Media Gateway |
| +-------------------------------------------------+ | | +-------------------------------------------------+ |
| |Context C1 | | | |Context C1 | |
| | +-------------+ | | | | +-------------+ | |
| | | Term. T2 | +-----+ | | | | | Term. T2 | +-----+ | |
| | |-------------| | | | | | | |-------------| | | | |
<-+--->| RTP Stream |---| * | | | <-+--->| RTP Stream |---| * | | |
| | | | | | | | | | | | | | | |
skipping to change at page 15, line 5 skipping to change at page 15, line 5
the MGC does not specify an existing Context to which the Termination is the MGC does not specify an existing Context to which the Termination is
to be added, the MG creates a new Context. A Termination may be removed to be added, the MG creates a new Context. A Termination may be removed
from a Context with a Subtract command, and a Termination may be moved from a Context with a Subtract command, and a Termination may be moved
from one Context to another with a Move command. A Termination SHALL from one Context to another with a Move command. A Termination SHALL
exist in only one Context at a time. exist in only one Context at a time.
The maximum number of Terminations in a Context is a MG property. Media The maximum number of Terminations in a Context is a MG property. Media
gateways that offer only point-to-point connectivity might allow at most gateways that offer only point-to-point connectivity might allow at most
two Terminations per Context. Media gateways that support multipoint two Terminations per Context. Media gateways that support multipoint
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
conferences might allow three or more terminations per Context. conferences might allow three or more terminations per Context.
6.1.1. Context Attributes and Descriptors 6.1.1. Context Attributes and Descriptors
The attributes of Contexts are: The attributes of Contexts are:
ContextID, a 32 bit unsigned integer chosen by the MG. The topology ContextID, a 32 bit unsigned integer chosen by the MG. The topology
(who hears/sees whom). The topology of a Context describes the flow of (who hears/sees whom). The topology of a Context describes the flow of
media between the Terminations within a Context. In contrast, the mode media between the Terminations within a Context. In contrast, the mode
skipping to change at page 16, line 5 skipping to change at page 16, line 5
existence. For example, a Termination representing a TDM channel might existence. For example, a Termination representing a TDM channel might
exist for as long as it is provisioned in the gateway. Terminations exist for as long as it is provisioned in the gateway. Terminations
representing ephemeral information flows, such as RTP flows, would usu- representing ephemeral information flows, such as RTP flows, would usu-
ally exist only for the duration of their use. ally exist only for the duration of their use.
Ephemeral Terminations are created by means of an Add command. They are Ephemeral Terminations are created by means of an Add command. They are
destroyed by means of a Subtract command. In contrast, when a physical destroyed by means of a Subtract command. In contrast, when a physical
Termination is Added to or Subtracted from a Context, it is taken from Termination is Added to or Subtracted from a Context, it is taken from
or to the null Context, respectively. or to the null Context, respectively.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
Terminations may have signals applied to them. Signals are MG generated Terminations may have signals applied to them. Signals are MG generated
media streams such as tones and announcements as well as line signals media streams such as tones and announcements as well as line signals
such as hookswitch. Terminations may be programmed to detect Events, such as hookswitch. Terminations may be programmed to detect Events,
the occurrence of which can trigger notification messages to the MGC, or the occurrence of which can trigger notification messages to the MGC, or
action by the MG. Statistics may be accumulated on a Termination. action by the MG. Statistics may be accumulated on a Termination.
Statistics are reported to the MGC upon request (by means of the Audit- Statistics are reported to the MGC upon request (by means of the Audit-
Value command, see section 7.2.5) and when the Termination is taken out Value command, see section 7.2.5) and when the Termination is taken out
of the call it is in. of the call it is in.
skipping to change at page 17, line 5 skipping to change at page 17, line 5
Terminations are referenced by a TerminationID, which is an arbitrary Terminations are referenced by a TerminationID, which is an arbitrary
schema chosen by the MG. schema chosen by the MG.
TerminationIDs of physical Terminations are provisioned in the Media TerminationIDs of physical Terminations are provisioned in the Media
Gateway. The TerminationIDs may be chosen to have structure. For Gateway. The TerminationIDs may be chosen to have structure. For
instance, a TerminationID may consist of trunk group and a trunk within instance, a TerminationID may consist of trunk group and a trunk within
the group. the group.
A wildcarding mechanism using two types of wildcards can be used with A wildcarding mechanism using two types of wildcards can be used with
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
TerminationIDs. The two wildcards are ALL and CHOOSE. The former is TerminationIDs. The two wildcards are ALL and CHOOSE. The former is
used to address multiple Terminations at once, while the latter is used used to address multiple Terminations at once, while the latter is used
to indicate to a media gateway that it must select a Termination satis- to indicate to a media gateway that it must select a Termination satis-
fying the partially specified TerminationID. This allows, for instance, fying the partially specified TerminationID. This allows, for instance,
that a MGC instructs a MG to choose a circuit within a trunk group. that a MGC instructs a MG to choose a circuit within a trunk group.
When ALL is used in the TerminationID of a command, the effect is ident- When ALL is used in the TerminationID of a command, the effect is ident-
ical to repeating the command with each of the matching TerminationIDs. ical to repeating the command with each of the matching TerminationIDs.
Since each of these commands may generate a response, the size of the Since each of these commands may generate a response, the size of the
skipping to change at page 18, line 5 skipping to change at page 18, line 5
Terminations have properties. The properties have unique PropertyIDs. Terminations have properties. The properties have unique PropertyIDs.
Most properties have default values. When a Termination is created, Most properties have default values. When a Termination is created,
properties get their default values, unless the controller specifically properties get their default values, unless the controller specifically
sets a different value. The default value of a property of a physical sets a different value. The default value of a property of a physical
Termination can be changed by setting it to a different value when the Termination can be changed by setting it to a different value when the
Termination is in the null Context. Every time such a Termination Termination is in the null Context. Every time such a Termination
returns to the null Context, the values of its properties are reset to returns to the null Context, the values of its properties are reset to
this default value. this default value.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
There are a number of common properties for Terminations and properties There are a number of common properties for Terminations and properties
specific to media streams. The common properties are also called the specific to media streams. The common properties are also called the
termination state properties. For each media stream, there are local termination state properties. For each media stream, there are local
properties and properties of the received and transmitted flows. properties and properties of the received and transmitted flows.
Properties not included in the base protocol are defined in Packages. Properties not included in the base protocol are defined in Packages.
These properties are referred to by a name consisting of the PackageName These properties are referred to by a name consisting of the PackageName
and a PropertyId. Most properties have default values described in the and a PropertyId. Most properties have default values described in the
Package description. Properties may be read-only or read/write. The pos- Package description. Properties may be read-only or read/write. The pos-
skipping to change at page 19, line 5 skipping to change at page 19, line 5
|TerminationState |Properties of a Termination (which can be defined in| |TerminationState |Properties of a Termination (which can be defined in|
| |Packages) that are not stream specific. | | |Packages) that are not stream specific. |
|__________________|____________________________________________________| |__________________|____________________________________________________|
|Stream |A list of remote/local/localControl descriptors for | |Stream |A list of remote/local/localControl descriptors for |
| |a single stream | |__________________|____________________________________________________| | |a single stream | |__________________|____________________________________________________|
|Local |Contains properties that specify the media flows | |Local |Contains properties that specify the media flows |
| |that MG receives from the remote entity. | | |that MG receives from the remote entity. |
|__________________|____________________________________________________| |__________________|____________________________________________________|
| | | | | |
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
|Remote |Contains properties that specify the media flows | |Remote |Contains properties that specify the media flows |
| |that the MG sends to the remote entity. | |__________________|____________________________________________________| | |that the MG sends to the remote entity. | |__________________|____________________________________________________|
|LocalControl |Contains properties (which can be defined in | |LocalControl |Contains properties (which can be defined in |
| |packages) that are of interest between the MG and | | |packages) that are of interest between the MG and |
| |the MGC | |__________________|____________________________________________________| | |the MGC | |__________________|____________________________________________________|
|Events |Describes events to be detected by the MG and what | |Events |Describes events to be detected by the MG and what |
| |to do when an event is detected | |__________________|____________________________________________________| | |to do when an event is detected | |__________________|____________________________________________________|
|EventBuffer |Describes events to be detected by the MG when Event| |EventBuffer |Describes events to be detected by the MG when Event|
| |Buffering is active | |__________________|____________________________________________________| | |Buffering is active | |__________________|____________________________________________________|
skipping to change at page 20, line 5 skipping to change at page 20, line 5
* an AuditValue return - to examine the values of properties imple- * an AuditValue return - to examine the values of properties imple-
mented on root mented on root
* an AuditCapability - to determine what properties of root are * an AuditCapability - to determine what properties of root are
implemented implemented
* a ServiceChange - to declare the gateway in or out of service Any * a ServiceChange - to declare the gateway in or out of service Any
other use of the root TerminationID is an error. other use of the root TerminationID is an error.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
7. COMMANDS 7. COMMANDS
The protocol provides commands for manipulating the logical entities of The protocol provides commands for manipulating the logical entities of
the protocol connection model, Contexts and Terminations. Commands pro- the protocol connection model, Contexts and Terminations. Commands pro-
vide control at the finest level of granularity supported by the proto- vide control at the finest level of granularity supported by the proto-
col. For example, Commands exist to add Terminations to a Context, col. For example, Commands exist to add Terminations to a Context,
modify Terminations, subtract Terminations from a Context, and audit modify Terminations, subtract Terminations from a Context, and audit
properties of Contexts or Terminations. Commands provide for complete properties of Contexts or Terminations. Commands provide for complete
control of the properties of Contexts and Terminations. This includes control of the properties of Contexts and Terminations. This includes
skipping to change at page 21, line 5 skipping to change at page 21, line 5
possible values for Termination properties, events and signals possible values for Termination properties, events and signals
allowed by the Media Gateway. allowed by the Media Gateway.
7. Notify. The Notify command allows the Media Gateway to inform the 7. Notify. The Notify command allows the Media Gateway to inform the
Media Gateway Controller of the occurrence of events in the Media Media Gateway Controller of the occurrence of events in the Media
Gateway. Gateway.
8. ServiceChange. The ServiceChange Command allows the Media Gateway 8. ServiceChange. The ServiceChange Command allows the Media Gateway
to notify the Media Gateway Controller that a Termination or group to notify the Media Gateway Controller that a Termination or group
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
of Terminations is about to be taken out of service or has just of Terminations is about to be taken out of service or has just
been returned to service. ServiceChange is also used by the MG to been returned to service. ServiceChange is also used by the MG to
announce its availability to an MGC (registration), and to notify announce its availability to an MGC (registration), and to notify
the MGC of impending or completed restart of the MG. The MGC may the MGC of impending or completed restart of the MG. The MGC may
announce a handover to the MG by sending it a ServiceChange com- announce a handover to the MG by sending it a ServiceChange com-
mand. The MGC may also use ServiceChange to instruct the MG to mand. The MGC may also use ServiceChange to instruct the MG to
take a Termination or group of Terminations in or out of service. take a Termination or group of Terminations in or out of service.
These commands are detailed in sections 7.2.1 through 7.2.8 These commands are detailed in sections 7.2.1 through 7.2.8
skipping to change at page 22, line 5 skipping to change at page 22, line 5
Unspecified mandatory parameters (i.e. mandatory parameters not speci- Unspecified mandatory parameters (i.e. mandatory parameters not speci-
fied in a descriptor) result in the command responder retaining the pre- fied in a descriptor) result in the command responder retaining the pre-
vious value for that parameter. Unspecified optional parameters result vious value for that parameter. Unspecified optional parameters result
in the command responder using the default value of the parameter. When- in the command responder using the default value of the parameter. When-
ever a parameter is underspecified or overspecified, the descriptor con- ever a parameter is underspecified or overspecified, the descriptor con-
taining the value chosen by the responder is included as output from the taining the value chosen by the responder is included as output from the
command. command.
Each command specifies the TerminationId the command operates on. This Each command specifies the TerminationId the command operates on. This
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
TerminationId may be "wildcarded". When the TerminationId of a command TerminationId may be "wildcarded". When the TerminationId of a command
is wildcarded, the effect shall be as if the command was repeated with is wildcarded, the effect shall be as if the command was repeated with
each of the TerminationIds matched. each of the TerminationIds matched.
7.1.2. Modem Descriptor 7.1.2. Modem Descriptor
The Modem descriptor specifies the modem type and parameters, if any, The Modem descriptor specifies the modem type and parameters, if any,
required for use in e.g. H.324 and text conversation. The descriptor required for use in e.g. H.324 and text conversation. The descriptor
includes the following modem types: V.18, V.22, V.22bis, V.32, V.32bis, includes the following modem types: V.18, V.22, V.22bis, V.32, V.32bis,
skipping to change at page 23, line 5 skipping to change at page 23, line 5
State Descriptor, which specifies the properties of a termination that State Descriptor, which specifies the properties of a termination that
are not stream dependent, and one or more Stream Descriptors each of are not stream dependent, and one or more Stream Descriptors each of
which describes a single media stream. which describes a single media stream.
A stream is identified by a StreamID. The StreamID is used to link the A stream is identified by a StreamID. The StreamID is used to link the
streams in a Context that belong together. Multiple streams exiting a streams in a Context that belong together. Multiple streams exiting a
termination shall be synchronized with each other. Within the Stream termination shall be synchronized with each other. Within the Stream
Descriptor, there are up to three subsidiary descriptors, LocalControl, Descriptor, there are up to three subsidiary descriptors, LocalControl,
Local, and Remote. The relationship between these descriptors is thus: Local, and Remote. The relationship between these descriptors is thus:
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
Media Descriptor Media Descriptor
TerminationStateDescriptor TerminationStateDescriptor
Stream Descriptor Stream Descriptor
LocalControl Descriptor LocalControl Descriptor
Local Descriptor Local Descriptor
Remote Descriptor Remote Descriptor
StreamIDs are numbered from 1 upward. As a convenience a LocalControl, StreamIDs are numbered from 1 upward. As a convenience a LocalControl,
Local, or Remote descriptor may be included in the Media Descriptor Local, or Remote descriptor may be included in the Media Descriptor
skipping to change at page 24, line 5 skipping to change at page 24, line 5
must be selected, boundary values included must be selected, boundary values included
* Greater Than/Less Than - value must be greater/less than specified * Greater Than/Less Than - value must be greater/less than specified
value value
* CHOOSE Wildcard - the MG chooses from the allowed values for the * CHOOSE Wildcard - the MG chooses from the allowed values for the
property The EventBuffer flag specifies whether events are buffered property The EventBuffer flag specifies whether events are buffered
following detection of an event in the Events Descriptor, or pro- following detection of an event in the Events Descriptor, or pro-
cessed immediately. See section 7.1.9 for details. cessed immediately. See section 7.1.9 for details.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
7.1.6. Stream Descriptor 7.1.6. Stream Descriptor
A Stream descriptor specifies the parameters of a single bi-directional A Stream descriptor specifies the parameters of a single bi-directional
stream. These parameters are structured into three descriptors: one stream. These parameters are structured into three descriptors: one
that contains termination properties specific to a stream and one each that contains termination properties specific to a stream and one each
for local and remote flows. The Stream Descriptor includes a StreamID for local and remote flows. The Stream Descriptor includes a StreamID
which identifies the stream. Streams are created by specifiying a new which identifies the stream. Streams are created by specifiying a new
StreamID on one of the terminations in a Context. Streams are deleted by StreamID on one of the terminations in a Context. A stream is deleted by
setting the Mode property in LocalControl to "delete" on one of the ter- setting empty Local and Remote descriptors for the stream with Reserve
minations in a Context. in LocalControl set to "false" on all terminations in the context which
previously supported that stream.
If a termination is moved from one context to another, the following If a termination is moved from one context to another, the following
applies: applies:
* if a streamID of an active stream in the moved termination matches * if a streamID of an active stream in the moved termination matches
a streamID in the context it was moved to, the associated stream a streamID in the context it was moved to, the associated stream
remains active on that termination; remains active on that termination;
* if a streamID of an active stream in the moved termination does not * if a streamID of an active stream in the moved termination does not
match any streamID in the context it was moved to, the stream SHALL match any streamID in the context it was moved to, the stream SHALL
skipping to change at page 24, line 44 skipping to change at page 24, line 45
the context. the context.
7.1.7. LocalControl Descriptor 7.1.7. LocalControl Descriptor
The LocalControl Descriptor contains the Mode property, the Reserve pro- The LocalControl Descriptor contains the Mode property, the Reserve pro-
perty and properties of a termination (defined in Packages) that are perty and properties of a termination (defined in Packages) that are
stream specific, and are of interest between the MG and the MGC. Values stream specific, and are of interest between the MG and the MGC. Values
of properties may be underspecified as in section 7.1.5 of properties may be underspecified as in section 7.1.5
The allowed values for the mode property are send-only, receive-only, The allowed values for the mode property are send-only, receive-only,
send/receive, inactive, loop-back and delete. "Send" and "receive" are send/receive, inactive, and loop-back. "Send" and "receive" are with
with respect to the exterior of the context, so that, for example, a respect to the exterior of the context, so that, for example, a stream
stream set to mode=sendonly does not pass received media into the con- set to mode=sendonly does not pass received media into the context.
text. Signals and Events are not affected by mode. Mode set to delete Signals and Events are not affected by mode.
is used to remove a stream from a termination.
The boolean-valued Reserve property of a Termination indicates what the The boolean-valued Reserve property of a Termination indicates what the
MG is expected to do when it receives a local and/or remote descriptor. MG is expected to do when it receives a local and/or remote descriptor.
If the value of Reserve is True, the MG SHALL reserve resources for all If the value of Reserve is True, the MG SHALL reserve resources for all
alternatives specified in the local and/or remote descriptors it alternatives specified in the local and/or remote descriptors it
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
currently has resources available for. It SHALL respond with the alter- currently has resources available for. It SHALL respond with the alter-
natives it reserves resources for. If it cannot not support any of the natives it reserves resources for. If it cannot not support any of the
alternatives, it SHALL respond with a reply to the MGC that contains alternatives, it SHALL respond with a reply to the MGC that contains
empty local and/or remote descriptors. empty local and/or remote descriptors.
If the value of Reserve is False, the MG SHALL choose one of the alter- If the value of Reserve is False, the MG SHALL choose one of the alter-
natives specified in the local descriptor (if present) and one of the natives specified in the local descriptor (if present) and one of the
alternatives specified in the remote descriptor (if present). If the MG alternatives specified in the remote descriptor (if present). If the MG
has not yet reserved resources to support the selected alternative, it has not yet reserved resources to support the selected alternative, it
skipping to change at page 26, line 5 skipping to change at page 26, line 5
media sent by the MG. media sent by the MG.
When text encoding the protocol, the descriptors consist of session When text encoding the protocol, the descriptors consist of session
descriptions as defined in SDP (RFC2327), except that the "s=", "t=" and descriptions as defined in SDP (RFC2327), except that the "s=", "t=" and
"o=" lines are optional. When multiple session descriptions are provided "o=" lines are optional. When multiple session descriptions are provided
in one descriptor, the "v=" lines are required as delimiters; otherwise in one descriptor, the "v=" lines are required as delimiters; otherwise
they are optional. Implementations shall accept session descriptions they are optional. Implementations shall accept session descriptions
that are fully conformant to RFC2327. When binary encoding the protocol that are fully conformant to RFC2327. When binary encoding the protocol
the descriptor consists of groups of properties (tag-value pairs) as the descriptor consists of groups of properties (tag-value pairs) as
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
specified in Annex C. Each such group may contain the parameters of a specified in Annex C. Each such group may contain the parameters of a
session description. session description.
Below, the semantics of the local and remote descriptors are specified Below, the semantics of the local and remote descriptors are specified
in detail. The specification consists of two parts. The first part in detail. The specification consists of two parts. The first part
specifies the interpretation of the contents of the descriptor. The specifies the interpretation of the contents of the descriptor. The
second part specifies the actions the MG must take upon receiving the second part specifies the actions the MG must take upon receiving the
local and remote descriptors. The actions to taken by the MG depend on local and remote descriptors. The actions to taken by the MG depend on
the value of the Reserve property of the LocalControl descriptor. the value of the Reserve property of the LocalControl descriptor.
skipping to change at page 27, line 5 skipping to change at page 27, line 5
d) Underspecified or overspecified properties within a group of pro- d) Underspecified or overspecified properties within a group of pro-
perties sent by the MGC are requests for the MG to choose a value perties sent by the MGC are requests for the MG to choose a value
which it can support for each of those properties. In case of an which it can support for each of those properties. In case of an
overspecified property, the list of values is in descending order overspecified property, the list of values is in descending order
of preference. of preference.
Subject to the above rules, subsequent action depends on the value of Subject to the above rules, subsequent action depends on the value of
the "Reserve" parameter in LocalControl. the "Reserve" parameter in LocalControl.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
If Reserve is true, the MG reserves the resources required to support If Reserve is true, the MG reserves the resources required to support
any of the alternatives that it can currently support. any of the alternatives that it can currently support.
NOTE - If a Local or Remote descriptor contains multiple groups of pro- NOTE - If a Local or Remote descriptor contains multiple groups of pro-
perties, the MG is requested to reserve resources so that it can decode perties, the MG is requested to reserve resources so that it can decode
or encode one media stream according to any of the alternatives. For or encode one media stream according to any of the alternatives. For
instance, if the Local descriptor contains two groups of properties, one instance, if the Local descriptor contains two groups of properties, one
specifying packetized G.711 A-law audio and the other G.723.1 audio, the specifying packetized G.711 A-law audio and the other G.723.1 audio, the
MG reserves resources so that it can decode one audio stream encoded in MG reserves resources so that it can decode one audio stream encoded in
skipping to change at page 28, line 5 skipping to change at page 28, line 5
* If the MG is unable to support at least one Local and one Remote * If the MG is unable to support at least one Local and one Remote
alternative, it returns Error 510 (Insufficient Resources). alternative, it returns Error 510 (Insufficient Resources).
* The MG returns its selected alternative in Local and Remote. * The MG returns its selected alternative in Local and Remote.
A new setting of a Local or Remote Descriptor completely replaces the A new setting of a Local or Remote Descriptor completely replaces the
previous setting of that descriptor in the MG. Thus to retain informa- previous setting of that descriptor in the MG. Thus to retain informa-
tion from the previous setting the MGC must include that information in tion from the previous setting the MGC must include that information in
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
the new setting. If the MGC wishes to delete some information from the the new setting. If the MGC wishes to delete some information from the
existing descriptor, it merely resends the descriptor (in a Modify com- existing descriptor, it merely resends the descriptor (in a Modify com-
mand) with the unwanted information stripped out. mand) with the unwanted information stripped out.
7.1.9. Events Descriptor 7.1.9. Events Descriptor
The EventsDescriptor parameter contains a RequestIdentifier and a list The EventsDescriptor parameter contains a RequestIdentifier and a list
of events that the Media Gateway is requested to detect and report. The of events that the Media Gateway is requested to detect and report. The
RequestIdentifier is used to correlate the request with the notifica- RequestIdentifier is used to correlate the request with the notifica-
skipping to change at page 29, line 5 skipping to change at page 29, line 5
carded. carded.
3. If the queue is empty, the sequence shall be stopped, and normal 3. If the queue is empty, the sequence shall be stopped, and normal
event processing shall be resumed. If there are any events remain- event processing shall be resumed. If there are any events remain-
ing in the queue, the sequence repeats. ing in the queue, the sequence repeats.
If the EventBuffer flag is off when the new Events Descriptor is If the EventBuffer flag is off when the new Events Descriptor is
received, the queue is flushed, and no events are added to it. The received, the queue is flushed, and no events are added to it. The
default state of EventBuffer is off. default state of EventBuffer is off.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
Normally, detection of an event shall cause any active signals to stop. Normally, detection of an event shall cause any active signals to stop.
When KeepActive is specified in the event, the MG shall not interrupt When KeepActive is specified in the event, the MG shall not interrupt
any signals active on the Termination on which the event is detected. any signals active on the Termination on which the event is detected.
An event can include an Embedded Signals descriptor and/or an Embedded An event can include an Embedded Signals descriptor and/or an Embedded
Events Descriptor which, if present, replaces the current Signals/Events Events Descriptor which, if present, replaces the current Signals/Events
descriptor when the event is detected. It is possible, for example, to descriptor when the event is detected. It is possible, for example, to
specify that the dial-tone Signal be generated when an off-hook Event is specify that the dial-tone Signal be generated when an off-hook Event is
detected, or that the dial-tone Signal be stopped when a digit is detected, or that the dial-tone Signal be stopped when a digit is
skipping to change at page 29, line 50 skipping to change at page 29, line 50
Support of sequential signal lists is optional. Support of sequential signal lists is optional.
Signals are defined in packages. Signals shall be named with a Package Signals are defined in packages. Signals shall be named with a Package
name (in which the signal is defined) and a SignalID. No wildcard shall name (in which the signal is defined) and a SignalID. No wildcard shall
be used in the SignalID. Signals that occur in a SignalsDescriptor have be used in the SignalID. Signals that occur in a SignalsDescriptor have
an optional StreamID parameter (default is 0, to indicate that the sig- an optional StreamID parameter (default is 0, to indicate that the sig-
nal is not related to a particular media stream), an optional signal nal is not related to a particular media stream), an optional signal
type (see below), an optional duration and possibly parameters defined type (see below), an optional duration and possibly parameters defined
in the package that defines the signal. This allows a single signal to in the package that defines the signal. This allows a single signal to
have some variation in meaning, obviating the need to create large have some variation in meaning, obviating the need to create large
numbers of individual signals. Finally, there is an optional parameter numbers of individual signals. Finally, the optional parameter
"notifyCompletion" that allows a MGC to request being notified of com- "notifyCompletion" allows the MGC to indicate that it wishes to be noti-
pletion of the signal. The value of this parameter is a RequestIdentif- fied when this signal finishes playout. When the MGC enables the Signal
ier, allowing the MGC to correlate the Notify with the corresponding Completion event (see section E.1.2) in an Event Descriptor, that event
signal. is detected whenever a signal terminates and "notifyCompletion" for that
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
signal is set to TRUE..
The duration is an integer value that is expressed in hundredths of a The duration is an integer value that is expressed in hundredths of a
second. second.
There are three types of signals: There are three types of signals:
* on/off - the signal lasts until it is turned off, * on/off - the signal lasts until it is turned off,
* timeout - the signal lasts until it is turned off or a specific * timeout - the signal lasts until it is turned off or a specific
period of time elapses, period of time elapses,
skipping to change at page 30, line 53 skipping to change at page 31, line 5
Signals are defined as proceeding from the termination towards the exte- Signals are defined as proceeding from the termination towards the exte-
rior of the Context unless otherwise specified in a package. When the rior of the Context unless otherwise specified in a package. When the
same Signal is applied to multiple Terminations within one Transaction, same Signal is applied to multiple Terminations within one Transaction,
the MG should consider using the same resource to generate these Sig- the MG should consider using the same resource to generate these Sig-
nals. nals.
Production of a Signal on a Termination is stopped by application of a Production of a Signal on a Termination is stopped by application of a
new SignalsDescriptor, or detection of an Event on the Termination (see new SignalsDescriptor, or detection of an Event on the Termination (see
section 7.1.9). section 7.1.9).
Internet draft MEGACO Protocol February 8, 2000
A new SignalsDescriptor replaces any existing SignalsDescriptor. Any A new SignalsDescriptor replaces any existing SignalsDescriptor. Any
signals applied to the Termination not in the replacement descriptor signals applied to the Termination not in the replacement descriptor
Internet draft MEGACO Protocol January 27, 2000
shall be stopped, and new signals are applied. Signals present in both shall be stopped, and new signals are applied. Signals present in both
the existing and replacement descriptor, with the same parameters in the existing and replacement descriptor, with the same parameters in
both, shall be continued. If the replacement descriptor contains a both, shall be continued. If the replacement descriptor contains a
sequential signal list with the same identifier as the existing descrip- sequential signal list with the same identifier as the existing descrip-
tor, then tor, then
* the signal type and sequence of signals in the sequential signal * the signal type and sequence of signals in the sequential signal
list in the replacement descriptor shall be ignored, and list in the replacement descriptor shall be ignored, and
* the playing of the signals in the sequential signal list in the * the playing of the signals in the sequential signal list in the
existing descriptor shall not be interrupted. existing descriptor shall not be interrupted.
If the MGC requested notification of completion for a signal, a Notify
command SHALL be sent by the MG upon completion of that signal. A
Notify triggered by completion of a signal SHALL NOT affect the state of
the eventbuffer or any active events descriptor.
7.1.12. Audit Descriptor 7.1.12. Audit Descriptor
Specifies what information is to be audited. The Audit Descriptor Specifies what information is to be audited. The Audit Descriptor
specifies the list of descriptors to be returned. Audit may be used in specifies the list of descriptors to be returned. Audit may be used in
any command to force the return of a descriptor even if the descriptor any command to force the return of a descriptor even if the descriptor
in the command was not present, or had no underspecified parameters. in the command was not present, or had no underspecified parameters.
Possible items in the Audit Descriptor are: Possible items in the Audit Descriptor are:
________________ ________________
| Modem | | Modem |
skipping to change at page 32, line 5 skipping to change at page 31, line 51
|_______________| |_______________|
| DigitMap | | DigitMap |
|_______________| |_______________|
| Statistics | | Statistics |
|_______________| |_______________|
| Packages | | Packages |
|_______________| |_______________|
| EventBuffer | | EventBuffer |
|_______________| |_______________|
Internet draft MEGACO Protocol January 27, 2000
Audit may be empty, in which case, no descriptors are returned. This is Audit may be empty, in which case, no descriptors are returned. This is
useful in Subtract, to inhibit return of statistics, especially when useful in Subtract, to inhibit return of statistics, especially when
using wildcard. using wildcard.
Internet draft MEGACO Protocol February 8, 2000
7.1.13. ServiceChange Descriptor 7.1.13. ServiceChange Descriptor
The ServiceChangeDescriptor contains the following parameters: The ServiceChangeDescriptor contains the following parameters:
* ServiceChangeMethod * ServiceChangeMethod
* ServiceChangeReason * ServiceChangeReason
* ServiceChangeAddress * ServiceChangeAddress
* ServiceChangeDelay * ServiceChangeDelay
* Profile * ServiceChangeProfile
* Version * ServiceChangeVersion
* MGCIdToTry * ServiceChangeMGCId
* TimeStamp * TimeStamp
See section 7.2.8 See section 7.2.8
7.1.14. DigitMap Descriptor 7.1.14. DigitMap Descriptor
A DigitMap is a dialing plan resident in the Media Gateway used for A DigitMap is a dialing plan resident in the Media Gateway used for
detecting and reporting digit events received on a Termination. The detecting and reporting digit events received on a Termination. The
DigitMap Descriptor contains a DigitMap name and the DigitMap to be DigitMap Descriptor contains a DigitMap name and the DigitMap to be
skipping to change at page 32, line 54 skipping to change at page 32, line 50
dard Termination manipulation Commands of the protocol. A DigitMap, dard Termination manipulation Commands of the protocol. A DigitMap,
once defined, can be used on all Terminations specified by the (possibly once defined, can be used on all Terminations specified by the (possibly
wildcarded) TerminationID in such a command. When a DigitMap is defined wildcarded) TerminationID in such a command. When a DigitMap is defined
dynamically in a DigitMap Descriptor: dynamically in a DigitMap Descriptor:
* A new DigitMap is created by specifying a name that is not yet * A new DigitMap is created by specifying a name that is not yet
defined. The value shall be present. defined. The value shall be present.
* A DigitMap value is updated by supplying a new value for a name * A DigitMap value is updated by supplying a new value for a name
that is already defined. Terminations presently using the digitmap that is already defined. Terminations presently using the digitmap
shall continue to use the old definition; subsequent shall continue to use the old definition; subsequent EventsDescrip-
tors specifying the name, including any EventsDescriptor in the
command containing the DigitMap descriptor, shall use the new one.
Internet draft MEGACO Protocol January 27, 2000 * A DigitMap is deleted by supplying an empty value for a name that
EventsDescriptors specifying the name, including any EventsDescrip- Internet draft MEGACO Protocol February 8, 2000
tor in the command containing the DigitMap descriptor, shall use
the new one.
* A DigitMap is deleted by supplying an empty value for a name that
is already defined. Terminations presently using the digitmap shall is already defined. Terminations presently using the digitmap shall
continue to use the old definition. continue to use the old definition.
The collection of digits according to a DigitMap may be protected by The collection of digits according to a DigitMap may be protected by
three timers, viz. a start timer (T), short timer (S), and long timer three timers, viz. a start timer (T), short timer (S), and long timer
(L). (L).
1. The start timer (T) is used prior to any digits having been dialed. 1. The start timer (T) is used prior to any digits having been dialed.
2. If the Media Gateway can determine that at least one more digit is 2. If the Media Gateway can determine that at least one more digit is
needed for a digit string to match any of the allowed patterns in needed for a digit string to match any of the allowed patterns in
the digit map, then the interdigit timer value should be set to a the digit map, then the interdigit timer value should be set to a
long (L) duration (e.g.-16 seconds). long (L) duration (e.g.-16 seconds).
3. If the DigitMap specifies that a variable number of additional 3. If the digit string has matched one of the patterns in the digit
digits may be needed then the short timer (S) is used. map, but it
is possible that more digits could be received which would cause a
match
with a different pattern, then instead of reporting the match
immediately,
the MG must apply the short timer (S) and wait for more digits.
The timers are configurable parameters to a DigitMap. The Start timer The timers are configurable parameters to a DigitMap. The Start timer
is started at the beginning of every digit map use, but can be overrid- is started at the beginning of every digit map use, but can be overrid-
den. den.
The formal syntax of the digit map is described by the DigitMap rule in The formal syntax of the digit map is described by the DigitMap rule in
the formal syntax description of the protocol (see Annex A and Annex B). the formal syntax description of the protocol (see Annex A and Annex B).
A DigitMap, according to this syntax, is defined either by a string or A DigitMap, according to this syntax, is defined either by a string or
by a list of strings. Each string in the list is an alternative number- by a list of strings. Each string in the list is an alternative event
ing scheme, specified either as a set of digits or timers, or as regular sequence, specified either as a sequence of digit map symbols or as a
expression of digits and timers. Within a string, the digits "0" through regular expression of digit map symbols. These digit map symbols, the
"9" and letters "A" through a maximum value depending on the signalling digits "0" through "9" and letters "A" through a maximum value depending
system concerned, but never exceeding "K", correspond to specified on the signalling system concerned, but never exceeding "K", correspond
events within a package which has been designated in the Events Descrip- to specified events within a package which has been designated in the
tor on the termination to which the digit map is being applied. (The Events Descriptor on the termination to which the digit map is being
mapping between events and digit map symbols is defined in the documen- applied. (The mapping between events and digit map symbols is defined
tation for packages associated with channel-associated signalling sys- in the documentation for packages associated with channel-associated
tems such as DTMF, MF, or R2. Digits "0" through "9" MUST be mapped to signalling systems such as DTMF, MF, or R2. Digits "0" through "9" MUST
the corresponding digit events within the signalling system concerned. be mapped to the corresponding digit events within the signalling system
Letters should be allocated in logical fashion, facilitating the use of concerned. Letters should be allocated in logical fashion, facilitating
range notation for alternative events.) The letter "x" is used as a the use of range notation for alternative events.) The letter "x" is
wildcard, designating any event corresponding to symbols in the range used as a wildcard, designating any event corresponding to symbols in
"0"-"9". The string may also contain explicit ranges and, more gen- the range "0"-"9". The string may also contain explicit ranges and,
erally, explicit sets of symbols, designating alternative events any one more generally, explicit sets of symbols, designating alternative events
of which satisfies that position of the digit map. any one of which satisfies that position of the digit map. Finally, the
dot symbol "." stands for zero or more repetitions of the event selector
(event, range of events, set of alternative events, or wildcard) which
In addition to these event symbols, the string may contain "S" and "L" Internet draft MEGACO Protocol February 8, 2000
Internet draft MEGACO Protocol January 27, 2000 precedes it. As a consequence of the third timing rule above, inter-
event timing while matching the dot symbol uses the short timer.
duration modifiers. An "L" designates a long event: placed in front of In addition to these event symbols, the string may contain "L" duration
the symbol(s) designating the event(s) which satisfy a given digit posi- modifiers. An "L" designates a long event: placed in front of the
tion, it indicates that that position is satisfied only if the duration symbol(s) designating the event(s) which satisfy a given digit position,
of the event exceeds the long-duration threshold. The value of this it indicates that that position is satisfied only if the duration of the
threshold is assumed to be provisioned in the MG. A MG that detects event exceeds the long-duration threshold. The value of this threshold
digits, letters or timers while a DigitMap is active SHALL: is assumed to be provisioned in the MG.
1. Add the event parameter to the end of an internal state variable A digit map is active while the event descriptor which invoked it is
referred to as the "current dial string". active and it has not completed. A digit map completes when:
2. Apply the current dial string to the DigitMap, attempting a match * a timer has expired, or
to each regular expression in the DigitMap in lexical order.
3. If the result is under-qualified (partially matches at least one * an alternative event sequence has been matched and no other alter-
entry in the DigitMap), do nothing further. native event sequence in the digit map could be matched through
detection of an additional event (unambiguous match), or
4. If the result matches, or is over-qualified (i.e. no further digits * an event has been detected such that a match to a complete alterna-
could possibly produce a match), send the current dial string to tive event sequence of the digit map will be impossible no matter
the MGC in the digit string parameter of the completion event in what additional events are received.
the DTMF package (see section E.4.2).
Note that unexpected timer expiries, for example, can cause over- Upon completion, a digit map completion event as defined in the package
qualified matches. The MG shall clear the current dial string when providing the events being mapped into the digit map shall be generated.
starting a new dial plan specified in an events descriptor or embedded Pending completion, successive events shall be processed according to
events descriptor. the following rules:
The "current dial string", an internal variable, is initially empty. The
set of candidate alternative event sequences includes all of the alter-
natives specified in the digit map.
At each step, a timer is set to wait for the next event. The rules for
determining how long to wait are listed above. If the timer expires and
a member of the candidate set of alternatives is fully satisfied, a
timeout completion with full match is reported. If the timer expires and
part or none of any candidate alternative is satisfied, a timeout com-
pletion with partial match is reported.
If an event is detected before the timer expires, it is mapped to a igit
string symbol and added to the end of the current dial string. The dura-
tion of the event (long or not long) is noted if and only if this is
relevant in the current symbol position (because at least one of the
candidate alternative event sequences includes the "L" modifier at this
position in the sequence).
The current dial string is compared to the candidate alternative event
sequences, and any of these which do not match are discarded from the
Internet draft MEGACO Protocol February 8, 2000
candidate set. If a sequence expecting a long-duration event at this
position is matched (i.e. the event had long duration and met the
specification for this position), then any alternative event sequences
not specifying a long duration event at this position are discarded, and
the current dial string is modified by inserting an "L" in front of the
symbol representing the latest event. If no sequence expecting a long-
duration event at this position is matched, any such sequences are dis-
carded from the candidate set, but the observed event duration is
treated as irrelevant in assessing matches to the remaining candidates.
If exactly one candidate remains, a completion event is generated indi-
cating an unambiguous match. If no candidates remain, but one of the
candidates from the previous step was fully satisfied before the latest
event was detected, a completion event is generated indicating a full
match and an extra event. If no candidates remain and no candidate from
the previous step was fully satisfied before the latest event was
detected, a completion event is generated indicating a partial match and
an extra event. If multiple candidates remain, steps 1 through 4 are
repeated.
As an example, consider the following dial plan: As an example, consider the following dial plan:
_______________________________________________________ _______________________________________________________
| 0 | Local operator | | 0 | Local operator |
| 00 | Long distance operator | | 00 | Long distance operator |
| xxxx | Local extension number | | xxxx | Local extension number |
| 8xxxxxxx | Local number | | 8xxxxxxx | Local number |
| #xxxxxxx | Off-site extension | | #xxxxxxx | Off-site extension |
| *xx | Star services | | *xx | Star services |
| 91xxxxxxxxxx | Long distance number | | 91xxxxxxxxxx | Long distance number |
| 9011 + up to 15 digits | International number | | 9011 + up to 15 digits | International number |
|__________________________|___________________________| |__________________________|___________________________|
following digit map: If the DTMF detection package described in Annex E (section E.6) is used
to collect the dialed digits, then the dialing plan shown above results
in the following digit map:
(0S| 00S|[1-7]xLxx|8Lxxxxxxx|#xxxxxxx|*xx|9L1xxxxxxxxxx|9L011x.S) (0 | 00 | [1-7]xxx | 8xxxxxxx | Fxxxxxxx | Exx | 91xxxxxxxxxx | 9011x. )
7.1.15. Statistics Descriptor 7.1.15. Statistics Descriptor
The Statistics parameter provides information describing the status and The Statistics parameter provides information describing the status and
usage of a Termination during its existence within a specific Context. usage of a Termination during its existence within a specific Context.
Internet draft MEGACO Protocol January 27, 2000
There is a set of standard statistics kept for each termination where There is a set of standard statistics kept for each termination where
appropriate (number of octets sent and received for example). The par- appropriate (number of octets sent and received for example). The par-
ticular statistical properties that are reported for a given Termination ticular statistical properties that are reported for a given Termination
Internet draft MEGACO Protocol February 8, 2000
are determined by the Packages realized by the Termination. By default, are determined by the Packages realized by the Termination. By default,
statistics are reported when the Termination is Subtracted from the Con- statistics are reported when the Termination is Subtracted from the Con-
text. This behavior can be overridden by including an empty Audit- text. This behavior can be overridden by including an empty Audit-
Descriptor in the Subtract command. Statistics may also be returned Descriptor in the Subtract command. Statistics may also be returned
from the AuditValue command, or any Add/Move/Modify command using the from the AuditValue command, or any Add/Move/Modify command using the
Audit descriptor. Audit descriptor.
Statistics are cumulative; reporting Statistics does not reset them. Statistics are cumulative; reporting Statistics does not reset them.
Statistics are reset when a Termination is Subtracted from a Context. Statistics are reset when a Termination is Subtracted from a Context.
7.1.16. Packages Descriptor 7.1.16. Packages Descriptor
Used only with the AuditValue command, the PackageDescriptor returns a Used only with the AuditValue command, the PackageDescriptor returns a
list of Packages realized by the Termination. list of Packages realized by the Termination.
7.1.17. ObservedEvents Descriptor 7.1.17. ObservedEvents Descriptor
ObservedEvents is supplied with the Notify command to inform the MGC of ObservedEvents is supplied with the Notify command to inform the MGC of
which event(s) were detected. Used with the AuditValue command, the which event(s) were detected. Used with the AuditValue command, the
ObservedEventsDescriptor returns events in the event buffer which have ObservedEventsDescriptor returns events in the event buffer which have
not been Notified. ObservedEvents contains the RequestIdentifier of the not been Notified. In addition, if a digit map is active, the Obser-
EventsDescriptor that triggered the notification, the event(s) detected vedEventsDescriptor shall contain a digit map completion event as
and the detection time(s). If a Notify is sent as a result of a signal defined in the package whose events are being mapped. This event shall
completion, the ObservedEventsDescriptor contains the name of the signal show the contents of the current dial string at the time the audit
that completed and the time at which it completed. Detection times are request was processed. ObservedEvents contains the RequestIdentifier of
reported with a precision of hundredths of a second. Time is expressed the EventsDescriptor that triggered the notification, the event(s)
in UTC. detected and the detection time(s). Detection times are reported with a
precision of hundredths of a second. Time is expressed in UTC.
7.1.18. Topology Descriptor 7.1.18. Topology Descriptor
A topology descriptor is used specify flow directions between termina- A topology descriptor is used specify flow directions between termina-
tions in a Context. Contrary to the descriptors in previous sections, tions in a Context. Contrary to the descriptors in previous sections,
the topology descriptor applies to a Context instead of a Termination. the topology descriptor applies to a Context instead of a Termination.
The default topology of a Context is that each termination's transmis- The default topology of a Context is that each termination's transmis-
sion is received by all other terminations. The Topology Descriptor is sion is received by all other terminations. The Topology Descriptor is
optional to implement. optional to implement.
The Topology Descriptor occurs before the commands in an action. It is The Topology Descriptor occurs before the commands in an action. It is
possible to have an action containing only a Topology Descriptor, pro- possible to have an action containing only a Topology Descriptor, pro-
vided that the context to which the action applies already exists. vided that the context to which the action applies already exists.
A topology descriptor consists of a sequence of triples of the form (T1, A topology descriptor consists of a sequence of triples of the form (T1,
T2, association). T1 and T2 specify Terminations within the Context, T2, association). T1 and T2 specify Terminations within the Context,
possibly using the ALL or CHOOSE wildcard. The association specifies possibly using the ALL or CHOOSE wildcard. The association specifies
how media flows between these two Terminations as follows. how media flows between these two Terminations as follows.
Internet draft MEGACO Protocol January 27, 2000
* (T1, T2, isolate) means that the Terminations matching T2 do not * (T1, T2, isolate) means that the Terminations matching T2 do not
Internet draft MEGACO Protocol February 8, 2000
receive media from the Terminations matching T1, nor vice versa. receive media from the Terminations matching T1, nor vice versa.
* (T1, T2, oneway) means that the Terminations that match T2 receive * (T1, T2, oneway) means that the Terminations that match T2 receive
media from the Terminations matching T1, but not vice versa. In media from the Terminations matching T1, but not vice versa. In
this case use of the ALL wildcard such that there are Terminations this case use of the ALL wildcard such that there are Terminations
that match both T1 and T2 is not allowed. that match both T1 and T2 is not allowed.
* (T1, T2, bothway) means that the Terminations matching T2 receive * (T1, T2, bothway) means that the Terminations matching T2 receive
media from the Terminations matching T1, and vice versa. In this media from the Terminations matching T1, and vice versa. In this
case it is allowed to use wildcards such that there are Termina- case it is allowed to use wildcards such that there are Termina-
skipping to change at page 37, line 5 skipping to change at page 38, line 5
in the same action. An existing Termination that matches T1 or T2 in in the same action. An existing Termination that matches T1 or T2 in
the Context to which a Termination is added, is connected to the newly the Context to which a Termination is added, is connected to the newly
added Termination as specified by the topology descriptor. The default added Termination as specified by the topology descriptor. The default
association when a termination is not mentioned in the Topology descrip- association when a termination is not mentioned in the Topology descrip-
tor is bothway (if T3 is added to a context with T1 and T2 with topology tor is bothway (if T3 is added to a context with T1 and T2 with topology
(T3,T1,oneway) it will be connected bothway to T2). (T3,T1,oneway) it will be connected bothway to T2).
The figure below and the table following it show some examples of the The figure below and the table following it show some examples of the
effect of including topology descriptors in actions. effect of including topology descriptors in actions.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
Context 1 Context 2 Context 3 Context 1 Context 2 Context 3
+------------------+ +------------------+ +------------------+ +------------------+ +------------------+ +------------------+
| +----+ | | +----+ | | +----+ | | +----+ | | +----+ | | +----+ |
| | T2 | | | | T2 | | | | T2 | | | | T2 | | | | T2 | | | | T2 | |
| +----+ | | +----+ | | +----+ | | +----+ | | +----+ | | +----+ |
| ^ ^ | | ^ | | ^ | | ^ ^ | | ^ | | ^ |
| | | | | | | | | | | | | | | | | | | |
| +--+ +--+ | | +---+ | | +--+ | | +--+ +--+ | | +---+ | | +--+ |
| | | | | | | | | | | | | | | | | | | |
skipping to change at page 38, line 5 skipping to change at page 39, line 5
| | | | | | | | | | | | | | | | | | | |
| v | | v | | v v | | v | | v | | v v |
| +----+ +----+ | | +----+ +----+ | | +----+ +----+ | | +----+ +----+ | | +----+ +----+ | | +----+ +----+ |
| | T1 |<-->| T3 | | | | T1 |<-->| T3 | | | | T1 |<-->| T3 | | | | T1 |<-->| T3 | | | | T1 |<-->| T3 | | | | T1 |<-->| T3 | |
| +----+ +----+ | | +----+ +----+ | | +----+ +----+ | | +----+ +----+ | | +----+ +----+ | | +----+ +----+ |
+------------------+ +------------------+ +------------------+ +------------------+ +------------------+ +------------------+
1. T2, T3 oneway 2. T2, T3 bothway 3. T1, T2 bothway 1. T2, T3 oneway 2. T2, T3 bothway 3. T1, T2 bothway
Figure 4: Example topologies Figure 4: Example topologies
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
_______________________________________________________________________ _______________________________________________________________________
|Topology | Description | |Topology | Description |
|_________|____________________________________________________________| |_________|____________________________________________________________|
|1 |No topology descriptors. When no topology descriptors are | |1 |No topology descriptors. When no topology descriptors are |
| |included, all terminations have a both way connection to all| | |included, all terminations have a both way connection to all|
| |other terminations. | |_________|____________________________________________________________| | |other terminations. |
|_________|____________________________________________________________|
|2 |T1, T2, Isolated. Removes the connection between T1 and T2.| |2 |T1, T2, Isolated. Removes the connection between T1 and T2.|
| |T3 has a both way connection with both T1 and T2. | | |T3 has a both way connection with both T1 and T2. |
|_________|____________________________________________________________| |_________|____________________________________________________________|
|3 |T3, T2, oneway. A oneway connection from T3 to T2 (i.e. T2 | |3 |T3, T2, oneway. A oneway connection from T3 to T2 (i.e. T2 |
| |receives media flow from T3). A bothway connection between | | |receives media flow from T3). A bothway connection between |
| |T1 and T3. | | |T1 and T3. |
|_________|____________________________________________________________| |_________|____________________________________________________________|
|4 |T2, T3, oneway. A oneway connection between T2 to T3. | |4 |T2, T3, oneway. A oneway connection between T2 to T3. |
| |T1 and T3 remain bothway connected | | |T1 and T3 remain bothway connected |
|_________|____________________________________________________________| |_________|____________________________________________________________|
skipping to change at page 39, line 5 skipping to change at page 40, line 5
7.2.1. Add 7.2.1. Add
The Add Command adds a Termination to a Context. The Add Command adds a Termination to a Context.
TerminationID TerminationID
[,MediaDescriptor] [,MediaDescriptor]
[,ModemDescriptor] [,ModemDescriptor]
[,MuxDescriptor] [,MuxDescriptor]
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
[,EventsDescriptor] [,EventsDescriptor]
[,SignalsDescriptor] [,SignalsDescriptor]
[,DigitMapDescriptor] [,DigitMapDescriptor]
[,ObservedEventsDescriptor] [,ObservedEventsDescriptor]
[,EventBufferDescriptor] [,EventBufferDescriptor]
[,StatisticsDescriptor] [,StatisticsDescriptor]
[,PackagesDescriptor] [,PackagesDescriptor]
Add( TerminationID Add( TerminationID
[, MediaDescriptor] [, MediaDescriptor]
skipping to change at page 40, line 5 skipping to change at page 41, line 5
The EventsDescriptor parameter is optional. If present, it provides the The EventsDescriptor parameter is optional. If present, it provides the
list of events that should be detected on the Termination. list of events that should be detected on the Termination.
The SignalsDescriptor parameter is optional. If present, it provides The SignalsDescriptor parameter is optional. If present, it provides
the list of signals that should be applied to the Termination. the list of signals that should be applied to the Termination.
The DigitMapDescriptor parameter is optional. If present, defines a The DigitMapDescriptor parameter is optional. If present, defines a
DigitMap definition that may be used in an EventsDescriptor. DigitMap definition that may be used in an EventsDescriptor.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
The AuditDescriptor is optional. If present, the command will return The AuditDescriptor is optional. If present, the command will return
descriptors as specified in the AuditDescriptor. descriptors as specified in the AuditDescriptor.
All descriptors that can be modified could be returned by MG if a param- All descriptors that can be modified could be returned by MG if a param-
eter was underspecified or overspecified. ObservedEvents, Statistics, eter was underspecified or overspecified. ObservedEvents, Statistics,
and Packages, and the EventBuffer Descriptors are returned only if and Packages, and the EventBuffer Descriptors are returned only if
requested in the AuditDescriptor. Add SHALL NOT be used on a Termina- requested in the AuditDescriptor. Add SHALL NOT be used on a Termina-
tion with a serviceState of "OutofService". tion with a serviceState of "OutofService".
skipping to change at page 41, line 5 skipping to change at page 42, line 5
appropriate for some operations. If the wildcard matches more than one appropriate for some operations. If the wildcard matches more than one
TerminationID, all possible matches are attempted, with results reported TerminationID, all possible matches are attempted, with results reported
for each one. The order of attempts when multiple TerminationIDs match for each one. The order of attempts when multiple TerminationIDs match
is not specified. The CHOOSE option is an error, as the Modify command is not specified. The CHOOSE option is an error, as the Modify command
may only be used on existing Terminations. may only be used on existing Terminations.
The remaining parameters to Modify are the same as those to Add. Possi- The remaining parameters to Modify are the same as those to Add. Possi-
ble return values are the same as those to Add. Modify SHALL NOT be ble return values are the same as those to Add. Modify SHALL NOT be
used on a Termination with a serviceState of "OutofService". used on a Termination with a serviceState of "OutofService".
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
7.2.3. Subtract 7.2.3. Subtract
The Subtract Command disconnects a Termination from its Context and The Subtract Command disconnects a Termination from its Context and
returns statistics on the Termination's participation in the Context. returns statistics on the Termination's participation in the Context.
TerminationID TerminationID
[,MediaDescriptor] [,MediaDescriptor]
[,ModemDescriptor] [,ModemDescriptor]
[,MuxDescriptor] [,MuxDescriptor]
skipping to change at page 42, line 5 skipping to change at page 43, line 5
Terminations'Termination's or Terminations' existence in the Context Terminations'Termination's or Terminations' existence in the Context
from which it or they are being subtracted. from which it or they are being subtracted.
The AuditDescriptor is optional. If present, the command will return The AuditDescriptor is optional. If present, the command will return
descriptors as specified in the AuditDescriptor. Possible return descriptors as specified in the AuditDescriptor. Possible return
values are the same as those to Add. values are the same as those to Add.
When a provisioned Termination is Subtracted from a context, its pro- When a provisioned Termination is Subtracted from a context, its pro-
perty values shall revert to: perty values shall revert to:
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
* The default value, if specified for the property and not overridden * The default value, if specified for the property and not overridden
by provisioning or modification within the null context by provisioning or modification within the null context
* The provisioned value, if not overridden by modification in the * The provisioned value, if not overridden by modification in the
null context null context
* The last value set by a modification while the termination was in * The last value set by a modification while the termination was in
the null context. the null context.
skipping to change at page 43, line 5 skipping to change at page 44, line 5
The TerminationID specifies the Termination to be moved. It may be The TerminationID specifies the Termination to be moved. It may be
wildcarded. If the wildcard matches more than one TerminationID, all wildcarded. If the wildcard matches more than one TerminationID, all
possible matches are attempted, with results reported for each one. The possible matches are attempted, with results reported for each one. The
order of attempts when multiple TerminationIDs match is not specified. order of attempts when multiple TerminationIDs match is not specified.
By convention, the Termination is subtracted from its previous Context. By convention, the Termination is subtracted from its previous Context.
The Context to which the Termination is moved is indicated by the target The Context to which the Termination is moved is indicated by the target
ContextId in the Action. If the last remaining Termination is moved out ContextId in the Action. If the last remaining Termination is moved out
of a Context, the Context is deleted. of a Context, the Context is deleted.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
The remaining descriptors are processed as in the Modify Command. The The remaining descriptors are processed as in the Modify Command. The
AuditDescriptor with the Statistics option, for example, would return AuditDescriptor with the Statistics option, for example, would return
statistics on the Termination just prior to the Move. Possible descrip- statistics on the Termination just prior to the Move. Possible descrip-
tors returned from Move are the same as for Add. Move SHALL NOT be used tors returned from Move are the same as for Add. Move SHALL NOT be used
on a Termination with a serviceState of "OutofService". on a Termination with a serviceState of "OutofService".
7.2.5. AuditValue 7.2.5. AuditValue
The AuditValue Command returns the current values of properties, events, The AuditValue Command returns the current values of properties, events,
skipping to change at page 44, line 5 skipping to change at page 45, line 5
instances of a descriptor are defined to be alternate values supported, instances of a descriptor are defined to be alternate values supported,
with each parameter in a descriptor considered independent. with each parameter in a descriptor considered independent.
ObservedEvents returns a list of events in the EventBuffer, Packages- ObservedEvents returns a list of events in the EventBuffer, Packages-
Descriptor returns a list of packages realized by the Termination. Descriptor returns a list of packages realized by the Termination.
DigitMapDescriptor returns the name or value of the current DigitMap for DigitMapDescriptor returns the name or value of the current DigitMap for
the Termination. DigitMap applied to the root Termination returns all the Termination. DigitMap applied to the root Termination returns all
named DigitMaps in the gateway. Statistics returns the current values named DigitMaps in the gateway. Statistics returns the current values
of all statistics being kept on the Termination. Specifying an empty of all statistics being kept on the Termination. Specifying an empty
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
Audit Descriptor results in only the TerminationID being returned. This Audit Descriptor results in only the TerminationID being returned. This
may be useful to get a list of TerminationIDs when used with wildcard. may be useful to get a list of TerminationIDs when used with wildcard.
AuditValue results depend on the Context, viz. specific, null, or AuditValue results depend on the Context, viz. specific, null, or wild-
unspecified. The TerminationID may be specific, or wildcarded. carded. The TerminationID may be specific, or wildcarded.
The following illustrates other information that can be obtained with The following illustrates other information that can be obtained with
the Audit Command: the Audit Command:
________________________________________________________________________ ________________________________________________________________________
|ContextID |TerminationID| Information Obtained | |ContextID |TerminationID| Information Obtained |
|Specific | wildcard |Audit of matching Terminations in a Context| |Specific | wildcard |Audit of matching Terminations in a Context|
|Specific | specific |Audit of a single Termination in a Context | |Specific | specific |Audit of a single Termination in a Context |
|Null | Root |Audit of Media Gateway state and events | |Null | Root |Audit of Media Gateway state and events |
|Null | wildcard |Audit of all matching Terminations | |Null | wildcard |Audit of all matching Terminations |
skipping to change at page 45, line 5 skipping to change at page 46, line 5
AuditCapabilities(TerminationID, AuditCapabilities(TerminationID,
AuditDescriptor) AuditDescriptor)
The appropriate descriptors, with the possible values for the Termina- The appropriate descriptors, with the possible values for the Termina-
tion are returned from AuditCapabilities. Descriptors may be repeated tion are returned from AuditCapabilities. Descriptors may be repeated
where there are multiple possible values. values. If a wildcarded where there are multiple possible values. values. If a wildcarded
response is requested, only one command return is generated, with the response is requested, only one command return is generated, with the
contents containing the union of the values of all Terminations matching contents containing the union of the values of all Terminations matching
the wildcard. This convention may reduce the volume of data required to the wildcard. This convention may reduce the volume of data required to
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
audit a group of Terminations. audit a group of Terminations.
Interpretation of what capabilities are requested for various values of Interpretation of what capabilities are requested for various values of
ContextID and TerminationID is the same as in AuditValue. ContextID and TerminationID is the same as in AuditValue.
The EventsDescriptor returns the list of possible events on the Termina- The EventsDescriptor returns the list of possible events on the Termina-
tion together with the list of all possible values for the tion together with the list of all possible values for the
EventsDescriptor Parameters. The SignalsDescriptor returns the list of EventsDescriptor Parameters. The SignalsDescriptor returns the list of
possible signals that could be applied to the Termination together with possible signals that could be applied to the Termination together with
skipping to change at page 45, line 39 skipping to change at page 46, line 39
The TerminationID parameter specifies the Termination issuing the Notify The TerminationID parameter specifies the Termination issuing the Notify
Command. The TerminationID shall be a fully qualified name. Command. The TerminationID shall be a fully qualified name.
The ObservedEventsDescriptor contains the RequestID and a list of events The ObservedEventsDescriptor contains the RequestID and a list of events
that the Media Gateway detected in the order that they were detected. that the Media Gateway detected in the order that they were detected.
Each event in the list is accompanied by parameters associated with the Each event in the list is accompanied by parameters associated with the
event and an indication of the time that the event was detected. Notify event and an indication of the time that the event was detected. Notify
Commands shall occur only as the result of detection of an event speci- Commands shall occur only as the result of detection of an event speci-
fied by an Events Descriptor which is active on the termination con- fied by an Events Descriptor which is active on the termination con-
cerned, or as a result of completion of a signal for which the MGC cerned.
requested notification of completion.
The RequestID returns the RequestID parameter of the EventsDescriptor The RequestID returns the RequestID parameter of the EventsDescriptor
that triggered the Notify Command. It is used to correlate the notifi- that triggered the Notify Command. It is used to correlate the notifi-
cation with the request that triggered it. The events in the list must cation with the request that triggered it. The events in the list must
have been requested via the triggering EventsDescriptor, embedded events have been requested via the triggering EventsDescriptor or embedded
descriptor or the triggering SignalsDescriptor. EventsDescriptor.
A Notify triggered by completion of a signal, contains the corresponding
signal name in the ObservedEventsDescriptor.
7.2.8. ServiceChange 7.2.8. ServiceChange
The ServiceChange Command allows the Media Gateway to notify the Media The ServiceChange Command allows the Media Gateway to notify the Media
Internet draft MEGACO Protocol January 27, 2000
Gateway Controller that a Termination or group of Terminations is about Gateway Controller that a Termination or group of Terminations is about
to be taken out of service or has just been returned to service. The to be taken out of service or has just been returned to service. The
Media Gateway Controller may indicate that Termination(s) shall be taken Media Gateway Controller may indicate that Termination(s) shall be taken
out of or returned to service. The Media Gateway may notify the MGC out of or returned to service. The Media Gateway may notify the MGC
Internet draft MEGACO Protocol February 8, 2000
that the capability of a Termination has changed. It also allows a MGC that the capability of a Termination has changed. It also allows a MGC
to hand over control of a MG to another MGC. to hand over control of a MG to another MGC.
[ServiceChangeDescriptor] TerminationID
[ServiceChangeReplyDescriptor]
ServiceChange(TerminationID, ServiceChange(TerminationID,
ServiceChangeDescriptor ServiceChangeDescriptor
) )
The TerminationID parameter specifies the Termination(s) that are taken The TerminationID parameter specifies the Termination(s) that are taken
out of or returned to service. Wildcarding of Termination names is per- out of or returned to service. Wildcarding of Termination names is per-
mitted, with the exception that the CHOOSE mechanism shall not be used. mitted, with the exception that the CHOOSE mechanism shall not be used.
Use of the "Root" TerminationID indicates a ServiceChange affecting the Use of the "Root" TerminationID indicates a ServiceChange affecting the
entire Media Gateway. entire Media Gateway.
skipping to change at page 46, line 36 skipping to change at page 47, line 33
required: required:
* ServiceChangeMethod * ServiceChangeMethod
* ServiceChangeReason * ServiceChangeReason
* ServiceChangeDelay * ServiceChangeDelay
* ServiceChangeAddress * ServiceChangeAddress
* Profile * ServiceChangeProfile
* Version * ServiceChangeVersion
* MGCIdToTry * ServiceChangeMGCId
* TimeStamp * TimeStamp
The ServiceChangeMethod parameter specifies the type of ServiceChange The ServiceChangeMethod parameter specifies the type of ServiceChange
that will or has occurred: that will or has occurred:
1) Graceful - indicates that the specified Terminations will be taken 1) Graceful - indicates that the specified Terminations will be taken
out of service after the specified ServiceChangeDelay; established out of service after the specified ServiceChangeDelay; established
connections are not yet affected, but the Media Gateway Controller connections are not yet affected, but the Media Gateway Controller
should refrain from establishing new connections and should attempt should refrain from establishing new connections and should attempt
to gracefully tear down existing connections. The MG should set to gracefully tear down existing connections. The MG should set
termination serviceState to "test" until the expiry of Servi- termination serviceState to "test" until the expiry of Servi-
ceChangeDelay or the removal of the termination from an active ceChangeDelay or the removal of the termination from an active con-
text (whichever is first), then set it to "out of service".
Internet draft MEGACO Protocol January 27, 2000 2) Forced - indicates that the specified Terminations were taken
context (whichever is first), then set it to "out of service". Internet draft MEGACO Protocol February 8, 2000
2) Forced - indicates that the specified Terminations were taken
abruptly out of service and any established connections associated abruptly out of service and any established connections associated
with them were lost. The MGC is responsible for cleaning up the with them were lost. The MGC is responsible for cleaning up the
context (if any) with which the failed termination is associated. context (if any) with which the failed termination is associated.
At a minimum the termination shall be subtracted from the context. At a minimum the termination shall be subtracted from the context.
The termination serviceState should be "out of service". The termination serviceState should be "out of service".
3) Restart - indicates that service will be restored on the specified 3) Restart - indicates that service will be restored on the specified
Terminations after expiration of the ServiceChangeDelay. The ser- Terminations after expiration of the ServiceChangeDelay. The ser-
viceState should be set to "inService" upon expiry of Servi- viceState should be set to "inService" upon expiry of Servi-
ceChangeDelay. ceChangeDelay.
4) Disconnected - always applied with the Root TerminationID, indi- 4) Disconnected - always applied with the Root TerminationID, indi-
cates that the MG lost communication with the MGC, but it was sub- cates that the MG lost communication with the MGC, but it was sub-
sequently restored. Since MG state may have changed, the MGC may sequently restored. Since MG state may have changed, the MGC may
wish to use the Audit command to resynchronize its state with the wish to use the Audit command to resynchronize its state with the
MG's. MG's.
5) Handoff - sent from the MGC to the MG, this reason indicates that 5) Handoff - sent from the MGC to the MG, this reason indicates that
the MGC is going out of service and a new MGC association must be the MGC is going out of service and a new MGC association must be
established. established. Sent from the MG to the MGC, this indicates that the
MG is attempting to establish a new association in accordance with
a Handoff received from the MGC with which it was previously asso-
ciated.
6) Failover - sent from MG to MGC to indicate the primary MG is out of 6) Failover - sent from MG to MGC to indicate the primary MG is out of
service and a secondary MG is taking over, and sent from MG to service and a secondary MG is taking over, and sent from MG to
(new) MGC in response to the MG having received a ServiceChange (new) MGC in response to the MG having received a ServiceChange
with ServiceChangeMethod equal to Handoff. with ServiceChangeMethod equal to Handoff.
7) Another value whose meaning is mutually understood between the MG
and the MGC.
The ServiceChangeReason parameter specifies the reason why the Servi- The ServiceChangeReason parameter specifies the reason why the Servi-
ceChange has or will occur. It consists of an alphanumeric token (IANA ceChange has or will occur. It consists of an alphanumeric token (IANA
registered) and an explanatory string. registered) and an explanatory string.
The optional ServiceChangeAddress parameter specifies the address (e.g., The optional ServiceChangeAddress parameter specifies the address (e.g.,
IP port number for IP networks) to be used for subsequent communica- IP port number for IP networks) to be used for subsequent communica-
tions. It can be specified in the input parameter descriptor or the tions. It can be specified in the input parameter descriptor or the
returned result descriptor. returned result descriptor. ServiceChangeAddress and ServiceChangeMgcId
parameters shall not both be present in the ServiceChangeDescriptor or
the ServiceChangeResultDescriptor. The ServiceChangeAddress provides an
address to be used within the context of the association currently being
negotiated, while the ServiceChangeMgcId provides an alternate address
where the MG should seek to establish another association.
The optional ServiceChangeDelay parameter is expressed in seconds. If The optional ServiceChangeDelay parameter is expressed in seconds. If
the delay is absent or set to zero, the delay value should be considered the delay is absent or set to zero, the delay value should be considered
Internet draft MEGACO Protocol February 8, 2000
to be null. In the case of a "graceful" ServiceChangeMethod, a null to be null. In the case of a "graceful" ServiceChangeMethod, a null
delay indicates that the Media Gateway Controller should wait for the delay indicates that the Media Gateway Controller should wait for the
natural removal of existing connections and should not establish new natural removal of existing connections and should not establish new
connections. . For "graceful" only, null delay means the MG should set connections. . For "graceful" only, null delay means the MG should set
serviceState to "test" immediately, then wait indefinitely for the ter- serviceState to "test" immediately, then wait indefinitely for the ter-
mination to be removed from any active context before setting service- mination to be removed from any active context before setting service-
State to "out of service". For "restart", null means immediate return State to "out of service". For "restart", null means immediate return
to service. to service.
Internet draft MEGACO Protocol January 27, 2000 The optional ServiceChangeProfile parameter specifies the Profile (if
any) of the protocol supported. The ServiceChangeProfile includes the
The optional Profile parameter specifies the Profile (if any) of the version of the profile supported.
protocol supported. The Profile includes the version of the profile
supported.
The optional Version parameter contains the protocol version and is used The optional ServiceChangeVersion parameter contains the protocol ver-
if protocol version negotiation occurs (see section 11.3). sion and is used if protocol version negotiation occurs (see section
11.3).
The optional TimeStamp parameter specifies the actual time as kept by The optional TimeStamp parameter specifies the actual time as kept by
the sender. It can be used by the responder to determine how its notion the sender. It can be used by the responder to determine how its notion
of time differs from that of its correspondent. TimeStamp is sent with a of time differs from that of its correspondent. TimeStamp is sent with a
precision of hundredths of a second, and is expressed in UTC. precision of hundredths of a second, and is expressed in UTC.
The optional Extension parameter may contain any value whose meaning is
mutually understood by the MG and MGC.
A ServiceChange Command specifying the "Root" for the TerminationID and A ServiceChange Command specifying the "Root" for the TerminationID and
ServiceChangeMethod equal to Restart is a registration command by which ServiceChangeMethod equal to Restart is a registration command by which
a Media Gateway announces its existence to the Media Gateway Controller. a Media Gateway announces its existence to the Media Gateway Controller.
The Media Gateway is expected to be provisioned with the name of one The Media Gateway is expected to be provisioned with the name of one
primary and optionally some number of alternate Media Gateway Controll- primary and optionally some number of alternate Media Gateway Controll-
ers. Acknowledgement of the ServiceChange Command completes the ers.
registration process. The MG may specify the transport ServiceChangeAd- Acknowledgement of the ServiceChange Command completes the registra-
dress to be used by the MGC for sending messages in the ServiceChangeAd- tion process. The MG may specify an address in the ServiceChangeAddress
dress parameter in the input ServiceChangeDescriptor. The MGC shall use parameter of the ServiceChange request, and the MGC may also do so in
this Address, if specified, in its response to the ServiceChange command the ServiceChange reply. In either case, the recipient must use the
and any subsequent commands and responses. The MGC may specify the Ser- supplied address as the destination for all subsequent transaction
viceChangeAddress for the MG to use in the returned result Servi- requests within the association. At the same time, as indicated in sec-
ceDescriptor. The MG shall use this address for any subsequent communi- tion 9, transaction replies and pending indications must be sent to the
cation with the MGC. The TimeStamp parameter shall be sent with a address from which the corresponding requests originated. This must be
done even if it implies extra messaging because commands and responses
cannot be packed together. The TimeStamp parameter shall be sent with a
registration command and its response. registration command and its response.
The Media Gateway Controller may return an MGCIdToTry parameter that The Media Gateway Controller may return a ServiceChangeMGCId parameter
describes the Media Gateway Controller that should preferably be con- that describes the Media Gateway Controller that should preferably be
tacted for further service by the Media Gateway. In this case the Media contacted for further service by the Media Gateway. In this case the
Gateway shall reissue the ServiceChange command to the new Media Gateway Media Gateway shall reissue the ServiceChange command to the new Media
Controller. The Gateway specified in an MGCIdToTry, if provided, shall Gateway Controller. The Gateway specified in a ServiceChangeMGCId, if
be contacted before any further alternate MGCs. On a HandOff message
from MGC to MG, the MGCIdToTry is the new MGC that will take over from
the current MGC.
Summarizing use of properties in the ServiceChange Descriptor:
* ServiceChangeMethod mandatory in all cases.
* ServiceChangeReason mandatory in all cases.
* ServiceChangeDelay mandatory if ServiceChangeMethod is "Graceful"
or "Restart", otherwise not allowed.
* ServiceChangeAddress mandatory when the terminationID is ROOT, oth- Internet draft MEGACO Protocol February 8, 2000
erwise not allowed.
Internet draft MEGACO Protocol January 27, 2000 provided, shall be contacted before any further alternate MGCs. On a
HandOff message from MGC to MG, the ServiceChangeMGCId is the new MGC
that will take over from the current MGC.
* Profile required if terminationID is ROOT, optional otherwise. The return from ServiceChange is empty except when the Root termina-
tionID is used. In that case it includes the following parameters as
required:
* Version as specified in section 11.3. * ServiceChangeAddress, if the responding MGC wishes to specify an
new destination for messages from the MG for the remainder of the
association;
* MGCIdToTry optional if the message comes from MGC and terminationID * ServiceChangeMgcId, if the responding MGC does not wish to sustain
is ROOT, not allowed otherwise. an association with the MG;
* TimeStamp mandatory when terminationID is ROOT, optional otherwise. * ServiceChangeProfile, if the responder wishes to negotiate the pro-
file to be used for the association;
The return from ServiceChange has the same parameters as the input * ServiceChangeVersion, if the responder wishes to negotiate the ver-
except that ServiceChangeMethod and ServiceChangeReason are optional. sion of the protocol to be used for the association.
If provided they shall be the same as those specified in the command.
The following ServiceChangeReasons are defined. This list may be The following ServiceChangeReasons are defined. This list may be
extended by an IANA registration as outlined in section 13.3 extended by an IANA registration as outlined in section 13.3
900 Service Restored 900 Service Restored
901 MG Cold Boot 901 MG Cold Boot
902 MG Warm Boot 902 MG Warm Boot
903 MGC Directed Change 903 MGC Directed Change
904 Termination malfunctioning 904 Termination malfunctioning
905 Termination taken out of service 905 Termination taken out of service
skipping to change at page 49, line 47 skipping to change at page 51, line 5
913 Signal Capability Failure 913 Signal Capability Failure
914 Event Capability Failure 914 Event Capability Failure
915 State Loss 915 State Loss
7.2.9. Manipulating and Auditing Context Attributes 7.2.9. Manipulating and Auditing Context Attributes
The commands of the protocol as discussed in the preceding sections The commands of the protocol as discussed in the preceding sections
apply to terminations. This section specifies how contexts are manipu- apply to terminations. This section specifies how contexts are manipu-
lated and audited. lated and audited.
Internet draft MEGACO Protocol February 8, 2000
Commands are grouped into actions (see section 8). An action applies to Commands are grouped into actions (see section 8). An action applies to
one context. In addition to commands, it may contain context manipula- one context. In addition to commands, it may contain context manipula-
tion and auditing instructions. tion and auditing instructions.
An action request sent to a MG may include a request to audit attributes An action request sent to a MG may include a request to audit attributes
of a context. An action may also include a request to change the attri- of a context. An action may also include a request to change the attri-
butes of a context. butes of a context.
Internet draft MEGACO Protocol January 27, 2000
The context properties that may be included in an action reply are used The context properties that may be included in an action reply are used
to return information to a MGC. This can be information requested by an to return information to a MGC. This can be information requested by an
audit of context attributes or details of the effect of manipulation of audit of context attributes or details of the effect of manipulation of
a context. a context.
If a MG receives an action which contains both a request to audit con- If a MG receives an action which contains both a request to audit con-
text attributes and a request to manipulate those attributes, the text attributes and a request to manipulate those attributes, the
response SHALL include the values of the attributes after processing the response SHALL include the values of the attributes after processing the
manipulation request. manipulation request.
skipping to change at page 50, line 47 skipping to change at page 52, line 4
When a MG reports an error to a MGC, it does so in an error descriptor. When a MG reports an error to a MGC, it does so in an error descriptor.
An error descriptor consists of an error code and optionally the associ- An error descriptor consists of an error code and optionally the associ-
ated explanatory string. ated explanatory string.
The identified error codes are: The identified error codes are:
400 - Bad Request 400 - Bad Request
401 - Protocol Error 401 - Protocol Error
402 - Unauthorized 402 - Unauthorized
Internet draft MEGACO Protocol February 8, 2000
403 - Syntax Error in Transaction 403 - Syntax Error in Transaction
404 - Syntax Error in TransactionReply 404 - Syntax Error in TransactionReply
405 - Syntax Error in TransactionPending 405 - Syntax Error in TransactionPending
406 - Version Not Supported 406 - Version Not Supported
410 - Incorrect identifier 410 - Incorrect identifier
411 - The transaction refers to an unknown ContextId 411 - The transaction refers to an unknown ContextId
412 - No ContextIDs available 412 - No ContextIDs available
421 - Unknown action or illegal combination of actions 421 - Unknown action or illegal combination of actions
Internet draft MEGACO Protocol January 27, 2000
422 - Syntax Error in Action 422 - Syntax Error in Action
430 - Unknown TerminationID 430 - Unknown TerminationID
431 - No TerminationID matched a wildcard 431 - No TerminationID matched a wildcard
432 - Out of TerminationIDs or No TerminationID available 432 - Out of TerminationIDs or No TerminationID available
433 - TerminationID is already in a Context 433 - TerminationID is already in a Context
440 - Unsupported or unknown Package 440 - Unsupported or unknown Package
441 - Missing RemoteDescriptor 441 - Missing RemoteDescriptor
442 - Syntax Error in Command 442 - Syntax Error in Command
443 - Unsupported or Unknown Command 443 - Unsupported or Unknown Command
444 - Unsupported or Unknown Descriptor 444 - Unsupported or Unknown Descriptor
skipping to change at page 51, line 47 skipping to change at page 53, line 4
500 - Internal Gateway Error 500 - Internal Gateway Error
501 - Not Implemented 501 - Not Implemented
502 - Not ready. 502 - Not ready.
503 - Service Unavailable 503 - Service Unavailable
504 - Command Received from unauthorized entity 504 - Command Received from unauthorized entity
505 - Command Received before Restart Response 505 - Command Received before Restart Response
510 - Insufficient resources 510 - Insufficient resources
512 - Media Gateway unequipped to detect requested Event 512 - Media Gateway unequipped to detect requested Event
513 - Media Gateway unequipped to generate requested Signals 513 - Media Gateway unequipped to generate requested Signals
514 - Media Gateway cannot send the specified announcement 514 - Media Gateway cannot send the specified announcement
Internet draft MEGACO Protocol February 8, 2000
515 - Unsupported Media Type 515 - Unsupported Media Type
517 - Unsupported or invalid mode 517 - Unsupported or invalid mode
518 - Event buffer full 518 - Event buffer full
519 - Out of space to store digit map 519 - Out of space to store digit map
520 - Media Gateway does not have a digit map 520 - Media Gateway does not have a digit map
521 - Termination is "ServiceChangeing" 521 - Termination is "ServiceChangeing"
526 - Insufficient bandwidth 526 - Insufficient bandwidth
529 - Internal hardware failure 529 - Internal hardware failure
Internet draft MEGACO Protocol January 27, 2000
530 - Temporary Network failure 530 - Temporary Network failure
531 - Permanent Network failure 531 - Permanent Network failure
581 - Does Not Exist 581 - Does Not Exist
8. TRANSACTIONS 8. TRANSACTIONS
Commands between the Media Gateway Controller and the Media Gateway are Commands between the Media Gateway Controller and the Media Gateway are
grouped into Transactions, each of which is identified by a Transac- grouped into Transactions, each of which is identified by a Transac-
tionID. Transactions consist of one or more Actions. An Action con- tionID. Transactions consist of one or more Actions. An Action con-
sists of a series of Commands that are limited to operating within a sists of a series of Commands that are limited to operating within a
skipping to change at page 52, line 46 skipping to change at page 54, line 4
| | +---------+ | | | | +---------+ | |
| | | Command | | | | | | Command | | |
| | | 1 | | | | | | 1 | | |
| | +---------+ | | | | +---------+ | |
| +----------------------------------------------------+ | | +----------------------------------------------------+ |
| | | |
| +----------------------------------------------------+ | | +----------------------------------------------------+ |
| | Action 3 | | | | Action 3 | |
| | +---------+ +---------+ +---------+ | | | | +---------+ +---------+ +---------+ | |
| | | Command | | Command | | Command | | | | | | Command | | Command | | Command | | |
Internet draft MEGACO Protocol February 8, 2000
| | | 1 | | 2 | | 3 | | | | | | 1 | | 2 | | 3 | | |
| | +---------+ +---------+ +---------+ | | | | +---------+ +---------+ +---------+ | |
| +----------------------------------------------------+ | | +----------------------------------------------------+ |
+----------------------------------------------------------+ +----------------------------------------------------------+
Figure 5 Transactions, Actions and Commands Figure 5 Transactions, Actions and Commands
Transactions are presented as TransactionRequests. Corresponding Transactions are presented as TransactionRequests. Corresponding
Internet draft MEGACO Protocol January 27, 2000
responses to a TransactionRequest are received in a single reply, possi- responses to a TransactionRequest are received in a single reply, possi-
bly preceded by a number of TransactionPending messages (see section bly preceded by a number of TransactionPending messages (see section
8.2.3). 8.2.3).
Transactions guarantee ordered Command processing. That is, Commands Transactions guarantee ordered Command processing. That is, Commands
within a Transaction are executed sequentially. Ordering of Transactions within a Transaction are executed sequentially. Ordering of Transactions
is NOT guaranteed - transactions may be executed in any order, or simul- is NOT guaranteed - transactions may be executed in any order, or simul-
taneously. taneously.
At the first failing Command in a Transaction, processing of the remain- At the first failing Command in a Transaction, processing of the remain-
skipping to change at page 53, line 28 skipping to change at page 54, line 35
carded TerminationID, the command is attempted with each of the actual carded TerminationID, the command is attempted with each of the actual
TerminationIDs matching the wildcard. A response within the Transac- TerminationIDs matching the wildcard. A response within the Transac-
tionReply is included for each matching TerminationID, even if one or tionReply is included for each matching TerminationID, even if one or
more instances generated an error. If any TerminationID matching a more instances generated an error. If any TerminationID matching a
wildcard results in an error when executed, any commands following the wildcard results in an error when executed, any commands following the
wildcarded command are not attempted. Commands may be marked as wildcarded command are not attempted. Commands may be marked as
"Optional" which can override this behaviour - if a command marked as "Optional" which can override this behaviour - if a command marked as
Optional results in an error, subsequent commands in the Transaction Optional results in an error, subsequent commands in the Transaction
will be executed. will be executed.
A TransactionReply includes the return values for all of the Commands in The TransactionReply includes the return values for the Commands that
the corresponding TransactionRequest. The TransactionReply includes the were executed successfully, and the Command and error descriptor for any
return values for the Commands that were executed successfully, and the Command that failed. TransactionPending is used to periodically notify
Command and error descriptor for any Command that failed. Transaction- the receiver that a Transaction has not completed yet, but is actively
Pending is used to periodically notify the receiver that a Transaction being processed.
has not completed yet, but is actively being processed.
Applications SHOULD implement an application level timer per transac- Applications SHOULD implement an application level timer per transac-
tion. Expiration of the timer should cause a retransmission of the tion. Expiration of the timer should cause a retransmission of the
request. Receipt of a Reply should cancel the timer. Receipt of Pending request. Receipt of a Reply should cancel the timer. Receipt of Pending
should restart the timer. should restart the timer.
8.1. Common Parameters 8.1. Common Parameters
8.1.1. Transaction Identifiers 8.1.1. Transaction Identifiers
Transactions are identified by a TransactionID, which is assigned by Transactions are identified by a TransactionID, which is assigned by
sender and is unique within the scope of the sender. sender and is unique within the scope of the sender.
Internet draft MEGACO Protocol February 8, 2000
8.1.2. Context Identifiers 8.1.2. Context Identifiers
Contexts are identified by a ContextID, which is assigned by the Media Contexts are identified by a ContextID, which is assigned by the Media
Gateway and is unique within the scope of the Media Gateway. The Media Gateway and is unique within the scope of the Media Gateway. The Media
Gateway Controller shall use the ContextID supplied by the Media Gateway Gateway Controller shall use the ContextID supplied by the Media Gateway
in all subsequent Transactions relating to that Context. The protocol in all subsequent Transactions relating to that Context. The protocol
makes reference to a distinguished value that may be used by the Media makes reference to a distinguished value that may be used by the Media
Internet draft MEGACO Protocol January 27, 2000
Gateway Controller when referring to a Termination that is currently not Gateway Controller when referring to a Termination that is currently not
associated with a Context, namely the null ContextID. associated with a Context, namely the null ContextID.
The CHOOSE wildcard is used to request that the Media Gateway create a The CHOOSE wildcard is used to request that the Media Gateway create a
new Context. The MGC shall not use partially specified ContextIDs con- new Context. The MGC shall not use partially specified ContextIDs con-
taining the CHOOSE wildcard. The MGC may use the ALL wildcard to taining the CHOOSE wildcard. The MGC may use the ALL wildcard to
address all Contexts on the MG. address all Contexts on the MG.
8.2. Transaction Application Programming Interface 8.2. Transaction Application Programming Interface
skipping to change at page 54, line 48 skipping to change at page 56, line 5
with the TransactionReply or TransactionPending response from the with the TransactionReply or TransactionPending response from the
receiver. receiver.
The ContextID parameter must specify a value to pertain to all Commands The ContextID parameter must specify a value to pertain to all Commands
that follow up to either the next specification of a ContextID parameter that follow up to either the next specification of a ContextID parameter
or the end of the TransactionRequest, whichever comes first. or the end of the TransactionRequest, whichever comes first.
The Command parameter represents one of the Commands mentioned in the The Command parameter represents one of the Commands mentioned in the
"Command Details" subsection titled "Application Programming Interface". "Command Details" subsection titled "Application Programming Interface".
Internet draft MEGACO Protocol February 8, 2000
8.2.2. TransactionReply 8.2.2. TransactionReply
The TransactionReply is invoked by the receiver. There is one reply The TransactionReply is invoked by the receiver. There is one reply
invocation per transaction. A reply contains one or more Actions, each invocation per transaction. A reply contains one or more Actions, each
of which must specify its target Context and one or more Responses per of which must specify its target Context and one or more Responses per
Context. Context.
Internet draft MEGACO Protocol January 27, 2000
TransactionReply(TransactionID { TransactionReply(TransactionID {
ContextID { Response ... Response }, ContextID { Response ... Response },
. . . . . .
ContextID { Response ... Response } }) ContextID { Response ... Response } })
The TransactionID parameter must be the same as that of the correspond- The TransactionID parameter must be the same as that of the correspond-
ing TransactionRequest. ing TransactionRequest.
The ContextID parameter must specify a value to pertain to all Responses The ContextID parameter must specify a value to pertain to all Responses
for the action. The ContextID may be specific or null. for the action. The ContextID may be specific or null.
skipping to change at page 55, line 48 skipping to change at page 57, line 5
encounters an error such that is cannot determine a legal Transaction, encounters an error such that is cannot determine a legal Transaction,
it will return a TransactionReply with a null TransactionID and a single it will return a TransactionReply with a null TransactionID and a single
error descriptor (403 Syntax Error in Transaction). error descriptor (403 Syntax Error in Transaction).
If the end of a transaction can not be reliably determined and one or If the end of a transaction can not be reliably determined and one or
more Actions can be parsed, it will process them and then return 403 more Actions can be parsed, it will process them and then return 403
Syntax Error in Transaction as the last action reply for the transac- Syntax Error in Transaction as the last action reply for the transac-
tion. If no Actions can be parsed, it will return 403 Syntax Error in tion. If no Actions can be parsed, it will return 403 Syntax Error in
Transaction as the only reply Transaction as the only reply
Internet draft MEGACO Protocol February 8, 2000
If the terminationID cannot be reliably determined it will send 442 Syn- If the terminationID cannot be reliably determined it will send 442 Syn-
tax Error in Command as the action reply. tax Error in Command as the action reply.
If the end of a command cannot be reliably determined it will return 442 If the end of a command cannot be reliably determined it will return 442
Syntax Error in Transaction as the reply to the last action it can Syntax Error in Transaction as the reply to the last action it can
parse. parse.
Internet draft MEGACO Protocol January 27, 2000
8.2.3. TransactionPending 8.2.3. TransactionPending
The receiver invokes the TransactionPending. A TransactionPending indi- The receiver invokes the TransactionPending. A TransactionPending indi-
cates that the Transaction is actively being processed, but has not been cates that the Transaction is actively being processed, but has not been
completed. It is used to prevent the sender from assuming the Transac- completed. It is used to prevent the sender from assuming the Transac-
tionRequest was lost where the Transaction will take some time to com- tionRequest was lost where the Transaction will take some time to com-
plete. plete.
TransactionPending(TransactionID { } ) TransactionPending(TransactionID { } )
skipping to change at page 56, line 37 skipping to change at page 57, line 44
8.3. Messages 8.3. Messages
Multiple Transactions can be concatenated into a Message. Messages have Multiple Transactions can be concatenated into a Message. Messages have
a header, which includes the identity of the sender. The Message Iden- a header, which includes the identity of the sender. The Message Iden-
tifier (MID) of a message is set to a provisioned name (e.g. domain tifier (MID) of a message is set to a provisioned name (e.g. domain
address/domain name/device name) of the entity transmitting the message. address/domain name/device name) of the entity transmitting the message.
Domain name is a suggested default. Domain name is a suggested default.
Every Message contains a Version Number identifying the version of the Every Message contains a Version Number identifying the version of the
protocol the message conforms to. Versions are defined as in RFC2145, protocol the message conforms to. Versions consist of one or two
and consist of one or two digits. digits, beginning with version 1 for the present version of the proto-
col.
The transactions in a message are treated independently. There is no The transactions in a message are treated independently. There is no
order implied, there is no application or protocol acknowledgement of a order implied, there is no application or protocol acknowledgement of a
message. message.
Internet draft MEGACO Protocol February 8, 2000
9. TRANSPORT 9. TRANSPORT
The transport mechanism for the protocol should allow the reliable tran- The transport mechanism for the protocol should allow the reliable tran-
sport of transactions between an MGC and MG. The transport shall remain sport of transactions between an MGC and MG. The transport shall remain
independent of what particular commands are being sent and shall be independent of what particular commands are being sent and shall be
applicable to all application states. There are several transports applicable to all application states. There are several transports
defined for the protocol, which are defined in normative Annexes to this defined for the protocol, which are defined in normative Annexes to this
document. Additional Transports may be defined as additional annexes in document. Additional Transports may be defined as additional annexes in
subsequent editions of this document, or in separate documents. For subsequent editions of this document, or in separate documents. For
transport of the protocol over IP, MGCs shall implement both TCP and transport of the protocol over IP, MGCs shall implement both TCP and
Internet draft MEGACO Protocol January 27, 2000
UDP/ALF, an MG shall implement TCP or UDP/ALF or both. UDP/ALF, an MG shall implement TCP or UDP/ALF or both.
The MG is provisioned with a name or address (such as DNS name or IP The MG is provisioned with a name or address (such as DNS name or IP
address) of a primary and zero or more secondary MGCs (see section address) of a primary and zero or more secondary MGCs (see section
7.2.8) that is the address the MG uses to send messages to the MGC. 7.2.8) that is the address the MG uses to send messages to the MGC. If
The MGC receives the ServiceChange message from the MG and can determine TCP or UDP is used as the protocol transport and the port to which the
the MGs address. Responses to commands are sent back to the source initial ServiceChange request is to be sent is not otherwise known, that
address of the commands. The initial ServiceChange message should be request should be sent to the default port number for the protocol.
sent to the ServiceChangeAddress (in an IP network, port ???? if using This port number is xxxx for text-encoded operation or yyyy for binary-
TCP and port ???? if using UDP). The ServiceChange command contains a encoded operation, for either UDP or TCP. The MGC receives the message
ServiceChangeAddress parameter. The MG specifies the address (e.g., containing the ServiceChange request from the MG and can determine the
TCP/UDP port number) it wishes the MGC to use for communication. The MG's address from it. As described in section 7.2.8, either the MG or
MGC replies with the ServiceChangeAddress set to the address it wishes the MGC may supply an address in the ServiceChangeAddress parameter to
the MG to use for further communications. which subsequent transaction requests must be addressed, but responses
(including the response to the initial ServiceChange request) must
always be sent back to the address which was the source of the
corresponding request.
9.1. Ordering of Commands 9.1. Ordering of Commands
This document does not mandate that the underlying transport protocol This document does not mandate that the underlying transport protocol
guarantees the sequencing of transactions sent to an entity. This pro- guarantees the sequencing of transactions sent to an entity. This pro-
perty tends to maximize the timeliness of actions, but it has a few perty tends to maximize the timeliness of actions, but it has a few
drawbacks. For example: drawbacks. For example:
* Notify commands may be delayed and arrive at the MGC after the * Notify commands may be delayed and arrive at the MGC after the
transmission of a new command changing the EventsDescriptor transmission of a new command changing the EventsDescriptor
* If a new command is transmitted before a previous one is ack- * If a new command is transmitted before a previous one is ack-
nowledged, there is no guarantee that prior command will be exe- nowledged, there is no guarantee that prior command will be exe-
cuted before the new one. cuted before the new one.
Media Gateway Controllers that want to guarantee consistent operation of Media Gateway Controllers that want to guarantee consistent operation of
the Media Gateway may use the following rules: the Media Gateway may use the following rules:
1. When a Media Gateway handles several Terminations, commands per- 1. When a Media Gateway handles several Terminations, commands per-
taining to the different Terminations may be sent in parallel, for taining to the different Terminations may be sent in parallel, for
example following a model where each Termination (or group of Ter- example following a model where each Termination (or group of
minations) is controlled by its own process or its own thread.
Internet draft MEGACO Protocol February 8, 2000
Terminations) is controlled by its own process or its own thread.
2. In a given Context, there should normally be at most one outstand- 2. In a given Context, there should normally be at most one outstand-
ing command (Add or Modify or Move). However, a Subtract command ing command (Add or Modify or Move). However, a Subtract command
may be issued at any time. In consequence, a Media Gateway may may be issued at any time. In consequence, a Media Gateway may
sometimes receive a Modify command that applies to a previously sometimes receive a Modify command that applies to a previously
subtracted Termination. Such commands should be ignored, and an subtracted Termination. Such commands should be ignored, and an
error code should be returned. error code should be returned.
3. On a given Termination, there should normally be at most one out- 3. On a given Termination, there should normally be at most one out-
standing Notify command at any time. The RequestId parameter standing Notify command at any time. The RequestId parameter
should be used to correlate Notify commands with the triggering should be used to correlate Notify commands with the triggering
notification request. notification request.
Internet draft MEGACO Protocol January 27, 2000
4. In some cases, an implicitly or explicitly wildcarded Subtract com- 4. In some cases, an implicitly or explicitly wildcarded Subtract com-
mand that applies to a group of Terminations may step in front of a mand that applies to a group of Terminations may step in front of a
pending Add command. The Media Gateway Controller should individu- pending Add command. The Media Gateway Controller should individu-
ally delete all connections whose completion was pending at the ally delete all connections whose completion was pending at the
time of the global Subtract command. Also, new Add commands for time of the global Subtract command. Also, new Add commands for
Terminations named by the wild-carding (or implied in a Multiplex Terminations named by the wild-carding (or implied in a Multiplex
descriptor) may not be sent until the wild-carded Subtract command descriptor) may not be sent until the wild-carded Subtract command
is acknowledged. is acknowledged.
5. AuditValue and AuditCapability are not subject to any sequencing. 5. AuditValue and AuditCapability are not subject to any sequencing.
skipping to change at page 58, line 41 skipping to change at page 60, line 4
is suggested: is suggested:
1. When a Media Gateway is powered on, it should initiate a restart 1. When a Media Gateway is powered on, it should initiate a restart
timer to a random value, uniformly distributed between 0 and a max- timer to a random value, uniformly distributed between 0 and a max-
imum waiting delay (MWD). Care should be taken to avoid synchroni- imum waiting delay (MWD). Care should be taken to avoid synchroni-
city of the random number generation between multiple Media Gate- city of the random number generation between multiple Media Gate-
ways that would use the same algorithm. ways that would use the same algorithm.
2. The Media Gateway should then wait for either the end of this timer 2. The Media Gateway should then wait for either the end of this timer
or the detection of a local user activity, such as for example an or the detection of a local user activity, such as for example an
Internet draft MEGACO Protocol February 8, 2000
off-hook transition on a residential Media Gateway. off-hook transition on a residential Media Gateway.
3. When the timer elapses, or when an activity is detected, the Media 3. When the timer elapses, or when an activity is detected, the Media
Gateway should initiate the restart procedure. Gateway should initiate the restart procedure.
The restart procedure simply requires the MG to guarantee that the first The restart procedure simply requires the MG to guarantee that the first
message that the Media Gateway Controller sees from this MG is a Servi- message that the Media Gateway Controller sees from this MG is a Servi-
ceChange message informing the Media Gateway Controller about the res- ceChange message informing the Media Gateway Controller about the res-
tart tart
The value of MWD is a configuration parameter that depends on the type The value of MWD is a configuration parameter that depends on the type
of the Media Gateway. The following reasoning may be used to determine of the Media Gateway. The following reasoning may be used to determine
the value of this delay on residential gateways. the value of this delay on residential gateways.
Internet draft MEGACO Protocol January 27, 2000
Media Gateway Controllers are typically dimensioned to handle the peak Media Gateway Controllers are typically dimensioned to handle the peak
hour traffic load, during which, in average, 10% of the lines will be hour traffic load, during which, in average, 10% of the lines will be
busy, placing calls whose average duration is typically 3 minutes. The busy, placing calls whose average duration is typically 3 minutes. The
processing of a call typically involves 5 to 6 Media Gateway Controller processing of a call typically involves 5 to 6 Media Gateway Controller
transactions between each Media Gateway and the Media Gateway Con- transactions between each Media Gateway and the Media Gateway Con-
troller. This simple calculation shows that the Media Gateway Con- troller. This simple calculation shows that the Media Gateway Con-
troller is expected to handle 5 to 6 transactions for each Termination, troller is expected to handle 5 to 6 transactions for each Termination,
every 30 minutes on average, or, to put it otherwise, about one transac- every 30 minutes on average, or, to put it otherwise, about one transac-
tion per Termination every 5 to 6 minutes on average. This suggests tion per Termination every 5 to 6 minutes on average. This suggests
that a reasonable value of MWD for a residential gateway would be 10 to that a reasonable value of MWD for a residential gateway would be 10 to
skipping to change at page 59, line 41 skipping to change at page 61, line 4
a gateway that handles a T3 line. a gateway that handles a T3 line.
10. SECURITY CONSIDERATIONS 10. SECURITY CONSIDERATIONS
This section covers security when using the protocol in an IP environ- This section covers security when using the protocol in an IP environ-
ment. ment.
10.1. Protection of Protocol Connections 10.1. Protection of Protocol Connections
A security mechanism is clearly needed to prevent unauthorized entities A security mechanism is clearly needed to prevent unauthorized entities
Internet draft MEGACO Protocol February 8, 2000
from using the protocol defined in this document for setting up unau- from using the protocol defined in this document for setting up unau-
thorized calls or interfering with authorized calls. The security thorized calls or interfering with authorized calls. The security
mechanism for the protocol when transported over IP networks is IPsec mechanism for the protocol when transported over IP networks is IPsec
[RFC2401 to RFC2411]. [RFC2401 to RFC2411].
The AH header [RFC2402] affords data origin authentication, connection- The AH header [RFC2402] affords data origin authentication, connection-
less integrity and optional anti-replay protection of messages passed less integrity and optional anti-replay protection of messages passed
between the MG and the MGC. The ESP header [RFC2406] provides confiden- between the MG and the MGC. The ESP header [RFC2406] provides confiden-
tiality of messages, if desired. For instance, the ESP encryption ser- tiality of messages, if desired. For instance, the ESP encryption ser-
vice should be requested if the session descriptions are used to carry vice should be requested if the session descriptions are used to carry
session keys, as defined in SDP. session keys, as defined in SDP.
Implementations of the protocol defined in this document employing the Implementations of the protocol defined in this document employing the
ESP header SHALL comply with section 5 of [RFC2406], which defines a ESP header SHALL comply with section 5 of [RFC2406], which defines a
Internet draft MEGACO Protocol January 27, 2000
minimum set of algorithms for integrity checking and encryption. Simi- minimum set of algorithms for integrity checking and encryption. Simi-
larly, implementations employing the AH header SHALL comply with section larly, implementations employing the AH header SHALL comply with section
5 of [RFC2402], which defines a minimum set of algorithms for integrity 5 of [RFC2402], which defines a minimum set of algorithms for integrity
checking using manual keys. checking using manual keys.
Implementations SHOULD use IKE [RFC2409] to permit more robust keying Implementations SHOULD use IKE [RFC2409] to permit more robust keying
options. Implementations employing IKE SHOULD support authentication options. Implementations employing IKE SHOULD support authentication
with RSA signatures and RSA public key encryption. with RSA signatures and RSA public key encryption.
10.2. Interim AH scheme 10.2. Interim AH scheme
skipping to change at page 60, line 41 skipping to change at page 62, line 4
tionality, the ICV calculation should be performed across the entire tionality, the ICV calculation should be performed across the entire
transaction prepended by a synthesized IP header consisting of a 32 bit transaction prepended by a synthesized IP header consisting of a 32 bit
source IP address, a 32 bit destination address and an 16 bit UDP source IP address, a 32 bit destination address and an 16 bit UDP
encoded as 10 hex digits. When the interim AH mechanism is employed when encoded as 10 hex digits. When the interim AH mechanism is employed when
TCP is the transport Layer, the UDP Port above becomes the TCP port, and TCP is the transport Layer, the UDP Port above becomes the TCP port, and
all other operations are the same. all other operations are the same.
Implementations of the MEGACO protocol SHALL implement IPsec where the Implementations of the MEGACO protocol SHALL implement IPsec where the
underlying operating system and the transport network supports IPsec. underlying operating system and the transport network supports IPsec.
Implementations of the protocol using IPv4 SHALL implement the interim Implementations of the protocol using IPv4 SHALL implement the interim
Internet draft MEGACO Protocol February 8, 2000
AH scheme. However, this interim scheme SHALL NOT be used when the AH scheme. However, this interim scheme SHALL NOT be used when the
underlying network layer supports IPsec. IPv6 implementations are underlying network layer supports IPsec. IPv6 implementations are
assumed to support IPsec and SHALL NOT use the interim AH scheme. assumed to support IPsec and SHALL NOT use the interim AH scheme.
All implementations of the interim AH mechanism SHALL comply with sec- All implementations of the interim AH mechanism SHALL comply with sec-
tion 5 of [RFC2402] which defines a minimum set of algorithms for tion 5 of [RFC2402] which defines a minimum set of algorithms for
integrity checking using manual keys. integrity checking using manual keys.
The interim AH interim scheme does not provide protection against eaves- The interim AH interim scheme does not provide protection against eaves-
dropping; thus forbidding third parties from monitoring the connections dropping; thus forbidding third parties from monitoring the connections
set up by a given termination. Also, it does not provide protection set up by a given termination. Also, it does not provide protection
against replay attacks. These procedures do not necessarily protect against replay attacks. These procedures do not necessarily protect
against denial of service attacks by misbehaving MGs or misbehaving against denial of service attacks by misbehaving MGs or misbehaving
MGCs. However, they will provide an identification of these misbehaving MGCs. However, they will provide an identification of these misbehaving
Internet draft MEGACO Protocol January 27, 2000
entities, which should then be deprived of their authorization through entities, which should then be deprived of their authorization through
maintenance procedures. maintenance procedures.
10.3. Protection of Media Connections 10.3. Protection of Media Connections
The protocol allows the MGC to provide MGs with "session keys" that can The protocol allows the MGC to provide MGs with "session keys" that can
be used to encrypt the audio messages, protecting against eavesdropping. be used to encrypt the audio messages, protecting against eavesdropping.
A specific problem of packet networks is "uncontrolled barge-in". This A specific problem of packet networks is "uncontrolled barge-in". This
attack can be performed by directing media packets to the IP address and attack can be performed by directing media packets to the IP address and
skipping to change at page 61, line 41 skipping to change at page 63, line 5
waiting for the round trip to complete, and risk for example, waiting for the round trip to complete, and risk for example,
"clipping" a remote announcement, or wait for the full roundtrip "clipping" a remote announcement, or wait for the full roundtrip
and settle for slower call-set-up procedures. and settle for slower call-set-up procedures.
* Source spoofing is only effective if the attacker can obtain valid * Source spoofing is only effective if the attacker can obtain valid
pairs of source destination addresses and ports, for example by pairs of source destination addresses and ports, for example by
listening to a fraction of the traffic. To fight source spoofing, listening to a fraction of the traffic. To fight source spoofing,
one could try to control all access points to the network. But one could try to control all access points to the network. But
this is in practice very hard to achieve. this is in practice very hard to achieve.
Internet draft MEGACO Protocol February 8, 2000
An alternative to checking the source address is to encrypt and authen- An alternative to checking the source address is to encrypt and authen-
ticate the packets, using a secret key that is conveyed during the call ticate the packets, using a secret key that is conveyed during the call
set-up procedure. This will not slow down the call set- up, and provides set-up procedure. This will not slow down the call set- up, and provides
strong protection against address spoofing. strong protection against address spoofing.
11. MG-MGC CONTROL INTERFACE 11. MG-MGC CONTROL INTERFACE
The control association between MG and MGC is initiated at MG cold The control association between MG and MGC is initiated at MG cold
start, and announced by a ServiceChange message, but can be changed by start, and announced by a ServiceChange message, but can be changed by
subsequent events, such as failures or manual service events. While the subsequent events, such as failures or manual service events. While the
protocol does not have an explicit mechanism to support multiple MGCs protocol does not have an explicit mechanism to support multiple MGCs
controlling a physical MG, it has been designed to support the multiple controlling a physical MG, it has been designed to support the multiple
logical MG (within a single physical MG) that can be associated with logical MG (within a single physical MG) that can be associated with
different MGCs. different MGCs.
Internet draft MEGACO Protocol January 27, 2000
11.1. Multiple Virtual MGs 11.1. Multiple Virtual MGs
A physical Media Gateway may be partitioned into one or more Virtual A physical Media Gateway may be partitioned into one or more Virtual
MGs. A virtual MG consists of a set of statically partitioned physical MGs. A virtual MG consists of a set of statically partitioned physical
Terminations and/or sets of ephemeral Terminations. A physical Termina- Terminations and/or sets of ephemeral Terminations. A physical Termina-
tion is controlled by one MGC. The model does not require that other tion is controlled by one MGC. The model does not require that other
resources be statically allocated, just Terminations. The mechanism for resources be statically allocated, just Terminations. The mechanism for
allocating Terminations to virtual MGs is a management method outside allocating Terminations to virtual MGs is a management method outside
the scope of the protocol. Each of the virtual MGs appears to the MGC the scope of the protocol. Each of the virtual MGs appears to the MGC
as a complete MG client. as a complete MG client.
skipping to change at page 62, line 41 skipping to change at page 64, line 5
do with respect to the physical resources it is controlling. do with respect to the physical resources it is controlling.
If recovering from the event requires manipulation of a physical If recovering from the event requires manipulation of a physical
interface's state, only one MGC should do so. These issues are resolved interface's state, only one MGC should do so. These issues are resolved
by allowing any of the MGCs to create EventsDescriptors to be notified by allowing any of the MGCs to create EventsDescriptors to be notified
of such events, but only one MGC can have read/write access to the phy- of such events, but only one MGC can have read/write access to the phy-
sical interface properties; all other MGCs have read-only access. The sical interface properties; all other MGCs have read-only access. The
management mechanism is used to designate which MGC has read/write capa- management mechanism is used to designate which MGC has read/write capa-
bility, and is designated the Master MGC. bility, and is designated the Master MGC.
Internet draft MEGACO Protocol February 8, 2000
Each virtual MG has its own Root Termination. In most cases the values Each virtual MG has its own Root Termination. In most cases the values
for the properties of the Root Termination are independently settable by for the properties of the Root Termination are independently settable by
each MGC. Where there can only be one value, the parameter is read-only each MGC. Where there can only be one value, the parameter is read-only
to all but the Master MGC. to all but the Master MGC.
ServiceChange may only be applied to a Termination or set of Termina- ServiceChange may only be applied to a Termination or set of Termina-
tions partitioned to the Virtual MG or created (in the case of ephemeral tions partitioned to the Virtual MG or created (in the case of ephemeral
Terminations) by that Virtual MG. ServiceChange may only be applied to Terminations) by that Virtual MG.
the Root by the Master MGC.
11.2. Cold Start 11.2. Cold Start
A MG is pre-provisioned by a management mechanism outside the scope of A MG is pre-provisioned by a management mechanism outside the scope of
this protocol with a Primary and (optionally) an ordered list of this protocol with a Primary and (optionally) an ordered list of Secon-
dary MGCs. Upon a cold start of the MG, it will issue a ServiceChange
Internet draft MEGACO Protocol January 27, 2000 command with a "Restart" method, on the Root Termination to its primary
MGC. If the MGC accepts the MG, it will send a Transaction Accept, with
Secondary MGCs. Upon a cold start of the MG, it will issue a Servi- the MGCIdToTry set to itself. If the MG receives a ServiceChangeMGCId
ceChange command with a "Restart" method, on the Root Termination to its not equal to the MGC it contacted, it sends a ServiceChange to the MGC
primary MGC. If the MGC accepts the MG, it will send a Transaction specified in the ServiceChangeMGCId. It continues this process until it
Accept, with the MGCIdToTry set to itself. If the MG receives an MGCId-
ToTry not equal to the MGC it contacted, it sends a ServiceChange to the
MGC specified in the MGCIdToTry. It continues this process until it
gets a controlling MGC to accept its registration, or it fails to get a gets a controlling MGC to accept its registration, or it fails to get a
reply. Upon failure to obtain a reply, either from the Primary MGC, or a reply. Upon failure to obtain a reply, either from the Primary MGC, or a
designated successor, the MG tries its pre-provisioned Secondary MGCs, designated successor, the MG tries its pre-provisioned Secondary MGCs,
in order. If the MG is unable to establish a control relationship with in order. If the MG is unable to establish a control relationship with
any MGC, it shall wait a random amount of time as described in section any MGC, it shall wait a random amount of time as described in section
9.2 and then start contacting its primary, and if necessary, its secon- 9.2 and then start contacting its primary, and if necessary, its secon-
dary MGCs again. dary MGCs again.
It is possible that the reply to a ServiceChange with Restart will be It is possible that the reply to a ServiceChange with Restart will be
lost, and a command will be received by the MG prior to the receipt of lost, and a command will be received by the MG prior to the receipt of
skipping to change at page 63, line 34 skipping to change at page 64, line 47
Received before Restart Response. Received before Restart Response.
11.3. Negotiation of Protocol Version 11.3. Negotiation of Protocol Version
The first ServiceChange command from an MG shall contain the version The first ServiceChange command from an MG shall contain the version
number of the protocol supported by the MG in the ServiceChangeVersion number of the protocol supported by the MG in the ServiceChangeVersion
parameter. Upon receiving such a message, if the MGC supports only a parameter. Upon receiving such a message, if the MGC supports only a
lower version, then the MGC shall send a ServiceChangeReply with the lower version, then the MGC shall send a ServiceChangeReply with the
lower version and thereafter all the messages between MG and MGC shall lower version and thereafter all the messages between MG and MGC shall
conform to the lower version of the protocol. If the MG is unable to conform to the lower version of the protocol. If the MG is unable to
comply, it shall reject the association, with Error 406 Version Not Sup- comply and it has established a transport connection to the MGC, it
ported. should close that connection. In any event, it should reject all subse-
quent requests from the MGC with Error 406 Version Not Supported.
If the MGC supports a higher version than the MG but is able to support If the MGC supports a higher version than the MG but is able to support
the lower version proposed by the MG, it shall send a ServiceChangeReply the lower version proposed by the MG, it shall send a ServiceChangeReply
with the lower version and thereafter all the messages between MG and with the lower version and thereafter all the messages between MG and
MGC shall conform to the lower version of the protocol. If the MGC is MGC shall conform to the lower version of the protocol. If the MGC is
Internet draft MEGACO Protocol February 8, 2000
unable to comply, it shall reject the association, with Error 406 Ver- unable to comply, it shall reject the association, with Error 406 Ver-
sion Not Supported. sion Not Supported.
Protocol version negotiation may also occur at "handoff" and "failover" Protocol version negotiation may also occur at "handoff" and "failover"
ServiceChanges. ServiceChanges.
11.4. Failure of an MG 11.4. Failure of an MG
If a MG fails, but is capable of sending a message to the MGC, it sends If a MG fails, but is capable of sending a message to the MGC, it sends
a ServiceChange with an appropriate method (graceful or forced) and a ServiceChange with an appropriate method (graceful or forced) and
specifies the Root TerminationID. When it returns to service, it sends specifies the Root TerminationID. When it returns to service, it sends
a ServiceChange with a "Restart" method. a ServiceChange with a "Restart" method.
Allowing the MGC to send duplicate messages to both MGs accommodates Allowing the MGC to send duplicate messages to both MGs accommodates
Internet draft MEGACO Protocol January 27, 2000
pairs of MGs that are capable of redundant failover of one of the MGs. pairs of MGs that are capable of redundant failover of one of the MGs.
Only the Working MG shall accept or reject transactions. Upon failover, Only the Working MG shall accept or reject transactions. Upon failover,
the Primary MG sends a ServiceChange command with a "Failover" method the Primary MG sends a ServiceChange command with a "Failover" method
and a "MG Impending Failure" reason. The MGC then uses the primary MG and a "MG Impending Failure" reason. The MGC then uses the primary MG
as the active MG. When the error condition is repaired, the Working MG as the active MG. When the error condition is repaired, the Working MG
can send a "ServiceChange" with a "Restart" method. can send a "ServiceChange" with a "Restart" method.
11.5. Failure of an MGC 11.5. Failure of an MGC
If the MG detects a failure of its controlling MGC, it attempts to con- If the MG detects a failure of its controlling MGC, it attempts to con-
tact the next MGC on its pre-provisioned list. It starts its attempts tact the next MGC on its pre-provisioned list. It starts its attempts
at the beginning (Primary MGC), unless that was the MGC that failed, in at the beginning (Primary MGC), unless that was the MGC that failed, in
which case it starts at its first Secondary MGC. It sends a Servi- which case it starts at its first Secondary MGC. It sends a Servi-
ceChange message with a "Failover" method and a " MGC Impending Failure" ceChange message with a "Failover" method and a " MGC Impending Failure"
reason. reason.
In partial failure, or manual maintenance reasons, an MGC may wish to In partial failure, or manual maintenance reasons, an MGC may wish to
direct its controlled MGs to use a different MGC. To do so, it sends a direct its controlled MGs to use a different MGC. To do so, it sends a
ServiceChange method to the MG with a "HandOff" method, and its desig- ServiceChange method to the MG with a "HandOff" method, and its desig-
nated replacement in MGCIdToTry. The MG should send a ServiceChange mes- nated replacement in ServiceChangeMGCId. The MG should send a Servi-
sage with a "Failover" method and a "MGC directed change" reason to the ceChange message with a "Handoff" method and a "MGC directed change"
designated MGC. If it fails to get a reply, or fails to see an Audit reason to the designated MGC. If it fails to get a reply, or fails to
command subsequently, it should behave as if its MGC failed, and start see an Audit command subsequently, it should behave as if its MGC
contacting secondary MGCs. If the MG is unable to establish a control failed, and start contacting secondary MGCs. If the MG is unable to
relationship with any MGC, it shall wait a random amount of time as establish a control relationship with any MGC, it shall wait a random
described in section 9.2 and then start contacting its primary, and if amount of time as described in section 9.2 and then start contacting its
necessary, its secondary MGCs again. primary, and if necessary, its secondary MGCs again.
No recommendation is made on how the MGCs involved in the Handoff main- No recommendation is made on how the MGCs involved in the Handoff main-
tain state information; this is considered to be out of scope of this tain state information; this is considered to be out of scope of this
recommendation. The MGC and MG may take the following steps when Handoff recommendation. The MGC and MG may take the following steps when Handoff
occurs. When the MGC initiates a HandOff, the handover should be tran- occurs. When the MGC initiates a HandOff, the handover should be tran-
sparent to Operations on the Media Gateway. Transactions can be exe- sparent to Operations on the Media Gateway. Transactions can be exe-
cuted in any order, and could be in progress when the ServiceChange is cuted in any order, and could be in progress when the ServiceChange is
Internet draft MEGACO Protocol February 8, 2000
executed. Accordingly, commands in progress continue, transaction executed. Accordingly, commands in progress continue, transaction
replies are sent to the new MGC (after a new control association is replies are sent to the new MGC (after a new control association is
established), and the MG should expect outstanding transaction replies established), and the MG should expect outstanding transaction replies
from the new MGC. No new messages shall be sent to the new MGC until from the new MGC. No new messages shall be sent to the new MGC until
the control association is established. Repeated transaction requests the control association is established. Repeated transaction requests
shall be directed to the new MGC. The MG shall maintain state on all shall be directed to the new MGC. The MG shall maintain state on all
terminations and contexts. terminations and contexts.
It is possible that the MGC could be implemented in such a way that a It is possible that the MGC could be implemented in such a way that a
failed MGC is replaced by a working MGC where the identity of the new failed MGC is replaced by a working MGC where the identity of the new
MGC is the same as the failed one. In such a case, MGCIdToTry would be MGC is the same as the failed one. In such a case, ServiceChangeMGCId
specified with the previous value and the MG shall behave as if the would be specified with the previous value and the MG shall behave as if
value was changed, and send a ServiceChange message, as above. the value was changed, and send a ServiceChange message, as above.
Internet draft MEGACO Protocol January 27, 2000
Pairs of MGCs that are capable of redundant failover can notify the con- Pairs of MGCs that are capable of redundant failover can notify the con-
trolled MGs of the failover by the above mechanism. trolled MGs of the failover by the above mechanism.
12. PACKAGE DEFINITION 12. PACKAGE DEFINITION
The primary mechanism for extension is by means of Packages. Packages The primary mechanism for extension is by means of Packages. Packages
define additional Properties, Events, Signals and Statistics that may define additional Properties, Events, Signals and Statistics that may
occur on Terminations. occur on Terminations.
skipping to change at page 65, line 41 skipping to change at page 67, line 4
have a stable URL. The site should provide a mechanism to provide have a stable URL. The site should provide a mechanism to provide
comments and appropriate responses should be returned. comments and appropriate responses should be returned.
12.1. Guidelines for defining packages 12.1. Guidelines for defining packages
Packages define Properties, Events, Signals, and Statistics. Packages define Properties, Events, Signals, and Statistics.
Names of all such defined constructs shall consist of the PackageID Names of all such defined constructs shall consist of the PackageID
(which uniquely identifies the package) and the ID of the item (which (which uniquely identifies the package) and the ID of the item (which
uniquely identifies the item in that package). In the text encoding the uniquely identifies the item in that package). In the text encoding the
Internet draft MEGACO Protocol February 8, 2000
two shall be separated by a forward slash ("/") character. Example: two shall be separated by a forward slash ("/") character. Example:
togen/playtone is the text encoding to refer to the play tone signal in togen/playtone is the text encoding to refer to the play tone signal in
the tone generation package. the tone generation package.
A Package will contain the following sections: A Package will contain the following sections:
12.1.1. Package Overall description of the package, specifying: 12.1.1. Package Overall description of the package, specifying:
Package Name: only descriptive, Package Name: only descriptive,
PackageID: Is an identifier, its text encoding may not be a key- PackageID: Is an identifier Description:
word in the base protocol Description:
Version: A new version of a package can only add additional
Internet draft MEGACO Protocol January 27, 2000
Properties, Events, Signals, Statistics and new possible values for Version: A new version of a package can only add additional Proper-
an existing parameter described in the original package. No dele- ties, Events, Signals, Statistics and new possible values for an
tions or modifications shall be allowed. A version is an integer in existing parameter described in the original package. No deletions
the range from 1 to 99. or modifications shall be allowed. A version is an integer in the
range from 1 to 99.
Extends (Optional): A package may extend an existing package. The Extends (Optional): A package may extend an existing package. The
version of the original package must be specified. When a package version of the original package must be specified. When a package
extends another package it shall only add additional Properties, extends another package it shall only add additional Properties,
Events, Signals, Statistics and new possible values for an existing Events, Signals, Statistics and new possible values for an existing
parameter described in the original package. An extended package parameter described in the original package. An extended package
shall not redefine or overload a name defined in the original pack- shall not redefine or overload a name defined in the original pack-
age. Hence, if package B version 1 extends package A version 1, age. Hence, if package B version 1 extends package A version 1,
version 2 of B will not be able to extend the A version 2 if A ver- version 2 of B will not be able to extend the A version 2 if A ver-
sion 2 defines a name already in B version 1. sion 2 defines a name already in B version 1.
skipping to change at page 66, line 41 skipping to change at page 68, line 4
Integer: 4 byte signed integer Integer: 4 byte signed integer
Double: 8 byte signed integer Double: 8 byte signed integer
Character: Unicode UTF-8 encoding of a single letter. Character: Unicode UTF-8 encoding of a single letter.
Could be more than one octet. Could be more than one octet.
Enumeration: One of a list of possible unique values Enumeration: One of a list of possible unique values
(See 12.3) (See 12.3)
Sub-list: A list of several values from a list Sub-list: A list of several values from a list
Boolean Boolean
Possible Values: Possible Values:
Defined in: Which descriptor the property is defined in. Defined in: Which descriptor the property is defined in.
Internet draft MEGACO Protocol February 8, 2000
LocalControl is for stream dependent properties. LocalControl is for stream dependent properties.
TerminationState is for stream independent properties. TerminationState is for stream independent properties.
Characteristics: Read / Write or both, and (optionally), global: Characteristics: Read / Write or both, and (optionally), global:
Indicates whether a property is read-only, or read-write, Indicates whether a property is read-only, or read-write,
and if it is global. If Global is omitted, the property and if it is global. If Global is omitted, the property
is not global. If a property is declared as global, is not global. If a property is declared as global,
the value of the property is shared by all terminations the value of the property is shared by all terminations
realizing the package. realizing the package.
12.1.3. Events 12.1.3. Events
Events defined by the package, specifying: Events defined by the package, specifying:
Internet draft MEGACO Protocol January 27, 2000
Event name: only descriptive. Event name: only descriptive.
EventID: Is an identifier EventID: Is an identifier
Description: Description:
EventsDescriptor Parameters: EventsDescriptor Parameters:
Parameters used by the MGC to configure the event, Parameters used by the MGC to configure the event,
and found in the EventsDescriptor. See section 12.2 and found in the EventsDescriptor. See section 12.2
ObservedEventsDescriptor Parameters: ObservedEventsDescriptor Parameters:
Parameters returned to the MGC in Notify requests Parameters returned to the MGC in Notify requests
and in replies to command requests from the MGC that and in replies to command requests from the MGC that
audit ObservedEventsDescriptor, and found in the audit ObservedEventsDescriptor, and found in the
skipping to change at page 67, line 39 skipping to change at page 69, line 5
BR (Brief) BR (Brief)
Note: SignalType may be defined such that it is dependent on the value Note: SignalType may be defined such that it is dependent on the value
of one or more parameters. Signals that would be played with SignalType of one or more parameters. Signals that would be played with SignalType
BR should have a default duration. The package has to define the default BR should have a default duration. The package has to define the default
duration and signalType. duration and signalType.
Duration: in hundredths of seconds Duration: in hundredths of seconds
Additional Parameters: See section 12.2 Additional Parameters: See section 12.2
Internet draft MEGACO Protocol February 8, 2000
12.1.5. Statistics 12.1.5. Statistics
Statistics defined by the package, specifying: Statistics defined by the package, specifying:
Statistic name: only descriptive. Statistic name: only descriptive.
StatisticID: Is an identifier StatisticID: Is an identifier
StatisticID is used in a StatisticsDescriptor StatisticID is used in a StatisticsDescriptor
Description Description
Units: unit of measure, e.g. milliseconds, packets Units: unit of measure, e.g. milliseconds, packets
12.1.6. Procedures 12.1.6. Procedures
Additional guidance on the use of the package. Additional guidance on the use of the package.
Internet draft MEGACO Protocol January 27, 2000
12.2. Guidelines to defining Properties, Statistics and Parameters to 12.2. Guidelines to defining Properties, Statistics and Parameters to
Events and Signals. Events and Signals.
Parameter Name: only descriptive Parameter Name: only descriptive
ParameterID: Is an identifier ParameterID: Is an identifier
Type: One of: Type: One of:
String: UTF-8 octet string String: UTF-8 octet string
Integer: 4 octet signed integer Integer: 4 octet signed integer
Double: 8 octet signed integer Double: 8 octet signed integer
Character: Unicode UTF-8 encoding of a single letter. Character: Unicode UTF-8 encoding of a single letter.
skipping to change at page 68, line 40 skipping to change at page 70, line 4
concern for conflicting names. concern for conflicting names.
12.4. Identifiers 12.4. Identifiers
Identifiers in text encoding shall be strings of up to 64 characters, Identifiers in text encoding shall be strings of up to 64 characters,
containing no spaces, starting with an alphanumeric character and con- containing no spaces, starting with an alphanumeric character and con-
sisting of alphanumeric characters and / or digits, and possibly includ- sisting of alphanumeric characters and / or digits, and possibly includ-
ing the special character underscore ("_"). Identifiers in binary ing the special character underscore ("_"). Identifiers in binary
encoding are 2 octets long. Both text and binary values shall be speci- encoding are 2 octets long. Both text and binary values shall be speci-
fied for each identifier, including identifiers used as values in fied for each identifier, including identifiers used as values in
Internet draft MEGACO Protocol February 8, 2000
enumerated types. enumerated types.
12.5. Package Registration 12.5. Package Registration
A package can be registered with IANA for interoperability reasons. See A package can be registered with IANA for interoperability reasons. See
section 13 for IANA considerations. section 13 for IANA considerations.
13. IANA CONSIDERATIONS 13. IANA CONSIDERATIONS
13.1. Packages 13.1. Packages
The following considerations SHALL be met to register a package with The following considerations SHALL be met to register a package with
IANA: IANA:
Internet draft MEGACO Protocol January 27, 2000
1. A unique string name, unique serial number and version number is 1. A unique string name, unique serial number and version number is
registered for each package. The string name is used with text registered for each package. The string name is used with text
encoding. The serial number shall be used with binary encoding. encoding. The serial number shall be used with binary encoding.
Serial Numbers 60000-64565 are reserved for private use. Serial Serial Numbers 60000-64565 are reserved for private use. Serial
number 0 is reserved. number 0 is reserved.
2. A contact name, email and postal addresses for that contact shall 2. A contact name, email and postal addresses for that contact shall
be specified. The contact information shall be updated by the be specified. The contact information shall be updated by the
defining organization as necessary. defining organization as necessary.
skipping to change at page 69, line 41 skipping to change at page 71, line 4
The following considerations SHALL be met to register an error code with The following considerations SHALL be met to register an error code with
IANA: IANA:
1. An error number and a one line (80 character maximum) string is 1. An error number and a one line (80 character maximum) string is
registered for each error. registered for each error.
2. A complete description of the conditions under which the error is 2. A complete description of the conditions under which the error is
detected shall be included in a publicly available document. The detected shall be included in a publicly available document. The
description shall be sufficiently clear to differentiate the error description shall be sufficiently clear to differentiate the error
Internet draft MEGACO Protocol February 8, 2000
from all other existing error codes. from all other existing error codes.
3. The document should be available on a public web server and should 3. The document should be available on a public web server and should
have a stable URL. have a stable URL.
4. Error numbers registered by recognized standards bodies shall have 4. Error numbers registered by recognized standards bodies shall have
3 or 4 character error numbers. 3 or 4 character error numbers.
5. Error numbers registered by all other organizations or individuals 5. Error numbers registered by all other organizations or individuals
shall have 4 character error numbers. shall have 4 character error numbers.
6. An error number shall not be redefined, nor modified except by the 6. An error number shall not be redefined, nor modified except by the
organization or individual that originally defined it, or their organization or individual that originally defined it, or their
successors or assigns. successors or assigns.
Internet draft MEGACO Protocol January 27, 2000
13.3. ServiceChange Reasons 13.3. ServiceChange Reasons
The following considerations SHALL be met to register service change The following considerations SHALL be met to register service change
reason with IANA: reason with IANA:
1. A one phrase, 80-character maximum, unique reason code is 1. A one phrase, 80-character maximum, unique reason code is
registered for each reason. registered for each reason.
2. A complete description of the conditions under which the reason is 2. A complete description of the conditions under which the reason is
used is detected shall be included in a publicly available docu- used is detected shall be included in a publicly available docu-
skipping to change at page 70, line 40 skipping to change at page 72, line 4
U.S.A. U.S.A.
Phone: +1 724-742-6826 Phone: +1 724-742-6826
Email: brosen@fore.com Email: brosen@fore.com
ITU Editor ITU Editor
John Segers John Segers
Lucent Technologies Lucent Technologies
Room HE 306 Room HE 306
Dept. Forward Looking Work Dept. Forward Looking Work
P.O. Box 18, 1270 AA Huizen P.O. Box 18, 1270 AA Huizen
Internet draft MEGACO Protocol February 8, 2000
Netherlands Netherlands
Phone: +31 35 687 4724 Phone: +31 35 687 4724
Email: jsegers@lucent.com Email: jsegers@lucent.com
Additional IETF Authors Additional IETF Authors
Fernando Cuervo Fernando Cuervo
Nortel Networks Nortel Networks
P.O. Box 3511 Stn C Ottawa, ON, K1Y 4H7 P.O. Box 3511 Stn C Ottawa, ON, K1Y 4H7
Canada Canada
Email: cuervo@nortelnetworks.com Email: cuervo@nortelnetworks.com
Bryan Hill Bryan Hill
Gotham Networks Gotham Networks
15 Discovery Way 15 Discovery Way
Acton, MA 01720 Acton, MA 01720
Internet draft MEGACO Protocol January 27, 2000
USA USA
Phone: +1 978-263-6890 Phone: +1 978-263-6890
Email: bhill@gothamnetworks.com Email: bhill@gothamnetworks.com
Christian Huitema Christian Huitema
Telcordia Technologies Telcordia Technologies
MCC 1J236B MCC 1J236B
445 South Street 445 South Street
Morristown, NJ 07960 Morristown, NJ 07960
U.S.A. U.S.A.
skipping to change at page 71, line 36 skipping to change at page 73, line 5
Email: ngreene@nortelnetworks.com Email: ngreene@nortelnetworks.com
Abdallah Rayhan Abdallah Rayhan
Nortel Networks Nortel Networks
P.O. Box 3511 Stn C P.O. Box 3511 Stn C
Ottawa, ON, K1Y 4H7 Ottawa, ON, K1Y 4H7
Canada Canada
Phone: +1 613-763-9611 Phone: +1 613-763-9611
Email: arayhan@nortelnetworks.com Email: arayhan@nortelnetworks.com
Internet draft MEGACO Protocol February 8, 2000
ANNEX A BINARY ENCODING OF THE PROTOCOL (NORMATIVE) ANNEX A BINARY ENCODING OF THE PROTOCOL (NORMATIVE)
This Annex specifies the syntax of messages using the notation defined This Annex specifies the syntax of messages using the notation defined
in ASN.1 [ITU-T Recommendation X.680 (1997): Information Technology - in ASN.1 [ITU-T Recommendation X.680 (1997): Information Technology -
Abstract Syntax Notation One (ASN.1) - Specification of basic nota- Abstract Syntax Notation One (ASN.1) - Specification of basic nota-
tion.]. Messages shall be encoded for transmission by applying the basic tion.]. Messages shall be encoded for transmission by applying the basic
encoding rules specified in [ITU-T Recommendation X.690(1994) Informa- encoding rules specified in [ITU-T Recommendation X.690(1994) Informa-
tion Technology - ASN.1 Encoding Rules: Specification of Basic tion Technology - ASN.1 Encoding Rules: Specification of Basic
Encoding Rules (BER)]. Encoding Rules (BER)].
A.1. Coding of wildcards A.1. Coding of wildcards
The use of wildcards ALL and CHOOSE is allowed in the protocol. This The use of wildcards ALL and CHOOSE is allowed in the protocol. This
allows a MGC to partially specify Termination IDs and let the MG choose allows a MGC to partially specify Termination IDs and let the MG choose
from the values that conform to the partial specification. Termination from the values that conform to the partial specification. Termination
IDs may encode a hierarchy of names. This hierarchy is provisioned. For IDs may encode a hierarchy of names. This hierarchy is provisioned. For
Internet draft MEGACO Protocol January 27, 2000
instance, a TerminationID may consist of a trunk group, a trunk within instance, a TerminationID may consist of a trunk group, a trunk within
the group and a circuit. Wildcarding must be possible at all levels. the group and a circuit. Wildcarding must be possible at all levels.
The following paragraphs explain how this is achieved. The following paragraphs explain how this is achieved.
The ASN.1 description uses octet strings of up to 8 octets in length for The ASN.1 description uses octet strings of up to 8 octets in length for
Termination IDs. This means that Termination IDs consist of at most 64 Termination IDs. This means that Termination IDs consist of at most 64
bits. A fully specified Termination ID may be preceded by a sequence of bits. A fully specified Termination ID may be preceded by a sequence of
wildcarding fields. A wildcarding field is octet in length. Bit 7 (the wildcarding fields. A wildcarding field is octet in length. Bit 7 (the
most significant bit) of this octet specifies what type of wildcarding most significant bit) of this octet specifies what type of wildcarding
is invoked: if the bit value equals 1, then the ALL wildcard is used; is invoked: if the bit value equals 1, then the ALL wildcard is used;
skipping to change at page 72, line 38 skipping to change at page 74, line 5
00000001 00011110 01010101. 00000001 00011110 01010101.
Addressing ALL names with prefix 00000001 00011110 is done as follows: Addressing ALL names with prefix 00000001 00011110 is done as follows:
wildcarding field: 10000111 wildcarding field: 10000111
Termination ID: 00000001 00011110 xxxxxxxx. Termination ID: 00000001 00011110 xxxxxxxx.
The values of the bits labeled "x" is irrelevant and shall be ignored by The values of the bits labeled "x" is irrelevant and shall be ignored by
the receiver. the receiver.
Internet draft MEGACO Protocol February 8, 2000
Indicating to the receiver that is must choose a name with 00011110 as Indicating to the receiver that is must choose a name with 00011110 as
the second octet is done as follows: the second octet is done as follows:
wildcarding fields: 00010111 followed by 00000111 wildcarding fields: 00010111 followed by 00000111
Termination ID: xxxxxxxx 00011110 xxxxxxxx. Termination ID: xxxxxxxx 00011110 xxxxxxxx.
The first wildcard field indicates a CHOOSE wildcard for the level in The first wildcard field indicates a CHOOSE wildcard for the level in
the naming hierarchy starting at bit 23, the highest level in our the naming hierarchy starting at bit 23, the highest level in our
assumed naming scheme. The second wildcard field indicates a CHOOSE assumed naming scheme. The second wildcard field indicates a CHOOSE
wildcard for the level in the naming hierarchy starting at bit 7, the wildcard for the level in the naming hierarchy starting at bit 7, the
lowest level in our assumed naming scheme. lowest level in our assumed naming scheme.
Finally, a CHOOSE-wildcarded name with the highest level of the name Finally, a CHOOSE-wildcarded name with the highest level of the name
equal to 00000001 is specified as follows: equal to 00000001 is specified as follows:
Internet draft MEGACO Protocol January 27, 2000
wildcard field: 01001111 wildcard field: 01001111
Termination ID: 0000001 xxxxxxxx xxxxxxxx . Termination ID: 0000001 xxxxxxxx xxxxxxxx .
Bit value 1 at bit position 6 of the first octet of the wildcard field Bit value 1 at bit position 6 of the first octet of the wildcard field
indicates that the wildcarding pertains to the specified level in the indicates that the wildcarding pertains to the specified level in the
naming hierarchy and all lower levels. naming hierarchy and all lower levels.
Context IDs may also be wildcarded. In the case of Context IDs, how- Context IDs may also be wildcarded. In the case of Context IDs, how-
ever, specifying partial names is not allowed. Context ID 0x0 SHALL be ever, specifying partial names is not allowed. Context ID 0x0 SHALL be
used to indicate the NULL Context, Context ID 0xFFFFFFFE SHALL be used used to indicate the NULL Context, Context ID 0xFFFFFFFE SHALL be used
skipping to change at page 73, line 38 skipping to change at page 75, line 5
NOTE - In case a transport mechanism is used that employs application NOTE - In case a transport mechanism is used that employs application
level framing, the definition of Transaction below changes. Refer to level framing, the definition of Transaction below changes. Refer to
the annex defining the transport mechanism for the definition that the annex defining the transport mechanism for the definition that
applies in that case. applies in that case.
NOTE - The ASN.1 specification below contains a clause defining Termina- NOTE - The ASN.1 specification below contains a clause defining Termina-
tionIDList as a sequence of TerminationIDs. The length of this sequence tionIDList as a sequence of TerminationIDs. The length of this sequence
SHALL be one. The SEQUENCE OF construct is present only to allow future SHALL be one. The SEQUENCE OF construct is present only to allow future
extensions. extensions.
Internet draft MEGACO Protocol February 8, 2000
MEDIA-GATEWAY-CONTROL DEFINITIONS AUTOMATIC TAGS::= MEDIA-GATEWAY-CONTROL DEFINITIONS AUTOMATIC TAGS::=
BEGIN BEGIN
MegacoMessage ::= SEQUENCE MegacoMessage ::= SEQUENCE
{ {
authHeader AuthenticationHeader OPTIONAL, authHeader AuthenticationHeader OPTIONAL,
mess Message mess Message
} }
AuthenticationHeader ::= SEQUENCE AuthenticationHeader ::= SEQUENCE
{ {
secParmIndex SecurityParmIndex, secParmIndex SecurityParmIndex,
seqNum SequenceNum, seqNum SequenceNum,
ad AuthData ad AuthData
Internet draft MEGACO Protocol January 27, 2000
} }
SecurityParmIndex ::= OCTET STRING(SIZE(4)) SecurityParmIndex ::= OCTET STRING(SIZE(4))
SequenceNum ::= OCTET STRING(SIZE(4)) SequenceNum ::= OCTET STRING(SIZE(4))
AuthData ::= OCTET STRING (SIZE (16..32)) AuthData ::= OCTET STRING (SIZE (16..32))
Message ::= SEQUENCE Message ::= SEQUENCE
{ {
skipping to change at page 74, line 41 skipping to change at page 76, line 5
domainName DomainName, domainName DomainName,
deviceName PathName, deviceName PathName,
mtpAddress OCTET STRING(SIZE(5)), mtpAddress OCTET STRING(SIZE(5)),
-- Addressing structure of mtpAddress: -- Addressing structure of mtpAddress:
-- 15 0 -- 15 0
-- | PC | NI | -- | PC | NI |
-- 14 bits 2 bits -- 14 bits 2 bits
... ...
} }
Internet draft MEGACO Protocol February 8, 2000
DomainName ::= SEQUENCE DomainName ::= SEQUENCE
{ {
name IA5String, name IA5String,
-- The name starts with an alphanumeric digit followed by a -- The name starts with an alphanumeric digit followed by a
-- sequence of alphanumeric digits, hyphens and dots. No two -- sequence of alphanumeric digits, hyphens and dots. No two
-- dots shall occur consecutively. -- dots shall occur consecutively.
portNumber INTEGER(0..65535) OPTIONAL portNumber INTEGER(0..65535) OPTIONAL
} }
IP4Address ::= SEQUENCE IP4Address ::= SEQUENCE
{ {
address OCTET STRING (SIZE(4)), address OCTET STRING (SIZE(4)),
portNumber INTEGER(0..65535) OPTIONAL portNumber INTEGER(0..65535) OPTIONAL
} }
Internet draft MEGACO Protocol January 27, 2000
IP6Address ::= SEQUENCE IP6Address ::= SEQUENCE
{ {
address OCTET STRING (SIZE(16)), address OCTET STRING (SIZE(16)),
portNumber INTEGER(0..65535) OPTIONAL portNumber INTEGER(0..65535) OPTIONAL
} }
PathName ::= IA5String(SIZE (1..64)) PathName ::= IA5String(SIZE (1..64))
-- See section A.3 -- See section A.3
Transaction ::= CHOICE Transaction ::= CHOICE
skipping to change at page 75, line 40 skipping to change at page 77, line 4
... ...
} }
TransactionPending ::= SEQUENCE TransactionPending ::= SEQUENCE
{ {
transactionId TransactionId, transactionId TransactionId,
... ...
} }
TransactionReply ::= SEQUENCE TransactionReply ::= SEQUENCE
Internet draft MEGACO Protocol February 8, 2000
{ {
transactionId TransactionId, transactionId TransactionId,
transactionResult CHOICE transactionResult CHOICE
{ {
transactionError ErrorDescriptor, transactionError ErrorDescriptor,
actionReplies SEQUENCE OF ActionReply actionReplies SEQUENCE OF ActionReply
}, },
... ...
} }
ErrorDescriptor ::= SEQUENCE ErrorDescriptor ::= SEQUENCE
{ {
errorCode ErrorCode, errorCode ErrorCode,
errorText ErrorText OPTIONAL errorText ErrorText OPTIONAL
Internet draft MEGACO Protocol January 27, 2000
} }
ErrorCode ::= INTEGER(0..65535) ErrorCode ::= INTEGER(0..65535)
-- See section 13 for IANA considerations w.r.t. error codes -- See section 13 for IANA considerations w.r.t. error codes
ErrorText ::= IA5String ErrorText ::= IA5String
ContextID ::= INTEGER(0..4294967295) ContextID ::= INTEGER(0..4294967295)
-- Context NULL Value: 0 -- Context NULL Value: 0
skipping to change at page 76, line 39 skipping to change at page 78, line 4
{ {
contextId ContextID, contextId ContextID,
errorDescriptor ErrorDescriptor OPTIONAL, errorDescriptor ErrorDescriptor OPTIONAL,
contextReply ContextRequest OPTIONAL, contextReply ContextRequest OPTIONAL,
commandReply SEQUENCE OF CommandReply commandReply SEQUENCE OF CommandReply
} }
ContextRequest ::= SEQUENCE ContextRequest ::= SEQUENCE
{ {
priority INTEGER(0..15) OPTIONAL, priority INTEGER(0..15) OPTIONAL,
Internet draft MEGACO Protocol February 8, 2000
emergency BOOLEAN OPTIONAL, emergency BOOLEAN OPTIONAL,
topologyReq SEQUENCE OF TopologyRequest OPTIONAL, topologyReq SEQUENCE OF TopologyRequest OPTIONAL,
... ...
} }
ContextAttrAuditRequest ::= SEQUENCE ContextAttrAuditRequest ::= SEQUENCE
{ {
topology NULL OPTIONAL, topology NULL OPTIONAL,
emergency NULL OPTIONAL, emergency NULL OPTIONAL,
priority NULL OPTIONAL, priority NULL OPTIONAL,
... ...
} }
CommandRequest ::= SEQUENCE CommandRequest ::= SEQUENCE
{ {
Internet draft MEGACO Protocol January 27, 2000
command Command, command Command,
optional NULL OPTIONAL, optional NULL OPTIONAL,
wildcardReturn NULL OPTIONAL, wildcardReturn NULL OPTIONAL,
... ...
} }
Command ::= CHOICE Command ::= CHOICE
{ {
addReq AmmRequest, addReq AmmRequest,
moveReq AmmRequest, moveReq AmmRequest,
skipping to change at page 77, line 41 skipping to change at page 79, line 5
modReply AmmsReply, modReply AmmsReply,
subtractReply AmmsReply, subtractReply AmmsReply,
-- Add, Move, Modify, Subtract replies have the same parameters -- Add, Move, Modify, Subtract replies have the same parameters
auditCapReply AuditReply, auditCapReply AuditReply,
auditValueReply AuditReply, auditValueReply AuditReply,
notifyReply NotifyReply, notifyReply NotifyReply,
serviceChangeReply ServiceChangeReply, serviceChangeReply ServiceChangeReply,
... ...
} }
Internet draft MEGACO Protocol February 8, 2000
TopologyRequest ::= SEQUENCE TopologyRequest ::= SEQUENCE
{ {
terminationFrom TerminationID, terminationFrom TerminationID,
terminationTo TerminationID, terminationTo TerminationID,
topologyDirection ENUMERATED topologyDirection ENUMERATED
{ {
bothway(0), bothway(0),
isolate(1), isolate(1),
oneway(2) oneway(2)
} }
} }
AmmRequest ::= SEQUENCE AmmRequest ::= SEQUENCE
{ {
Internet draft MEGACO Protocol January 27, 2000
terminationID TerminationIDList, terminationID TerminationIDList,
mediaDescriptor MediaDescriptor OPTIONAL, mediaDescriptor MediaDescriptor OPTIONAL,
modemDescriptor ModemDescriptor OPTIONAL, modemDescriptor ModemDescriptor OPTIONAL,
muxDescriptor MuxDescriptor OPTIONAL, muxDescriptor MuxDescriptor OPTIONAL,
eventsDescriptor EventsDescriptor OPTIONAL, eventsDescriptor EventsDescriptor OPTIONAL,
eventBufferDescriptor EventBufferDescriptor OPTIONAL, eventBufferDescriptor EventBufferDescriptor OPTIONAL,
signalsDescriptor SignalsDescriptor OPTIONAL, signalsDescriptor SignalsDescriptor OPTIONAL,
digitMapDescriptor DigitMapDescriptor OPTIONAL, digitMapDescriptor DigitMapDescriptor OPTIONAL,
auditDescriptor AuditDescriptor OPTIONAL, auditDescriptor AuditDescriptor OPTIONAL,
... ...
skipping to change at page 78, line 34 skipping to change at page 79, line 48
SubtractRequest ::= SEQUENCE SubtractRequest ::= SEQUENCE
{ {
terminationID TerminationIDList, terminationID TerminationIDList,
auditDescriptor AuditDescriptor OPTIONAL auditDescriptor AuditDescriptor OPTIONAL
} }
AuditRequest ::= SEQUENCE AuditRequest ::= SEQUENCE
{ {
terminationID TerminationID, terminationID TerminationID,
auditDescriptor AuditDescriptor OPTIONAL auditDescriptor AuditDescriptor
} }
AuditReply ::= SEQUENCE AuditReply ::= SEQUENCE
{ {
terminationID TerminationID, terminationID TerminationID,
auditResult AuditResult auditResult AuditResult
Internet draft MEGACO Protocol February 8, 2000
} }
AuditResult ::= CHOICE AuditResult ::= CHOICE
{ {
contextAuditResult TerminationIDList, contextAuditResult TerminationIDList,
terminationAuditResult TerminationAudit terminationAuditResult TerminationAudit
} }
AuditDescriptor ::= SEQUENCE AuditDescriptor ::= SEQUENCE
{ {
auditToken BIT STRING auditToken BIT STRING
{ {
Internet draft MEGACO Protocol January 27, 2000
muxToken(0), modemToken(1), mediaToken(2), muxToken(0), modemToken(1), mediaToken(2),
eventsToken(3), signalsToken(4), eventsToken(3), signalsToken(4),
digitMapToken(5), statsToken(6), digitMapToken(5), statsToken(6),
observedEventsToken(7), observedEventsToken(7),
packagesToken(8), eventBufferToken(9) packagesToken(8), eventBufferToken(9)
} OPTIONAL, } OPTIONAL,
... ...
} }
TerminationAudit ::= SEQUENCE OF AuditReturnParameter TerminationAudit ::= SEQUENCE OF AuditReturnParameter
skipping to change at page 79, line 41 skipping to change at page 81, line 5
... ...
} }
NotifyRequest ::= SEQUENCE NotifyRequest ::= SEQUENCE
{ {
terminationID TerminationIDList, terminationID TerminationIDList,
observedEventsDescriptor ObservedEventsDescriptor, observedEventsDescriptor ObservedEventsDescriptor,
errorDescriptor ErrorDescriptor OPTIONAL errorDescriptor ErrorDescriptor OPTIONAL
} }
Internet draft MEGACO Protocol February 8, 2000
NotifyReply ::= SEQUENCE NotifyReply ::= SEQUENCE
{ {
terminationID TerminationIDList OPTIONAL, terminationID TerminationIDList OPTIONAL,
errorDescriptor ErrorDescriptor OPTIONAL errorDescriptor ErrorDescriptor OPTIONAL
} }
ObservedEventsDescriptor ::= SEQUENCE ObservedEventsDescriptor ::= SEQUENCE
{ {
requestId RequestID, requestId RequestID,
observedEventLst SEQUENCE OF ObservedEvent observedEventLst SEQUENCE OF ObservedEvent
} }
ObservedEvent ::= SEQUENCE ObservedEvent ::= SEQUENCE
{ {
Internet draft MEGACO Protocol January 27, 2000
eventName EventName, eventName EventName,
streamID StreamID OPTIONAL, streamID StreamID OPTIONAL,
eventParList SEQUENCE OF EventParameter, eventParList SEQUENCE OF EventParameter,
timeNotation TimeNotation OPTIONAL timeNotation TimeNotation OPTIONAL
} }
EventName ::= PkgdName EventName ::= PkgdName
EventParameter ::= SEQUENCE EventParameter ::= SEQUENCE
{ {
skipping to change at page 80, line 42 skipping to change at page 82, line 5
-- For ServiceChangeResult, no parameters are mandatory. Hence the -- For ServiceChangeResult, no parameters are mandatory. Hence the
-- distinction between ServiceChangeParm and ServiceChangeResParm. -- distinction between ServiceChangeParm and ServiceChangeResParm.
ServiceChangeResult ::= CHOICE ServiceChangeResult ::= CHOICE
{ {
errorDescriptor ErrorDescriptor, errorDescriptor ErrorDescriptor,
serviceChangeResParms ServiceChangeResParm serviceChangeResParms ServiceChangeResParm
} }
Internet draft MEGACO Protocol February 8, 2000
WildcardField ::= OCTET STRING(SIZE(1)) WildcardField ::= OCTET STRING(SIZE(1))
TerminationID ::= SEQUENCE TerminationID ::= SEQUENCE
{ {
wildcard SEQUENCE OF WildcardField, wildcard SEQUENCE OF WildcardField,
id OCTET STRING(SIZE(1..8)) id OCTET STRING(SIZE(1..8))
} }
-- See Section A.1 for explanation of wildcarding mechanism. -- See Section A.1 for explanation of wildcarding mechanism.
-- Termination ID 0xFFFFFFFFFFFFFFFF indicates the ROOT Termination. -- Termination ID 0xFFFFFFFFFFFFFFFF indicates the ROOT Termination.
TerminationIDList ::= SEQUENCE OF TerminationID TerminationIDList ::= SEQUENCE OF TerminationID
MediaDescriptor ::= SEQUENCE MediaDescriptor ::= SEQUENCE
Internet draft MEGACO Protocol January 27, 2000
{ {
termStateDescr TerminationStateDescriptor OPTIONAL, termStateDescr TerminationStateDescriptor OPTIONAL,
streams CHOICE streams CHOICE
{ {
oneStream StreamParms, oneStream StreamParms,
multiStream SEQUENCE OF StreamDescriptor multiStream SEQUENCE OF StreamDescriptor
}, },
... ...
} }
skipping to change at page 81, line 42 skipping to change at page 83, line 4
LocalControlDescriptor ::= SEQUENCE LocalControlDescriptor ::= SEQUENCE
{ {
streamMode StreamMode OPTIONAL, streamMode StreamMode OPTIONAL,
reserve BOOLEAN, reserve BOOLEAN,
propertyParms SEQUENCE OF PropertyParm, propertyParms SEQUENCE OF PropertyParm,
... ...
} }
StreamMode ::= ENUMERATED StreamMode ::= ENUMERATED
{ {
Internet draft MEGACO Protocol February 8, 2000
sendOnly(0), sendOnly(0),
recvOnly(1), recvOnly(1),
sendRecv(2), sendRecv(2),
inactive(3), inactive(3),
loopBack(4), loopBack(4),
delete(5),
... ...
} }
-- In PropertyParm, value is a SEQUENCE OF octet string. When sent -- In PropertyParm, value is a SEQUENCE OF octet string. When sent
-- by an MGC the interpretation is as follows: -- by an MGC the interpretation is as follows:
-- empty sequence means CHOOSE -- empty sequence means CHOOSE
-- one element sequence specifies value -- one element sequence specifies value
Internet draft MEGACO Protocol January 27, 2000
-- longer sequence means "choose one of the values" -- longer sequence means "choose one of the values"
-- The relation field may only be selected if the value sequence -- The relation field may only be selected if the value sequence
-- has length 1. It indicates that the MG has to choose a value -- has length 1. It indicates that the MG has to choose a value
-- for the property. E.g., x > 3 (using the greaterThan -- for the property. E.g., x > 3 (using the greaterThan
-- value for relation) instructs the MG to choose any value larger -- value for relation) instructs the MG to choose any value larger
-- than 3 for property x. -- than 3 for property x.
-- The range field may only be selected if the value sequence -- The range field may only be selected if the value sequence
-- has length 2. It indicates that the MG has to choose a value -- has length 2. It indicates that the MG has to choose a value
-- in the range between the first octet in the value sequence and -- in the range between the first octet in the value sequence and
-- the trailing octet in the value sequence, including the -- the trailing octet in the value sequence, including the
skipping to change at page 82, line 38 skipping to change at page 83, line 50
range BOOLEAN range BOOLEAN
} OPTIONAL } OPTIONAL
} }
Name ::= OCTET STRING(SIZE(2)) Name ::= OCTET STRING(SIZE(2))
PkgdName ::= OCTET STRING(SIZE(4)) PkgdName ::= OCTET STRING(SIZE(4))
-- represents Package Name (2 octets) plus Property Name (2 octets) -- represents Package Name (2 octets) plus Property Name (2 octets)
-- To wildcard a package use 0xFFFF for first two octets, choose -- To wildcard a package use 0xFFFF for first two octets, choose
-- is not allowed. Wildcard of a package name is permitted only if
-- Property Name is also wildcarded. To reference native property
-- tag specified in Annex C, use 0x0000 as first two octets.
Relation ::= ENUMERATED Relation ::= ENUMERATED
Internet draft MEGACO Protocol February 8, 2000
{ {
greaterThan(0), greaterThan(0),
smallerThan(1), smallerThan(1),
unequalTo(2), unequalTo(2),
... ...
} }
LocalRemoteDescriptor ::= SEQUENCE LocalRemoteDescriptor ::= SEQUENCE
{ {
propGrps SEQUENCE OF PropertyGroup, propGrps SEQUENCE OF PropertyGroup,
... ...
} }
Internet draft MEGACO Protocol January 27, 2000
PropertyGroup ::= SEQUENCE OF PropertyParm PropertyGroup ::= SEQUENCE OF PropertyParm
TerminationStateDescriptor ::= SEQUENCE TerminationStateDescriptor ::= SEQUENCE
{ {
propertyParms SEQUENCE OF PropertyParm, propertyParms SEQUENCE OF PropertyParm,
eventBufferFlag BOOLEAN, eventBufferFlag BOOLEAN,
serviceState ServiceState OPTIONAL, serviceState ServiceState OPTIONAL,
... ...
} }
skipping to change at page 83, line 43 skipping to change at page 85, line 5
{ {
h221(0), h221(0),
h223(1), h223(1),
h226(2), h226(2),
v76(3), v76(3),
... ...
} }
StreamID ::= INTEGER(0..65535) -- 16 bit unsigned integer StreamID ::= INTEGER(0..65535) -- 16 bit unsigned integer
Internet draft MEGACO Protocol February 8, 2000
EventsDescriptor ::= SEQUENCE EventsDescriptor ::= SEQUENCE
{ {
requestID RequestID, requestID RequestID,
eventList SEQUENCE OF RequestedEvent eventList SEQUENCE OF RequestedEvent
} }
RequestedEvent ::= SEQUENCE RequestedEvent ::= SEQUENCE
{ {
pkgdName PkgdName, pkgdName PkgdName,
streamID StreamID OPTIONAL, streamID StreamID OPTIONAL,
eventAction RequestedActions OPTIONAL, eventAction RequestedActions OPTIONAL,
evParList SEQUENCE OF EventParameter evParList SEQUENCE OF EventParameter
Internet draft MEGACO Protocol January 27, 2000
} }
RequestedActions ::= SEQUENCE RequestedActions ::= SEQUENCE
{ {
keepActive BOOLEAN, keepActive BOOLEAN,
eventDM EventDM OPTIONAL, eventDM EventDM OPTIONAL,
secondEvent SecondEventsDescriptor OPTIONAL, secondEvent SecondEventsDescriptor OPTIONAL,
signalsDescriptor SignalsDescriptor OPTIONAL, signalsDescriptor SignalsDescriptor OPTIONAL,
... ...
} }
skipping to change at page 84, line 42 skipping to change at page 86, line 4
streamID StreamID OPTIONAL, streamID StreamID OPTIONAL,
eventAction SecondRequestedActions OPTIONAL, eventAction SecondRequestedActions OPTIONAL,
evParList SEQUENCE OF EventParameter evParList SEQUENCE OF EventParameter
} }
SecondRequestedActions ::= SEQUENCE SecondRequestedActions ::= SEQUENCE
{ {
keepActive BOOLEAN, keepActive BOOLEAN,
eventDM EventDM OPTIONAL, eventDM EventDM OPTIONAL,
signalsDescriptor SignalsDescriptor OPTIONAL, signalsDescriptor SignalsDescriptor OPTIONAL,
Internet draft MEGACO Protocol February 8, 2000
... ...
} }
EventBufferDescriptor ::= SEQUENCE OF ObservedEvent EventBufferDescriptor ::= SEQUENCE OF ObservedEvent
SignalsDescriptor ::= SEQUENCE OF SignalRequest SignalsDescriptor ::= SEQUENCE OF SignalRequest
SignalRequest ::=CHOICE SignalRequest ::=CHOICE
{ {
signal Signal, signal Signal,
seqSigList SeqSigList seqSigList SeqSigList
} }
Internet draft MEGACO Protocol January 27, 2000
SeqSigList ::= SEQUENCE SeqSigList ::= SEQUENCE
{ {
id INTEGER(0..65535), id INTEGER(0..65535),
signalList SEQUENCE OF Signal signalList SEQUENCE OF Signal
} }
Signal ::= SEQUENCE Signal ::= SEQUENCE
{ {
signalName SignalName, signalName SignalName,
streamID StreamID OPTIONAL, streamID StreamID OPTIONAL,
sigType SignalType OPTIONAL, sigType SignalType OPTIONAL,
duration INTEGER (0..65535) OPTIONAL, duration INTEGER (0..65535) OPTIONAL,
notifyCompletion RequestID OPTIONAL, notifyCompletion BOOLEAN,
sigParList SEQUENCE OF SigParameter sigParList SEQUENCE OF SigParameter
} }
SignalType ::= ENUMERATED SignalType ::= ENUMERATED
{ {
brief(0), brief(0),
onOff(1), onOff(1),
timeOut(2), timeOut(2),
... ...
} }
skipping to change at page 85, line 42 skipping to change at page 87, line 4
SigParameter ::= SEQUENCE SigParameter ::= SEQUENCE
{ {
sigParameterName Name, sigParameterName Name,
value Value value Value
} }
RequestID ::= INTEGER(0..4294967295) -- 32 bit unsigned integer RequestID ::= INTEGER(0..4294967295) -- 32 bit unsigned integer
ModemDescriptor ::= SEQUENCE ModemDescriptor ::= SEQUENCE
Internet draft MEGACO Protocol February 8, 2000
{ {
mtl SEQUENCE OF ModemType, mtl SEQUENCE OF ModemType,
mpl SEQUENCE OF PropertyParm mpl SEQUENCE OF PropertyParm
} }
ModemType ::= ENUMERATED ModemType ::= ENUMERATED
{ {
v18(0), v18(0),
v22(1), v22(1),
v22bis(2), v22bis(2),
v32(3), v32(3),
v32bis(4), v32bis(4),
Internet draft MEGACO Protocol January 27, 2000
v34(5), v34(5),
v90(6), v90(6),
v91(7), v91(7),
synchISDN(8), synchISDN(8),
... ...
} }
DigitMapDescriptor ::= SEQUENCE DigitMapDescriptor ::= SEQUENCE
{ {
digitMapName DigitMapName, digitMapName DigitMapName,
skipping to change at page 86, line 42 skipping to change at page 88, line 4
{ {
serviceChangeMethod ServiceChangeMethod, serviceChangeMethod ServiceChangeMethod,
serviceChangeAddress ServiceChangeAddress OPTIONAL, serviceChangeAddress ServiceChangeAddress OPTIONAL,
serviceChangeVersion INTEGER(0..99) OPTIONAL, serviceChangeVersion INTEGER(0..99) OPTIONAL,
serviceChangeProfile ServiceChangeProfile OPTIONAL, serviceChangeProfile ServiceChangeProfile OPTIONAL,
serviceChangeReason Value, serviceChangeReason Value,
serviceChangeDelay INTEGER(0..4294967295) OPTIONAL, serviceChangeDelay INTEGER(0..4294967295) OPTIONAL,
-- 32 bit unsigned integer -- 32 bit unsigned integer
serviceChangeMgcId MId OPTIONAL, serviceChangeMgcId MId OPTIONAL,
timeStamp TimeNotation OPTIONAL, timeStamp TimeNotation OPTIONAL,
Internet draft MEGACO Protocol February 8, 2000
} }
ServiceChangeAddress ::= CHOICE ServiceChangeAddress ::= CHOICE
{ {
portNumber INTEGER(0..65535), -- TCP/UDP port number portNumber INTEGER(0..65535), -- TCP/UDP port number
ip4Address IP4Address, ip4Address IP4Address,
ip6Address IP6Address, ip6Address IP6Address,
domainName DomainName, domainName DomainName,
deviceName PathName, deviceName PathName,
mtpAddress OCTET STRING(SIZE(5)), mtpAddress OCTET STRING(SIZE(5)),
... ...
} }
Internet draft MEGACO Protocol January 27, 2000
ServiceChangeResParm ::= SEQUENCE ServiceChangeResParm ::= SEQUENCE
{ {
serviceChangeMgcId MId OPTIONAL, serviceChangeMgcId MId OPTIONAL,
serviceChangeAddress ServiceChangeAddress OPTIONAL, serviceChangeAddress ServiceChangeAddress OPTIONAL,
serviceChangeVersion INTEGER(0..99) OPTIONAL, serviceChangeVersion INTEGER(0..99) OPTIONAL,
serviceChangeProfile ServiceChangeProfile OPTIONAL serviceChangeProfile ServiceChangeProfile OPTIONAL
} }
ServiceChangeMethod ::= ENUMERATED ServiceChangeMethod ::= ENUMERATED
{ {
skipping to change at page 87, line 42 skipping to change at page 89, line 5
PackagesDescriptor ::= SEQUENCE OF PackagesItem PackagesDescriptor ::= SEQUENCE OF PackagesItem
PackagesItem ::= SEQUENCE PackagesItem ::= SEQUENCE
{ {
packageName Name, packageName Name,
packageVersion INTEGER(0..99) packageVersion INTEGER(0..99)
} }
StatisticsDescriptor ::= SEQUENCE OF StatisticsParameter StatisticsDescriptor ::= SEQUENCE OF StatisticsParameter
Internet draft MEGACO Protocol February 8, 2000
StatisticsParameter ::= SEQUENCE StatisticsParameter ::= SEQUENCE
{ {
statName PkgdName, statName PkgdName,
statValue Value statValue Value
} }
TimeNotation ::= SEQUENCE TimeNotation ::= SEQUENCE
{ {
date IA5String(SIZE(8)), -- yyyymmdd format date IA5String(SIZE(8)), -- yyyymmdd format
time IA5String(SIZE(8)) -- hhmmssss format time IA5String(SIZE(8)) -- hhmmssss format
} }
Value ::= OCTET STRING Value ::= OCTET STRING
Internet draft MEGACO Protocol January 27, 2000
END END
A.3. Digit maps and path names A.3. Digit maps and path names
>From a syntactic viewpoint, digit maps are strings with syntactic res- >From a syntactic viewpoint, digit maps are strings with syntactic res-
trictions imposed upon them. The syntax of valid digit maps is specified trictions imposed upon them. The syntax of valid digit maps is specified
in ABNF [RFC 2119]. The syntax for digit maps presented in this section in ABNF [RFC 2119]. The syntax for digit maps presented in this section
is for illustrative purposes only. The definition of digitMap in Annex B is for illustrative purposes only. The definition of digitMap in Annex B
takes precedence in the case of differences between the two. takes precedence in the case of differences between the two.
digitMap = (digitString / LWSP "(" LWSP digitStringList LWSP digitMap = (digitString / LWSP "(" LWSP digitStringList LWSP
")" LWSP) ")" LWSP)
digitStringList = digitString *( LWSP "/" LWSP digitString ) digitStringList = digitString *( LWSP "/" LWSP digitString )
digitString = 1*(digitStringElement) digitString = 1*(digitStringElement)
digitStringElement = digitPosition [DOT] digitStringElement = digitPosition [DOT]
digitPosition = digitMapLetter / digitMapRange digitPosition = digitMapLetter / digitMapRange
digitMapRange = ("x" / LWSP "[" LWSP digitLetter LWSP "]" LWSP) digitMapRange = ("x" / LWSP "[" LWSP digitLetter LWSP "]" LWSP)
digitLetter = *((DIGIT "-" DIGIT) / ditigMapLetter) digitLetter = *((DIGIT "-" DIGIT) / digitMapLetter)
digitMapLetter = DIGIT / "#" / "*" / "A" / "B" / "C" / "D" / digitMapLetter = DIGIT / %x41-4B / %x61-6B / ; Mapped events 0-9,
; DTMF digits ; A-K (a-k)
"S"/ "L" / ; timers (short, long) "L" ; Long duration modifier
MFSig
MFSig = "K0" / "K1" / "K2" / "S0" / "S1" / "S2" / "S3"
LWSP = *(WSP / COMMENT / EOL) LWSP = *(WSP / COMMENT / EOL)
WSP = SP / HTAB WSP = SP / HTAB
COMMENT = ";" *(SafeChar / RestChar / WSP) EOL COMMENT = ";" *(SafeChar / RestChar / WSP) EOL
EOL = (CR [LF]) / LF EOL = (CR [LF]) / LF
SP = %x20 SP = %x20
HTAB = %x09 HTAB = %x09
CR = &x0D CR = &x0D
LF = %x0A LF = %x0A
SafeChar = DIGIT / ALPHA / "+" / "-" / "&" / "!" / "_" / "/" / SafeChar = DIGIT / ALPHA / "+" / "-" / "&" / "!" / "_" / "/" /
"'" / "?" / "@" / "^" / "`" / "~" / "*" / "$" / " "'" / "?" / "@" / "^" / "`" / "~" / "*" / "$" / "
Internet draft MEGACO Protocol February 8, 2000
"(" / ")" / "%" / "." "(" / ")" / "%" / "."
RestChar = ";" / "[" / "]" / "{" / "}" / ":" / "," / "#" / RestChar = ";" / "[" / "]" / "{" / "}" / ":" / "," / "#" /
"<" / ">" / "=" / %x22 "<" / ">" / "=" / %x22
DIGIT = %x30-39 ; digits 0 through 9 DIGIT = %x30-39 ; digits 0 through 9
ALPHA = %x41-5A / %x61-7A ; A-Z, a-z ALPHA = %x41-5A / %x61-7A ; A-Z, a-z
A path name is also a string with syntactic restrictions imposed upon A path name is also a string with syntactic restrictions imposed upon
it. The ABNF production defining it is copied from Annex B. it. The ABNF production defining it is copied from Annex B.
PathName = NAME *(["/"] ["*"] ["@"] (ALPHA / DIGIT)) ["*"] PathName = NAME *(["/"] ["*"] ["@"] (ALPHA / DIGIT)) ["*"]
NAME = ALPHA *63(ALPHA / DIGIT / "_" ) NAME = ALPHA *63(ALPHA / DIGIT / "_" )
Internet draft MEGACO Protocol January 27, 2000
ANNEX B TEXT ENCODING OF THE PROTOCOL (NORMATIVE) ANNEX B TEXT ENCODING OF THE PROTOCOL (NORMATIVE)
B.1. Coding of wildcards B.1. Coding of wildcards
In a text encoding of the protocol, while TerminationIDs are arbitrary, In a text encoding of the protocol, while TerminationIDs are arbitrary,
by judicious choice of names, the wildcard character, "*" may be made by judicious choice of names, the wildcard character, "*" may be made
more useful. When the wildcard character is encountered, it will more useful. When the wildcard character is encountered, it will
"match" all TerminationIDs having the same previous and following char- "match" all TerminationIDs having the same previous and following char-
acters (if appropriate). For example, if there were TerminationIDs of acters (if appropriate). For example, if there were TerminationIDs of
R13/3/1, R13/3/2 and R13/3/3, the TerminationID R13/3/* would match all R13/3/1, R13/3/2 and R13/3/3, the TerminationID R13/3/* would match all
skipping to change at page 89, line 38 skipping to change at page 91, line 4
megacoMessage = LWSP [authenticationHeader SEP ] message megacoMessage = LWSP [authenticationHeader SEP ] message
authenticationHeader = AuthToken EQUAL SecurityParmIndex COLON authenticationHeader = AuthToken EQUAL SecurityParmIndex COLON
SequenceNum COLON AuthData SequenceNum COLON AuthData
SecurityParmIndex = "0x" 8(HEXDIG) SecurityParmIndex = "0x" 8(HEXDIG)
SequenceNum = "0x" 8(HEXDIG) SequenceNum = "0x" 8(HEXDIG)
AuthData = "0x" 32*64(HEXDIG) AuthData = "0x" 32*64(HEXDIG)
message = MegacopToken SLASH Version SEP mId SEP message = MegacopToken SLASH Version SEP mId SEP
Internet draft MEGACO Protocol February 8, 2000
messageBody messageBody
messageBody = ( errorDescriptor / transactionList ) messageBody = ( errorDescriptor / transactionList )
transactionList = 1*( transactionRequest / transactionReply / transactionList = 1*( transactionRequest / transactionReply /
transactionPending) transactionPending)
transactionPending = PendingToken EQUAL TransactionID LBRKT RBRKT transactionPending = PendingToken EQUAL TransactionID LBRKT RBRKT
transactionRequest = TransToken EQUAL TransactionID LBRKT transactionRequest = TransToken EQUAL TransactionID LBRKT
actionRequest *(COMMA actionRequest) RBRKT actionRequest *(COMMA actionRequest) RBRKT
actionRequest = CtxToken EQUAL ContextID LBRKT (( actionRequest = CtxToken EQUAL ContextID LBRKT ((
contextRequest [COMMA commandRequestList]) contextRequest [COMMA commandRequestList])
/ commandRequestList) RBRKT / commandRequestList) RBRKT
Internet draft MEGACO Protocol January 27, 2000
contextRequest = ((contextAudit [COMMA contextProperties]) contextRequest = ((contextAudit [COMMA contextProperties])
/ contextProperties) / contextProperties)
contextProperties = contextProperty *(COMMA contextProperty) contextProperties = contextProperty *(COMMA contextProperty)
; at-most-once ; at-most-once
contextProperty = (topologyDescriptor / priority / contextProperty = (topologyDescriptor / priority /
EmergencyToken) EmergencyToken)
contextAudit = ContextAuditToken LBRKT contextAudit = ContextAuditToken LBRKT
skipping to change at page 90, line 40 skipping to change at page 92, line 5
( errorDescriptor / actionReplyList ) RBRKT ( errorDescriptor / actionReplyList ) RBRKT
actionReplyList = actionReply *(COMMA actionReply ) actionReplyList = actionReply *(COMMA actionReply )
actionReply = CtxToken EQUAL ContextID LBRKT actionReply = CtxToken EQUAL ContextID LBRKT
( errorDescriptor / commandReply ) RBRKT ( errorDescriptor / commandReply ) RBRKT
commandReply = (( contextProperties [COMMA commandReplyList] ) / commandReply = (( contextProperties [COMMA commandReplyList] ) /
commandReplyList ) commandReplyList )
Internet draft MEGACO Protocol February 8, 2000
commandReplyList = commandReplys *(COMMA commandReplys ) commandReplyList = commandReplys *(COMMA commandReplys )
commandReplys = (serviceChangeReply / auditReply / ammsReply / commandReplys = (serviceChangeReply / auditReply / ammsReply /
notifyReply ) notifyReply )
;Add Move and Modify have the same request parameters ;Add Move and Modify have the same request parameters
ammRequest = (AddToken / MoveToken / ModifyToken ) EQUAL ammRequest = (AddToken / MoveToken / ModifyToken ) EQUAL
TerminationID [LBRKT ammParameter *(COMMA TerminationID [LBRKT ammParameter *(COMMA
ammParameter) RBRKT] ammParameter) RBRKT]
;at-most-once ;at-most-once
ammParameter = (mediaDescriptor / modemDescriptor / ammParameter = (mediaDescriptor / modemDescriptor /
muxDescriptor / eventsDescriptor / muxDescriptor / eventsDescriptor /
signalsDescriptor / digitMapDescriptor / signalsDescriptor / digitMapDescriptor /
Internet draft MEGACO Protocol January 27, 2000
eventBufferDescriptor / auditDescriptor) eventBufferDescriptor / auditDescriptor)
ammsReply = (AddToken / MoveToken / ModifyToken / ammsReply = (AddToken / MoveToken / ModifyToken /
SubtractToken ) EQUAL TerminationID [ LBRKT SubtractToken ) EQUAL TerminationID [ LBRKT
terminationAudit RBRKT ] terminationAudit RBRKT ]
subtractRequest = ["W-"] SubtractToken EQUAL TerminationID subtractRequest = ["W-"] SubtractToken EQUAL TerminationID
[ LBRKT auditDescriptor RBRKT] [ LBRKT auditDescriptor RBRKT]
auditRequest = ["W-"] (AuditValueToken / AuditCapToken ) EQUAL auditRequest = ["W-"] (AuditValueToken / AuditCapToken ) EQUAL
TerminationID [ LBRKT auditDescriptor RBRKT ] TerminationID LBRKT auditDescriptor RBRKT
auditReply = (AuditValueToken / AuditCapToken ) auditReply = (AuditValueToken / AuditCapToken )
( contextTerminationAudit / auditOther) ( contextTerminationAudit / auditOther)
auditOther = EQUAL TerminationID LBRKT auditOther = EQUAL TerminationID LBRKT
terminationAudit RBRKT terminationAudit RBRKT
terminationAudit = auditReturnParameter *(COMMA auditReturnParameter) terminationAudit = auditReturnParameter *(COMMA auditReturnParameter)
contextTerminationAudit = EQUAL CtxToken ( terminationIDList / contextTerminationAudit = EQUAL CtxToken ( terminationIDList /
skipping to change at page 91, line 41 skipping to change at page 93, line 4
muxDescriptor / eventsDescriptor / muxDescriptor / eventsDescriptor /
signalsDescriptor / digitMapDescriptor / signalsDescriptor / digitMapDescriptor /
observedEventsDescriptor / eventBufferDescriptor / observedEventsDescriptor / eventBufferDescriptor /
statisticsDescriptor / packagesDescriptor / statisticsDescriptor / packagesDescriptor /
errorDescriptor ) errorDescriptor )
auditDescriptor = AuditToken LBRKT [ auditItem auditDescriptor = AuditToken LBRKT [ auditItem
*(COMMA auditItem) ] RBRKT *(COMMA auditItem) ] RBRKT
notifyRequest = NotifyToken EQUAL TerminationID notifyRequest = NotifyToken EQUAL TerminationID
Internet draft MEGACO Protocol February 8, 2000
LBRKT ( observedEventsDescriptor / LBRKT ( observedEventsDescriptor /
errorDescriptor ) RBRKT errorDescriptor ) RBRKT
notifyReply = NotifyToken EQUAL TerminationID notifyReply = NotifyToken EQUAL TerminationID
[ LBRKT errorDescriptor RBRKT ] [ LBRKT errorDescriptor RBRKT ]
serviceChangeRequest = ServiceChangeToken EQUAL TerminationID serviceChangeRequest = ServiceChangeToken EQUAL TerminationID
LBRKT serviceChangeDescriptor RBRKT LBRKT serviceChangeDescriptor RBRKT
serviceChangeReply = ServiceChangeToken EQUAL TerminationID serviceChangeReply = ServiceChangeToken EQUAL TerminationID
[LBRKT (errorDescriptor / [LBRKT (errorDescriptor /
serviceChangeReplyDescriptor) RBRKT] serviceChangeReplyDescriptor) RBRKT]
errorDescriptor = ErrorToken EQUAL ErrorCode errorDescriptor = ErrorToken EQUAL ErrorCode
Internet draft MEGACO Protocol January 27, 2000
LBRKT [quotedString] RBRKT LBRKT [quotedString] RBRKT
ErrorCode = 1*3(DIGIT) ; could be extended ErrorCode = 1*4(DIGIT) ; could be extended
TransactionID = UINT32 TransactionID = UINT32
mId = (( domainAddress / domainName ) mId = (( domainAddress / domainName )
[":" portNumber]) / mtpAddress / deviceName [":" portNumber]) / mtpAddress / deviceName
; ABNF allows two or more consecutive "." although it is meaningless ; ABNF allows two or more consecutive "." although it is meaningless
; in a domain name. ; in a domain name.
domainName = "<" (ALPHA / DIGIT) *63(ALPHA / DIGIT / "-" / domainName = "<" (ALPHA / DIGIT) *63(ALPHA / DIGIT / "-" /
".") ">" ".") ">"
skipping to change at page 92, line 41 skipping to change at page 94, line 5
hexpart = hexseq "::" [ hexseq ] / "::" [ hexseq ] / hexpart = hexseq "::" [ hexseq ] / "::" [ hexseq ] /
hexseq hexseq
hexseq = hex4 *( ":" hex4) hexseq = hex4 *( ":" hex4)
hex4 = 1*4HEXDIG hex4 = 1*4HEXDIG
portNumber = UINT16 portNumber = UINT16
; An mtp address is five octets long ; An mtp address is five octets long
mtpAddress = MTPToken LBRKT octetString RBRKT mtpAddress = MTPToken LBRKT octetString RBRKT
Internet draft MEGACO Protocol February 8, 2000
terminationIDList = LBRKT TerminationID *(COMMA TerminationID) terminationIDList = LBRKT TerminationID *(COMMA TerminationID)
RBRKT RBRKT
; Total length of pathNAME must not exceed 64 chars. ; Total length of pathNAME must not exceed 64 chars.
pathNAME = ["*"] NAME *("/" / "*"/ ALPHA / DIGIT /"_" / "$" ) pathNAME = ["*"] NAME *("/" / "*"/ ALPHA / DIGIT /"_" / "$" )
["@" pathDomainName ] ["@" pathDomainName ]
; ABNF allows two or more consecutive "." although it is meaningless ; ABNF allows two or more consecutive "." although it is meaningless
; in a path domain name. ; in a path domain name.
pathDomainName = (ALPHA / DIGIT / "*" ) pathDomainName = (ALPHA / DIGIT / "*" )
*63(ALPHA / DIGIT / "-" / "*" / ".") *63(ALPHA / DIGIT / "-" / "*" / ".")
TerminationID = "ROOT" / pathNAME / "$" / "*" TerminationID = "ROOT" / pathNAME / "$" / "*"
Internet draft MEGACO Protocol January 27, 2000
mediaDescriptor = MediaToken LBRKT mediaParm *(COMMA mediaParm) RBRKT mediaDescriptor = MediaToken LBRKT mediaParm *(COMMA mediaParm) RBRKT
; at-most-once per item ; at-most-once per item
; and either streamParm or streamDescriptor but not both ; and either streamParm or streamDescriptor but not both
mediaParm = (streamParm / streamDescriptor / mediaParm = (streamParm / streamDescriptor /
terminationStateDescriptor) terminationStateDescriptor)
; at-most-once ; at-most-once
streamParm = ( localDescriptor / remoteDescriptor / streamParm = ( localDescriptor / remoteDescriptor /
localControlDescriptor ) localControlDescriptor )
skipping to change at page 93, line 32 skipping to change at page 94, line 46
*(COMMA localParm) RBRKT *(COMMA localParm) RBRKT
; at-most-once per item ; at-most-once per item
localParm = ( streamMode / propertyParm / reservedMode) localParm = ( streamMode / propertyParm / reservedMode)
reservedMode = ReservedToken EQUAL ( "ON" / "OFF" ) reservedMode = ReservedToken EQUAL ( "ON" / "OFF" )
streamMode = ModeToken EQUAL streamModes streamMode = ModeToken EQUAL streamModes
streamModes = (SendonlyToken / RecvonlyToken / SendrecvToken / streamModes = (SendonlyToken / RecvonlyToken / SendrecvToken /
InactiveToken / LoopbackToken / DeleteToken ) InactiveToken / LoopbackToken )
propertyParm = pkgdName parmValue propertyParm = pkgdName parmValue
parmValue = (EQUAL alternativeValue/ INEQUAL VALUE) parmValue = (EQUAL alternativeValue/ INEQUAL VALUE)
alternativeValue = ( VALUE / LSBRKT VALUE *(COMMA VALUE) RSBRKT / alternativeValue = ( VALUE / LSBRKT VALUE *(COMMA VALUE) RSBRKT /
LSBRKT VALUE DOT DOT VALUE RSBRKT ) LSBRKT VALUE DOT DOT VALUE RSBRKT )
INEQUAL = LWSP (">" / "<" / "#" ) LWSP INEQUAL = LWSP (">" / "<" / "#" ) LWSP
LSBRKT = LWSP "[" LWSP LSBRKT = LWSP "[" LWSP
Internet draft MEGACO Protocol February 8, 2000
RSBRKT = LWSP "]" LWSP RSBRKT = LWSP "]" LWSP
localDescriptor = LocalToken LBRKT octetString RBRKT localDescriptor = LocalToken LBRKT octetString RBRKT
remoteDescriptor = RemoteToken LBRKT octetString RBRKT remoteDescriptor = RemoteToken LBRKT octetString RBRKT
eventBufferDescriptor= EventBufferToken LBRKT observedEvent eventBufferDescriptor= EventBufferToken LBRKT observedEvent
*( COMMA observedEvent ) RBRKT *( COMMA observedEvent ) RBRKT
eventBufferFlag = BufferToken EQUAL ("ON" / "OFF" ) eventBufferFlag = BufferToken EQUAL ("ON" / "OFF" )
terminationStateDescriptor = TerminationStateToken LBRKT terminationStateDescriptor = TerminationStateToken LBRKT
terminationStateParm *( COMMA terminationStateParm ) RBRKT terminationStateParm *( COMMA terminationStateParm ) RBRKT
Internet draft MEGACO Protocol January 27, 2000
; at-most-once per item ; at-most-once per item
terminationStateParm=(propertyParm / serviceStates / eventBufferFlag ) terminationStateParm=(propertyParm / serviceStates / eventBufferFlag )
serviceStates = ServiceStatesToken EQUAL ( TestToken / serviceStates = ServiceStatesToken EQUAL ( TestToken /
OutOfSvcToken / InSvcToken ) OutOfSvcToken / InSvcToken )
muxDescriptor = MuxToken EQUAL MuxType terminationIDList muxDescriptor = MuxToken EQUAL MuxType terminationIDList
MuxType = ( H221Token / H223Token / H226Token / V75Token MuxType = ( H221Token / H223Token / H226Token / V75Token
extensionParameter ) extensionParameter )
StreamID = UINT16 StreamID = UINT16
pkgdName = (PackageName / "*") SLASH (ItemID / "*" ) pkgdName = (PackageName SLASH ItemID) / ; specific item
(PackageName SLASH "*" ) / ; all events in pkg
( "*" SLASH "*" ) ; all events supported by MG
PackageName = NAME PackageName = NAME
ItemID = NAME ItemID = NAME
eventsDescriptor = EventsToken EQUAL RequestID LBRKT eventsDescriptor = EventsToken EQUAL RequestID LBRKT
requestedEvent *( COMMA requestedEvent ) RBRKT requestedEvent *( COMMA requestedEvent ) RBRKT
requestedEvent = pkgdName [ LBRKT eventParameter requestedEvent = pkgdName [ LBRKT eventParameter
*( COMMA eventParameter ) RBRKT ] *( COMMA eventParameter ) RBRKT ]
; at-most-once each of embedOrKeepActive , eventDM or eventStream ; at-most-once each of embedOrKeepActive , eventDM or eventStream
eventParameter = ( embedOrKeepActive / eventDM / eventStream eventParameter = ( embedOrKeepActive / eventDM / eventStream
/ eventOther ) / eventOther )
embedOrKeepActive = eventEmbedded / KeepActiveToken embedOrKeepActive = eventEmbedded / KeepActiveToken
eventEmbedded = EmbedToken LBRKT embedFirst [COMMA embedFirst ] RBRKT eventEmbedded = EmbedToken LBRKT embedFirst [COMMA embedFirst ] RBRKT
; at-most-once of each ; at-most-once of each
embedFirst = ( signalsDescriptor / secondEventEmbeddedDescriptor ) embedFirst = ( signalsDescriptor / secondEventEmbeddedDescriptor )
secondEventEmbeddedDescriptor= EventsToken EQUAL RequestID LBRKT secondEventEmbeddedDescriptor= EventsToken EQUAL RequestID LBRKT
Internet draft MEGACO Protocol February 8, 2000
secondRequestedEvent *(COMMA secondRequestedEvent) RBRKT secondRequestedEvent *(COMMA secondRequestedEvent) RBRKT
secondRequestedEvent = pkgdName [ LBRKT secondEventParameter secondRequestedEvent = pkgdName [ LBRKT secondEventParameter
*( COMMA secondEventParameter ) RBRKT ] *( COMMA secondEventParameter ) RBRKT ]
; at-most-once each of embedOrKeepActive , eventDM or eventStream ; at-most-once each of embedOrKeepActive , eventDM or eventStream
secondEventParameter = ( SecondEmbedOrKeepActive / eventDM / secondEventParameter = ( SecondEmbedOrKeepActive / eventDM /
eventStream / eventOther ) eventStream / eventOther )
secondEmbedOrKeepActive = secondEventEmbedded / KeepActiveToken secondEmbedOrKeepActive = secondEventEmbedded / KeepActiveToken
secondEventEmbedded = EmbedToken LBRKT signalsDescriptor RBRKT secondEventEmbedded = EmbedToken LBRKT signalsDescriptor RBRKT
eventStream = StreamToken EQUAL StreamID eventStream = StreamToken EQUAL StreamID
eventOther = eventParameterName parmValue eventOther = eventParameterName parmValue
Internet draft MEGACO Protocol January 27, 2000
eventParameterName = NAME eventParameterName = NAME
eventDM = DigitMapToken ((EQUAL digitMapName ) / eventDM = DigitMapToken ((EQUAL digitMapName ) /
(LBRKT digitMapValue RBRKT )) (LBRKT digitMapValue RBRKT ))
signalsDescriptor = SignalsToken LBRKT [ signalParm signalsDescriptor = SignalsToken LBRKT [ signalParm
*(COMMA signalParm)] RBRKT *(COMMA signalParm)] RBRKT
signalParm = signalList / signalRequest signalParm = signalList / signalRequest
skipping to change at page 95, line 38 skipping to change at page 97, line 4
signalName = pkgdName signalName = pkgdName
;at-most-once sigStream, at-most-once sigSignalType, ;at-most-once sigStream, at-most-once sigSignalType,
;at-most-once sigDuration, every signalParameterName at most once ;at-most-once sigDuration, every signalParameterName at most once
sigParameter = sigStream / sigSignalType / sigDuration / sigParameter = sigStream / sigSignalType / sigDuration /
sigOther sigOther
/ notifyCompletion / notifyCompletion
sigStream = StreamToken EQUAL StreamID sigStream = StreamToken EQUAL StreamID
sigOther = sigParameterName parmValue sigOther = sigParameterName parmValue
sigParameterName = NAME sigParameterName = NAME
Internet draft MEGACO Protocol February 8, 2000
sigSignalType = SignalTypeToken EQUAL signalType sigSignalType = SignalTypeToken EQUAL signalType
signalType = (OnOffToken / TimeOutToken / BriefToken) signalType = (OnOffToken / TimeOutToken / BriefToken)
sigDuration = DurationToken EQUAL UINT16 sigDuration = DurationToken EQUAL UINT16
notifyCompletion = NotifyCompletionToken EQUAL RequestID notifyCompletion = NotifyCompletionToken EQUAL ("ON" / "OFF" )
observedEventsDescriptor = ObservedEventsToken EQUAL RequestID observedEventsDescriptor = ObservedEventsToken EQUAL RequestID
LBRKT observedEvent *(COMMA observedEvent) RBRKT LBRKT observedEvent *(COMMA observedEvent) RBRKT
;time per event, because it might be buffered ;time per event, because it might be buffered
observedEvent = [ TimeStamp LWSP COLON] LWSP observedEvent = [ TimeStamp LWSP COLON] LWSP
pkgdName [ LBRKT observedEventParameter pkgdName [ LBRKT observedEventParameter
*(COMMA observedEventParameter) RBRKT ] *(COMMA observedEventParameter) RBRKT ]
;at-most-once eventStream, every eventParameterName at most once ;at-most-once eventStream, every eventParameterName at most once
observedEventParameter = eventStream / eventOther observedEventParameter = eventStream / eventOther
RequestID = UINT32 RequestID = UINT32
Internet draft MEGACO Protocol January 27, 2000
modemDescriptor = ModemToken (( EQUAL modemType) / modemDescriptor = ModemToken (( EQUAL modemType) /
(LSBRKT modemType *(COMMA modemType) RSBRKT)) (LSBRKT modemType *(COMMA modemType) RSBRKT))
[ LBRKT NAME parmValue [ LBRKT NAME parmValue
*(COMMA NAME parmValue) RBRKT ] *(COMMA NAME parmValue) RBRKT ]
; at-most-once ; at-most-once
modemType = (V32bisToken / V22bisToken / V18Token / modemType = (V32bisToken / V22bisToken / V18Token /
V22Token / V32Token / V34Token / V90Token / V22Token / V32Token / V34Token / V90Token /
V91Token / SynchISDNToken / extensionParameter) V91Token / SynchISDNToken / extensionParameter)
skipping to change at page 96, line 30 skipping to change at page 97, line 48
digitMapValue = ["T" COLON Timer COMMA] ["S" COLON Timer COMMA] digitMapValue = ["T" COLON Timer COMMA] ["S" COLON Timer COMMA]
["L" COLON Timer COMMA] digitMap ["L" COLON Timer COMMA] digitMap
Timer = 1*2DIGIT Timer = 1*2DIGIT
digitMap = (digitString / LWSP "(" LWSP digitStringList LWSP ")" LWSP) digitMap = (digitString / LWSP "(" LWSP digitStringList LWSP ")" LWSP)
digitStringList = digitString *( LWSP "|" LWSP digitString ) digitStringList = digitString *( LWSP "|" LWSP digitString )
digitString = 1*(digitStringElement) digitString = 1*(digitStringElement)
digitStringElement = digitPosition [DOT] digitStringElement = digitPosition [DOT]
digitPosition = digitMapLetter / digitMapRange digitPosition = digitMapLetter / digitMapRange
digitMapRange = ("x" / LWSP "[" LWSP digitLetter LWSP "]" LWSP) digitMapRange = ("x" / LWSP "[" LWSP digitLetter LWSP "]" LWSP)
digitLetter = *((DIGIT "-" DIGIT ) / digitMapLetter) digitLetter = *((DIGIT "-" DIGIT ) / digitMapLetter)
digitMapLetter = DIGIT / "#" / "*" / "A" / "B" / "C" / "D" / digitMapLetter = DIGIT / %x41-4B / %x61-6B / ; 0-9, A-K, (a-k)
MFSig / "S" / "L" "L" ; Long duration modifier
MFSig = "K0" / "K1" / "K2" / "S0" / "S1" / "S2" / "S3"
;at-most-once ;at-most-once
auditItem = ( MuxToken / ModemToken / MediaToken / auditItem = ( MuxToken / ModemToken / MediaToken /
SignalsToken / EventBufferToken / SignalsToken / EventBufferToken /
DigitMapToken / StatsToken / EventsToken / DigitMapToken / StatsToken / EventsToken /
Internet draft MEGACO Protocol February 8, 2000
ObservedEventsToken / PackagesToken ) ObservedEventsToken / PackagesToken )
serviceChangeDescriptor = ServicesToken LBRKT serviceChangeParm serviceChangeDescriptor = ServicesToken LBRKT serviceChangeParm
*(COMMA serviceChangeParm) RBRKT *(COMMA serviceChangeParm) RBRKT
serviceChangeParm = (serviceChangeMethod / serviceChangeReason / serviceChangeParm = (serviceChangeMethod / serviceChangeReason /
serviceChangeDelay / serviceChangeAddress / serviceChangeDelay / serviceChangeAddress /
serviceChangeProfile / extension / TimeStamp / serviceChangeProfile / extension / TimeStamp /
serviceChangeMgcId / serviceChangeVersion ) serviceChangeMgcId / serviceChangeVersion )
serviceChangeReplyDescriptor = ServicesToken LBRKT serviceChangeReplyDescriptor = ServicesToken LBRKT
servChgReplyParm *(COMMA servChgReplyParm) RBRKT servChgReplyParm *(COMMA servChgReplyParm) RBRKT
;at-most-once. Version is REQUIRED on first ServiceChange response ;at-most-once. Version is REQUIRED on first ServiceChange response
servChgReplyParm = (serviceChangeAddress / serviceChangeMgcId / servChgReplyParm = (serviceChangeAddress / serviceChangeMgcId /
serviceChangeProfile / serviceChangeVersion ) serviceChangeProfile / serviceChangeVersion )
Internet draft MEGACO Protocol January 27, 2000
serviceChangeMethod = MethodToken EQUAL (FailoverToken / serviceChangeMethod = MethodToken EQUAL (FailoverToken /
ForcedToken / GracefulToken / RestartToken / ForcedToken / GracefulToken / RestartToken /
DisconnectedToken / HandOffToken / DisconnectedToken / HandOffToken /
extensionParameter) extensionParameter)
serviceChangeReason = ReasonToken EQUAL VALUE serviceChangeReason = ReasonToken EQUAL VALUE
serviceChangeDelay = DelayToken EQUAL UINT32 serviceChangeDelay = DelayToken EQUAL UINT32
serviceChangeAddress = ServiceChangeAddressToken EQUAL VALUE serviceChangeAddress = ServiceChangeAddressToken EQUAL VALUE
serviceChangeMgcId = MgcIdToken EQUAL mId serviceChangeMgcId = MgcIdToken EQUAL mId
serviceChangeProfile = ProfileToken EQUAL NAME SLASH Version serviceChangeProfile = ProfileToken EQUAL NAME SLASH Version
skipping to change at page 97, line 39 skipping to change at page 99, line 4
; Time = hhmmssss ; Time = hhmmssss
Time = 8(DIGIT) Time = 8(DIGIT)
statisticsDescriptor = StatsToken LBRKT statisticsParameter statisticsDescriptor = StatsToken LBRKT statisticsParameter
*(COMMA statisticsParameter ) RBRKT *(COMMA statisticsParameter ) RBRKT
;at-most-once per item ;at-most-once per item
statisticsParameter = pkgdName EQUAL VALUE statisticsParameter = pkgdName EQUAL VALUE
topologyDescriptor = TopologyToken LBRKT terminationA COMMA topologyDescriptor = TopologyToken LBRKT terminationA COMMA
terminationB COMMA topologyDirection RBRKT terminationB COMMA topologyDirection RBRKT
Internet draft MEGACO Protocol February 8, 2000
terminationA = TerminationID terminationA = TerminationID
terminationB = TerminationID terminationB = TerminationID
topologyDirection = BothwayToken / IsolateToken / OnewayToken topologyDirection = BothwayToken / IsolateToken / OnewayToken
priority = PriorityToken EQUAL UINT16 priority = PriorityToken EQUAL UINT16
extensionParameter = "X" ("-" / "+") 1*6(ALPHA / DIGIT) extensionParameter = "X" ("-" / "+") 1*6(ALPHA / DIGIT)
; octetString is used to describe SDP defined in RFC2327. ; octetString is used to describe SDP defined in RFC2327.
; Caution should be taken if CRLF in RFC2327 is used. ; Caution should be taken if CRLF in RFC2327 is used.
; To be safe, use EOL in this ABNF. ; To be safe, use EOL in this ABNF.
; Whenever "}" appears in SDP, it is escaped by " ; Whenever "}" appears in SDP, it is escaped by "
octetString = *(nonEscapeChar) octetString = *(nonEscapeChar)
nonEscapeChar = ( "" / %x01-7C / %x7E-FF ) nonEscapeChar = ( "" / %x01-7C / %x7E-FF )
quotedString = DQUOTE 1*64(SafeChar / RestChar/ WSP) DQUOTE quotedString = DQUOTE 1* (SafeChar / RestChar/ WSP) DQUOTE
Internet draft MEGACO Protocol January 27, 2000
UINT16 = 1*5(DIGIT) ; %x0-FFFF UINT16 = 1*5(DIGIT) ; %x0-FFFF
UINT32 = 1*10(DIGIT) ; %x0-FFFFFFFF UINT32 = 1*10(DIGIT) ; %x0-FFFFFFFF
NAME = ALPHA *63(ALPHA / DIGIT / "_" ) NAME = ALPHA *63(ALPHA / DIGIT / "_" )
VALUE = quotedString / 1*64(SafeChar) VALUE = quotedString / 1* (SafeChar)
SafeChar = DIGIT / ALPHA / "+" / "-" / "&" / SafeChar = DIGIT / ALPHA / "+" / "-" / "&" /
"!" / "_" / "/" / "'" / "?" / "@" / "!" / "_" / "/" / "'" / "?" / "@" /
"^" / "`" / "~" / "*" / "$" / " "^" / "`" / "~" / "*" / "$" / "
"(" / ")" / "%" / "|" / "." "(" / ")" / "%" / "|" / "."
EQUAL = LWSP %x3D LWSP ; "=" EQUAL = LWSP %x3D LWSP ; "="
COLON = %x3A ; ":" COLON = %x3A ; ":"
LBRKT = LWSP %x7B LWSP ; "{" LBRKT = LWSP %x7B LWSP ; "{"
RBRKT = LWSP %x7D LWSP ; "}" RBRKT = LWSP %x7D LWSP ; "}"
COMMA = LWSP %x2C LWSP ; "," COMMA = LWSP %x2C LWSP ; ","
skipping to change at page 98, line 40 skipping to change at page 100, line 5
CR = %x0D ; Carriage return CR = %x0D ; Carriage return
LF = %x0A ; linefeed LF = %x0A ; linefeed
LWSP = *( WSP / COMMENT / EOL ) LWSP = *( WSP / COMMENT / EOL )
EOL = (CR [LF] / LF ) EOL = (CR [LF] / LF )
WSP = SP / HTAB ; white space WSP = SP / HTAB ; white space
SEP = ( WSP / EOL / COMMENT) LWSP SEP = ( WSP / EOL / COMMENT) LWSP
COMMENT = ";" *(SafeChar/ RestChar / WSP / %x22) EOL COMMENT = ";" *(SafeChar/ RestChar / WSP / %x22) EOL
RestChar = ";" / "[" / "]" / "{" / "}" / ":" / "," / "#" / RestChar = ";" / "[" / "]" / "{" / "}" / ":" / "," / "#" /
"<" / ">" / "=" "<" / ">" / "="
Internet draft MEGACO Protocol February 8, 2000
AddToken = ("Add" / "A") AddToken = ("Add" / "A")
AuditToken = ("Audit" / "AT") AuditToken = ("Audit" / "AT")
AuditCapToken = ("AuditCapability" / "AC") AuditCapToken = ("AuditCapability" / "AC")
AuditValueToken = ("AuditValue" / "AV") AuditValueToken = ("AuditValue" / "AV")
AuthToken = ("Authentication" / "AU") AuthToken = ("Authentication" / "AU")
BothwayToken = ("Bothway" / "BW") BothwayToken = ("Bothway" / "BW")
BriefToken = ("Brief" / "BR") BriefToken = ("Brief" / "BR")
BufferToken = ("Buffer" / "BF") BufferToken = ("Buffer" / "BF")
CtxToken = ("Context" / "C") CtxToken = ("Context" / "C")
ContextAuditToken = ("ContextAudit" / "CA") ContextAuditToken = ("ContextAudit" / "CA")
DigitMapToken = ("DigitMap" / "DM") DigitMapToken = ("DigitMap" / "DM")
DiscardToken = ("Discard" / "DS") DiscardToken = ("Discard" / "DS")
DisconnectedToken = ("Disconnected" / "DC") DisconnectedToken = ("Disconnected" / "DC")
DelayToken = ("Delay" / "DL") DelayToken = ("Delay" / "DL")
Internet draft MEGACO Protocol January 27, 2000
DeleteToken = ("Delete" / "DE")
DurationToken = ("Duration" / "DR") DurationToken = ("Duration" / "DR")
EmbedToken = ("Embed" / "EB") EmbedToken = ("Embed" / "EB")
EmergencyToken = ("Emergency" / "EM") EmergencyToken = ("Emergency" / "EM")
ErrorToken = ("Error" / "ER") ErrorToken = ("Error" / "ER")
EventBufferToken = ("EventBuffer" / "EB") EventBufferToken = ("EventBuffer" / "EB")
EventsToken = ("Events" / "E") EventsToken = ("Events" / "E")
FailoverToken = ("Failover" / "FL") FailoverToken = ("Failover" / "FL")
ForcedToken = ("Forced" / "FO") ForcedToken = ("Forced" / "FO")
GracefulToken = ("Graceful" / "GR") GracefulToken = ("Graceful" / "GR")
H221Token = ("H221" ) H221Token = ("H221" )
skipping to change at page 99, line 42 skipping to change at page 101, line 4
ModeToken = ("Mode" / "MO") ModeToken = ("Mode" / "MO")
ModifyToken = ("Modify" / "MF") ModifyToken = ("Modify" / "MF")
ModemToken = ("Modem" / "MD") ModemToken = ("Modem" / "MD")
MoveToken = ("Move" / "MV") MoveToken = ("Move" / "MV")
MTPToken = ("MTP") MTPToken = ("MTP")
MuxToken = ("Mux" / "MX") MuxToken = ("Mux" / "MX")
NotifyToken = ("Notify" / "N") NotifyToken = ("Notify" / "N")
NotifyCompletionToken = ("NotifyCompletion" / "NC") NotifyCompletionToken = ("NotifyCompletion" / "NC")
ObservedEventsToken = ("ObservedEvents" / "OE") ObservedEventsToken = ("ObservedEvents" / "OE")
OnewayToken = ("Oneway" / "OW") OnewayToken = ("Oneway" / "OW")
Internet draft MEGACO Protocol February 8, 2000
OnOffToken = ("OnOff" / "OO") OnOffToken = ("OnOff" / "OO")
OutOfSvcToken = ("OutOfService" / "OS") OutOfSvcToken = ("OutOfService" / "OS")
PackagesToken = ("Packages" / "PG") PackagesToken = ("Packages" / "PG")
PendingToken = ("Pending" / "PN") PendingToken = ("Pending" / "PN")
PriorityToken = ("Priority" / "PR") PriorityToken = ("Priority" / "PR")
ProfileToken = ("Profile" / "PF") ProfileToken = ("Profile" / "PF")
ReasonToken = ("Reason" / "RE") ReasonToken = ("Reason" / "RE")
RecvonlyToken = ("ReceiveOnly" / "RC") RecvonlyToken = ("ReceiveOnly" / "RC")
ReplyToken = ("Reply" / "P") ReplyToken = ("Reply" / "P")
RestartToken = ("Restart" / "RS") RestartToken = ("Restart" / "RS")
RemoteToken = ("Remote" / "R") RemoteToken = ("Remote" / "R")
ReservedToken = ("Reserved" / "RV") ReservedToken = ("Reserved" / "RV")
SendonlyToken = ("SendOnly" / "SO") SendonlyToken = ("SendOnly" / "SO")
Internet draft MEGACO Protocol January 27, 2000
SendrecvToken = ("SendReceive" / "SR") SendrecvToken = ("SendReceive" / "SR")
ServicesToken = ("Services" / "SV") ServicesToken = ("Services" / "SV")
ServiceStatesToken = ("ServiceStates" / "SI") ServiceStatesToken = ("ServiceStates" / "SI")
ServiceChangeToken = ("ServiceChange" / "SC") ServiceChangeToken = ("ServiceChange" / "SC")
ServiceChangeAddressToken = ("ServiceChangeAddress" / "AD") ServiceChangeAddressToken = ("ServiceChangeAddress" / "AD")
SignalListToken = ("SignalList" / "SL") SignalListToken = ("SignalList" / "SL")
SignalsToken = ("Signals" / "SG") SignalsToken = ("Signals" / "SG")
SignalTypeToken = ("SignalType" / "SY") SignalTypeToken = ("SignalType" / "SY")
StatsToken = ("Statistics" / "SA") StatsToken = ("Statistics" / "SA")
StreamToken = ("Stream" / "ST") StreamToken = ("Stream" / "ST")
skipping to change at page 100, line 40 skipping to change at page 102, line 4
V76Token = ("V76") V76Token = ("V76")
V90Token = ("V90") V90Token = ("V90")
V91Token = ("V91") V91Token = ("V91")
ANNEX C TAGS FOR MEDIA STREAM PROPERTIES (NORMATIVE) ANNEX C TAGS FOR MEDIA STREAM PROPERTIES (NORMATIVE)
Parameters for Local descriptors and Remote descriptors are specified as Parameters for Local descriptors and Remote descriptors are specified as
tag-value pairs if binary encoding is used for the protocol. This annex tag-value pairs if binary encoding is used for the protocol. This annex
contains the property names (PropertyID), the tags (Property Tag), type contains the property names (PropertyID), the tags (Property Tag), type
of the property (Type) and the values (Value).Values presented in the of the property (Type) and the values (Value).Values presented in the
Internet draft MEGACO Protocol February 8, 2000
Value field when the field contains references shall be regarded as Value field when the field contains references shall be regarded as
"information". The reference contains the normative values. If a value "information". The reference contains the normative values. If a value
field does not contain a reference then the values in that field can be field does not contain a reference then the values in that field can be
considered as "normative". considered as "normative".
Tags are given as hexadecimal numbers in this annex. When setting the Tags are given as hexadecimal numbers in this annex. When setting the
value of a property, a MGC may underspecify the value according to one value of a property, a MGC may underspecify the value according to one
of the mechanisms specified in section 7.1.1. of the mechanisms specified in section 7.1.1.
For type "enumeration" the value is represented by the value in brack- For type "enumeration" the value is represented by the value in brack-
ets, e.g., Send(0), Receive(1). ets, e.g., Send(0), Receive(1).
Internet draft MEGACO Protocol January 27, 2000
C.1. General Media Attributes C.1. General Media Attributes
________________________________________________________________________ ________________________________________________________________________
|PropertyID | Tag | Type | Value | |PropertyID | Tag | Type | Value |
|Media |1001 |Enumeration|Audio(0), Video(1) ,Data(2), | |Media |1001 |Enumeration|Audio(0), Video(1) ,Data(2), |
|TransMode |1002 |Enumeration|Send(0), Receive(1), Send&Receive(2) | |TransMode |1002 |Enumeration|Send(0), Receive(1), Send&Receive(2) |
|NumChan |1003 |UINT | 0-255 | |NumChan |1003 |UINT | 0-255 |
|SamplingRate |1004 |UINT | 0-2^32 | |SamplingRate |1004 |UINT | 0-2^32 |
|Bitrate |1005 |Integer |(0..4294967295) Note-units of 100 bit | |Bitrate |1005 |Integer |(0..4294967295) Note-units of 100 bit |
|Acodec |1006 | |. Audio Codec Type | |Acodec |1006 | |. Audio Codec Type |
skipping to change at page 101, line 40 skipping to change at page 103, line 5
_________________________________________________________________________ _________________________________________________________________________
|PropertyID| Tag | Type | Value | |PropertyID| Tag | Type | Value |
|H.221 | 2001 | Octet string| H222LogicalChannelParameters | |H.221 | 2001 | Octet string| H222LogicalChannelParameters |
|H223 | 2002 | Octet string| H223LogicalChannelParameters | |H223 | 2002 | Octet string| H223LogicalChannelParameters |
|V76 | 2003 | Octet String| V76LogicalChannelParameters | |V76 | 2003 | Octet String| V76LogicalChannelParameters |
|H2250 | 2004 | Octet String| H2250LogicalChannelParameters| |H2250 | 2004 | Octet String| H2250LogicalChannelParameters|
|__________|____________|______________|________________________________| |__________|____________|______________|________________________________|
C.3. General bearer properties C.3. General bearer properties
Internet draft MEGACO Protocol February 8, 2000
_____________________________________________________________________ _____________________________________________________________________
| PropertyID| Tag | Type | Value | | PropertyID| Tag | Type | Value |
| Mediatx | 3001 | Enumeration| Media Transport Type | | Mediatx | 3001 | Enumeration| Media Transport Type |
| BIR | 3002 | 4 OCTET | Value depends on transport | | BIR | 3002 | 4 OCTET | Value depends on transport |
| NSAP | 3003 | 20 OCTET | Ref: ITU X.213 Annex A | | NSAP | 3003 | 20 OCTET | Ref: ITU X.213 Annex A |
|___________|____________|_____________|_____________________________| |___________|____________|_____________|_____________________________|
C.4. General ATM properties C.4. General ATM properties
Internet draft MEGACO Protocol January 27, 2000
_________________________________________________________________ _________________________________________________________________
| PropertyID| Tag | Type | Value |
| AESA | 4001| 20 OCTETS | ATM End System Address |
| VPVC | 4002| 2x16b int | VPC-VCI |
| SC | 4003| 4 bits | Service Category |
| BCOB | 4004| 5b integer | Broadband Bearer Class |
| BBTC | 4005| octet | Broadband Transfer Capability|
| ATC | 4006| Enumeration| I.371 ATM Traffic Cap. |
| STC | 4007| 2 bits | Susceptibility to clipping |
| UPCC | 4008| 2 bits | User Plane Connection config |
| PCR0 | 4009| 24b integer| Peak Cell Rate CLP=0 |
| SCR0 | 400A| 24b integer| Sustainable Cell Rate CLP=0 |
| MBS0 | 400B| 24b integer| Maximum Burst Size CLP=0 |
| PCR1 | 400C| 24b integer| Peak Cell Rate CLP=0+1 |
| SCR2 | 400D| 24b integer| Sustain. Cell Rate CLP=0+1 |
| MBS3 | 400E| 24b integer| Maximum Burst Size CLP=0+1 |
| BEI | 400F| Boolean | Best Effort Indicator |
| TI | 4010| Boolean | Tagging |
| FD | 4011| Boolean | Frame Discard |
| FCDV | 4012| 24b integer| Forward P-P CDV |
| BCDV | 4013| 24b integer| Backward P-P CDV |
| FCLR0 | 4014| 8b integer | Fwd Cell Loss Ratio CLP=0 |
| BCLR0 | 4015| 8b integer | Bkwd P-P CLR CLP=0 |
| FCLR1 | 4016| 8b integer | Fwd Cell Loss Ratio CLP=0+1 |
| BCLR1 | 4017| 8b integer | Bkwd P-P CLR CLP=0+1 |
| FCDV | 4018| 24b integer| Fwd Cell Delay Variation |
| BCDV | 4019| 24b integer| Bkwd Cell Delay Variation |
| FACDV | 401A| 24b integer| Fwd Acceptable P-P-P CDV |
| BACDV | 401B| 24b integer| Bkwd Acceptable P-P CDV |
| FCCDV | 401C| 24b integer| Fwd Cumulative P-P CDV |
| BCCDV | 401D| 24b integer| Bkwd Cumulative P-P CDV |
| FCLR | 401E| 8b integer | Acceptable Fwd CLR |
| BCLR | 401F| 8b integer | Acceptable Bkwd CLR |
| EETD | 4020| 16b integer| End-to-end transit delay |
| Mediatx | 4021| | AAL Type |
| QosClass | 4022| Integer | 0-4 Qos Class |
| AALtype | 4023| 1 OCTET | AAL Type Reference |
|___________|______|_____________|_______________________________|
C.5. Frame Relay
______________________________________________________________________
PropertyID Tag Type Value PropertyID Tag Type Value
DLCI 5001 Unsigned Integer Data link connection id AESA 4001 20 OCTETS ATM End System Address
CID 5002 Unsigned Integer sub-channel id. VPVC 4002 2x16b int VPC-VCI
SID 5003 Unsigned Integer silence insertion descriptor SC 4003 4 bits Service Category
Payload 5004 Unsigned Integer Primary Payload Type BCOB 4004 5b integer Broadband Bearer Class
BBTC 4005 octet Broadband Transfer Capability
ATC 4006 Enumeration I.371 ATM Traffic Cap.
STC 4007 2 bits Susceptibility to clipping
UPCC 4008 2 bits User Plane Connection config
PCR0 4009 24b integer Peak Cell Rate CLP=0
SCR0 400A 24b integer Sustainable Cell Rate CLP=0
MBS0 400B 24b integer Maximum Burst Size CLP=0
PCR1 400C 24b integer Peak Cell Rate CLP=0+1
SCR2 400D 24b integer Sustain. Cell Rate CLP=0+1
MBS3 400E 24b integer Maximum Burst Size CLP=0+1
BEI 400F Boolean Best Effort Indicator
TI 4010 Boolean Tagging
FD 4011 Boolean Frame Discard
FCDV 4012 24b integer Forward P-P CDV
BCDV 4013 24b integer Backward P-P CDV
FCLR0 4014 8b integer Fwd Cell Loss Ratio CLP=0
BCLR0 4015 8b integer Bkwd P-P CLR CLP=0
FCLR1 4016 8b integer Fwd Cell Loss Ratio CLP=0+1
BCLR1 4017 8b integer Bkwd P-P CLR CLP=0+1
FCDV 4018 24b integer Fwd Cell Delay Variation
BCDV 4019 24b integer Bkwd Cell Delay Variation
FACDV 401A 24b integer Fwd Acceptable P-P-P CDV
BACDV 401B 24b integer Bkwd Acceptable P-P CDV
FCCDV 401C 24b integer Fwd Cumulative P-P CDV
BCCDV 401D 24b integer Bkwd Cumulative P-P CDV
FCLR 401E 8b integer Acceptable Fwd CLR
BCLR 401F 8b integer Acceptable Bkwd CLR
EETD 4020 16b integer End-to-end transit delay
Mediatx 4021 AAL Type
QosClass 4022 Integer 0-4 Qos Class
AALtype 4023 1 OCTET AAL Type Reference
_________________________________________________________________
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
C.5. Frame Relay
______________________________________________________________________
| PropertyID| |Tag | |Type | | Value | |
| DLCI | |5001| |Unsigned Integer| Data link connection id | |
| CID | |5002| |Unsigned Integer| sub-channel id. | |
| SID | |5003| |Unsigned Integer| silence insertion descriptor |
| Payload | |5004| |Unsigned Integer| Primary Payload Type | |
|___________|______|__________________|_______________________________| |___________|______|__________________|_______________________________|
C.6. IP C.6. IP
_____________________________________________________________________ _____________________________________________________________________
| PropertyID| Tag | Type | Value | | PropertyID| Tag | Type | Value |
| IPv4 | 6001 | 32 BITS | Ipv4Address or Ipv6 address | | IPv4 | 6001 | 32 BITS | Ipv4Address or Ipv6 address |
| IPv6 | 6002 | 128 BITS | IPv6 Address | | IPv6 | 6002 | 128 BITS | IPv6 Address |
| Port | 6002 | 0-65535 | Port | | Port | 6002 | 0-65535 | Port |
| TCP | 6003 | Boolean | | | TCP | 6003 | Boolean | |
skipping to change at page 103, line 38 skipping to change at page 105, line 5
|SUT | 7004 | 1..254 octets| Served user transport param | |SUT | 7004 | 1..254 octets| Served user transport param |
|TCI | 7005 | BOOLEAN | Test connection | |TCI | 7005 | BOOLEAN | Test connection |
|Timer_CU | 7006 | 32b integer | Timer-CU | |Timer_CU | 7006 | 32b integer | Timer-CU |
|MaxCPSSDU | 7007 | 8b integer | Max. Common Part Sublayer SDU | |MaxCPSSDU | 7007 | 8b integer | Max. Common Part Sublayer SDU |
|SCLP | 7008 | Boolean | Set Cell Local PriorityLP bit | |SCLP | 7008 | Boolean | Set Cell Local PriorityLP bit |
|EETR | 7009 | Boolean | End to End Timing Required | |EETR | 7009 | Boolean | End to End Timing Required |
|__________|_________|_______________|________________________________________| |__________|_________|_______________|________________________________________|
C.8. ATM AAL1 C.8. ATM AAL1
______________________________________________________________________________ Internet draft MEGACO Protocol February 8, 2000
|PropertyID| Tag | Type | Value | |PropertyID| Tag | Type | Value |
|BIR | See Table C.3| 4 OCTETS |GIT (Generic Identifier Transport)| |BIR | See Table C.3| 4 OCTETS |GIT (Generic Identifier Transport)|
|AAL1ST | 8001 | 1 OCTET | AAL1 Subtype | |AAL1ST | 8001 | 1 OCTET | AAL1 Subtype |
|CBRR | 8002 | 1 OCTET | CBR Rate | |CBRR | 8002 | 1 OCTET | CBR Rate |
|SCRI | 8003 | 1 OCTET | Src. Clock Freq. Recovery Method | |SCRI | 8003 | 1 OCTET | Src. Clock Freq. Recovery Method |
|ECM | 8004 | 1 OCTET | Error Correction Method | |ECM | 8004 | 1 OCTET | Error Correction Method |
|SDTB | 8005 | 16b integer | Structured Data Transfer Blksize | |SDTB | 8005 | 16b integer | Structured Data Transfer Blksize |
|PFCI | 8006 | 8b integer | Partially filled cells identifier| |PFCI | 8006 | 8b integer | Partially filled cells identifier|
|EETR | See Table C.7| See Table C.7| | |EETR | See Table C.7| See Table C.7| |
|__________|_______________|_______________|__________________________________| |__________|_______________|_______________|__________________________________|
Internet draft MEGACO Protocol January 27, 2000
C.9. Bearer Capabilities C.9. Bearer Capabilities
Internet draft MEGACO Protocol February 8, 2000
________________________________________________________________________ ________________________________________________________________________
|PropertyID | Tag | Type | Value | |PropertyID | Tag | Type | Value |
|TMR | 9001| 1 OCTET | Transmission Medium Requirement | |TMR | 9001| 1 OCTET | Transmission Medium Requirement |
|TMRSR | 9002| 1 OCTET | Trans. Medium Requirement Subrate| |TMRSR | 9002| 1 OCTET | Trans. Medium Requirement Subrate|
|Contcheck | 0003| BOOLEAN | Continuity Check | |Contcheck | 0003| BOOLEAN | Continuity Check |
|ITC | 9004| 5 BITS | Information Transfer Capability | |ITC | 9004| 5 BITS | Information Transfer Capability |
|TransMode | 9005| 2 BITS | Transfer Mode | |TransMode | 9005| 2 BITS | Transfer Mode |
|TransRate | 9006| 5 BITS | Transfer Rate | |TransRate | 9006| 5 BITS | Transfer Rate |
|MULT | 9007| 7 BITS | Rate Multiplier | |MULT | 9007| 7 BITS | Rate Multiplier |
|USI | 9008| 5 BITS | User Information Layer 1 Protocol| |USI | 9008| 5 BITS | User Information Layer 1 Protocol|
skipping to change at page 104, line 50 skipping to change at page 106, line 48
|DialledN | 901F| 10 OCTETS | Dialled Number | |DialledN | 901F| 10 OCTETS | Dialled Number |
|DiallingN | 9020| 10 OCTETS | Dialling Number | |DiallingN | 9020| 10 OCTETS | Dialling Number |
|ECHOCI | 9021| Enumeration| Echo Control Information | |ECHOCI | 9021| Enumeration| Echo Control Information |
|NCI | 9022| 1 OCTET | Nature of Connection Indicators | |NCI | 9022| 1 OCTET | Nature of Connection Indicators |
|_____________|______|_____________|___________________________________| |_____________|______|_____________|___________________________________|
C.10. AAL5 Properties C.10. AAL5 Properties
______________________________________________________________________ ______________________________________________________________________
| PropertyID| Tag | Type | Value | | PropertyID| Tag | Type | Value |
| FMSDU | A001 | 32b integer| Forward Maximum CPCS-SDU Size | | FMSDU | A001 | 32b integer| Forward Maximum CPCS-SDU Size: |
| BMSDU | A002 | 2b integer | Backwards Maximum CPCS-SDU Size | | BMSDU | A002 | 2b integer | Backwards Maximum CPCS-SDU Size |
| SSCS | See C.7| See C.7 | See table C.7 | | SSCS | See C.7| See C.7 | See table C. |
| SC | See C.4| See C.4 | See table C.4 | | SC | See C.4| See C.4 | See table C.4 |
Internet draft MEGACO Protocol January 27, 2000
|___________|_________|_____________|_________________________________| |___________|_________|_____________|_________________________________|
Internet draft MEGACO Protocol February 8, 2000
C.11. SDP Equivalents C.11. SDP Equivalents
______________________________________________________________ ______________________________________________________________
| PropertyID| Tag | Type | Value | | PropertyID| Tag | Type | Value |
| SDP_V | B001| STRING| Protocol Version | | SDP_V | B001| STRING| Protocol Version |
| SDP_O | B002| STRING| Owner-creator and session ID | | SDP_O | B002| STRING| Owner-creator and session ID |
| SDP_S | B003| STRING| Sesson name | | SDP_S | B003| STRING| Sesson name |
| SDP_I | B004| STRING| Session identifier | | SDP_I | B004| STRING| Session identifier |
| SDP_U | B005| STRING| URI of descriptor | | SDP_U | B005| STRING| URI of descriptor |
| SDC_E | B006| STRING| email address | | SDC_E | B006| STRING| email address |
skipping to change at page 105, line 45 skipping to change at page 107, line 43
|OLCrej| C004| octet string| OpenLogicalChannelReject structure. | |OLCrej| C004| octet string| OpenLogicalChannelReject structure. |
|CLC | C005| octet string| CloseLogicalChannel structure. | |CLC | C005| octet string| CloseLogicalChannel structure. |
|CLCack| C006| octet string| CloseLogicalChannelAck structure. | |CLCack| C006| octet string| CloseLogicalChannelAck structure. |
|______|______|______________|_________________________________________| |______|______|______________|_________________________________________|
ANNEX D TRANSPORT OVER IP (NORMATIVE) ANNEX D TRANSPORT OVER IP (NORMATIVE)
D.1. Transport over IP/UDP using Application Level Framing D.1. Transport over IP/UDP using Application Level Framing
Protocol messages defined in this document may be transmitted over UDP. Protocol messages defined in this document may be transmitted over UDP.
When no port is specified for by the other side (see section 7.2.8), the When no port is provided by the peer (see section 7.2.8), the commands
commands should be sent to the default port. should be sent to the default number, xxxx for text-encoded operation or
yyyy for binary-encoded operation. Responses must always be sent to the
address and port from which the corresponding commands were sent.
D.1.1. Providing At-Most-Once Functionality D.1.1. Providing At-Most-Once Functionality
Messages, being carried over UDP, may be subject to losses. In the Messages, being carried over UDP, may be subject to losses. In the
absence of a timely response, commands are repeated. Most commands are
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
absence of a timely response, commands are repeated. Most commands are
not idempotent. The state of the MG would become unpredictable if, for not idempotent. The state of the MG would become unpredictable if, for
example, Add commands were executed several times. The transmission example, Add commands were executed several times. The transmission
procedures shall thus provide an "At- Most-Once" functionality. procedures shall thus provide an "At- Most-Once" functionality.
Peer protocol entities are expected to keep in memory a list of the Peer protocol entities are expected to keep in memory a list of the
responses that they sent to recent transactions and a list of the tran- responses that they sent to recent transactions and a list of the tran-
sactions that are currently outstanding. The transaction identifiers of sactions that are currently outstanding. The transaction identifiers of
incoming messages are compared to the transaction identifiers of the incoming messages are compared to the transaction identifiers of the
recent responses from the same entity. If a match is found, the entity recent responses to the same MId. If a match is found, the entity does
does not execute the transaction, but simply repeats the response. The not execute the transaction, but simply repeats the response. The
remaining messages will be compared to the list of current transactions. remaining messages will be compared to the list of current transactions.
If a match is found, indicating a duplicate transaction, the entity does If a match is found, indicating a duplicate transaction, the entity does
not execute the transaction, which is simply ignored. not execute the transaction, which is simply ignored.
The procedure uses a long timer value, noted LONG-TIMER in the follow- The procedure uses a long timer value, noted LONG-TIMER in the follow-
ing. The timer should be set larger than the maximum duration of a ing. The timer should be set larger than the maximum duration of a
transaction, which should take into account the maximum number of transaction, which should take into account the maximum number of
repetitions, the maximum value of the repetition timer and the maximum repetitions, the maximum value of the repetition timer and the maximum
propagation delay of a packet in the network. A suggested value is 30 propagation delay of a packet in the network. A suggested value is 30
seconds. seconds.
skipping to change at page 107, line 4 skipping to change at page 108, line 54
processes will share the same transaction number space. There are mul- processes will share the same transaction number space. There are mul-
tiple possible implementations of this sharing, such as having a cen- tiple possible implementations of this sharing, such as having a cen-
tralized allocation of transaction identifiers, or pre-allocating non- tralized allocation of transaction identifiers, or pre-allocating non-
overlapping ranges of identifiers to different processes. The implemen- overlapping ranges of identifiers to different processes. The implemen-
tations shall guarantee that unique transaction identifiers are allo- tations shall guarantee that unique transaction identifiers are allo-
cated to all transactions that originate from a logical MGC (identical cated to all transactions that originate from a logical MGC (identical
mId). MGs can simply detect duplicate transactions by looking at the mId). MGs can simply detect duplicate transactions by looking at the
transaction identifier and mId only. transaction identifier and mId only.
The Response Acknowledgement parameter can be found in any message. It The Response Acknowledgement parameter can be found in any message. It
carries a set of "confirmed transaction-id ranges". Entities may choose
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
carries a set of "confirmed transaction-id ranges". Entities may choose
to delete the copies of the responses to transactions whose id is to delete the copies of the responses to transactions whose id is
included in "confirmed transaction-id ranges" received in the transac- included in "confirmed transaction-id ranges" received in the transac-
tion response messages. They should silently discard further commands tion response messages. They should silently discard further commands
when the transaction-id falls within these ranges. when the transaction-id falls within these ranges.
The "confirmed transaction-id ranges" values shall not be used if more The "confirmed transaction-id ranges" values shall not be used if more
than LONG-TIMER seconds have elapsed since the MG issued its last than LONG-TIMER seconds have elapsed since the MG issued its last
response to that MGC, or when a MG resumes operation. In this situa- response to that MGC, or when a MG resumes operation. In this situa-
tion, transactions should be accepted and processed, without any test on tion, transactions should be accepted and processed, without any test on
the transaction-id. the transaction-id.
skipping to change at page 108, line 4 skipping to change at page 109, line 51
If only the firstAck is present in a response acknowledgement, only one If only the firstAck is present in a response acknowledgement, only one
transaction is acknowledged. If both firstAck and lastAck are present, transaction is acknowledged. If both firstAck and lastAck are present,
then the range of transactions from firstAck to lastAck is acknowledged. then the range of transactions from firstAck to lastAck is acknowledged.
The ABNF of Annex B is modified so that: The ABNF of Annex B is modified so that:
transactionList = 1*(transactionRequest / transactionReply / transactionList = 1*(transactionRequest / transactionReply /
transactionPending / transactionResponseAck) transactionPending / transactionResponseAck)
transactionResponseAck = ResponseAckToken LBRKT transactionAck transactionResponseAck = ResponseAckToken LBRKT transactionAck
*(COMMA transactionAck) RBRKT
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
*(COMMA transactionAck) RBRKT
transactionAck = transactionID / (transactionID "-" transactionID) transactionAck = transactionID / (transactionID "-" transactionID)
ResponseAckToken = "TransactionResponseAck" | "K" ResponseAckToken = "TransactionResponseAck" | "K"
D.1.3. Computing retransmission timers D.1.3. Computing retransmission timers
It is the responsibility of the requesting entity to provide suitable It is the responsibility of the requesting entity to provide suitable
time outs for all outstanding transactions, and to retry transactions time outs for all outstanding transactions, and to retry transactions
when time outs have been exceeded. Furthermore, when repeated transac- when time outs have been exceeded. Furthermore, when repeated transac-
tions fail to be acknowledged, it is the responsibility of the request- tions fail to be acknowledged, it is the responsibility of the request-
ing entity to seek redundant services and/or clear existing or pending ing entity to seek redundant services and/or clear existing or pending
skipping to change at page 109, line 5 skipping to change at page 111, line 5
* It should set the retransmission timer to the sum of that random * It should set the retransmission timer to the sum of that random
value and N times the average deviation. value and N times the average deviation.
This procedure has two effects. Because it includes an exponentially This procedure has two effects. Because it includes an exponentially
increasing component, it will automatically slow down the stream of mes- increasing component, it will automatically slow down the stream of mes-
sages in case of congestion. Because it includes a random component, it sages in case of congestion. Because it includes a random component, it
will break the potential synchronization between notifications triggered will break the potential synchronization between notifications triggered
by the same external event. by the same external event.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
D.1.4. Provisional responses D.1.4. Provisional responses
Executing some transactions may require a long time. Long execution Executing some transactions may require a long time. Long execution
times may interact with the timer based retransmission procedure. This times may interact with the timer based retransmission procedure. This
may result either in an inordinate number of retransmissions, or in may result either in an inordinate number of retransmissions, or in
timer values that become too long to be efficient. Entities that can timer values that become too long to be efficient. Entities that can
predict that a transaction will require a long execution time may send a predict that a transaction will require a long execution time may send a
provisional response, "Transaction Pending". They should send this provisional response, "Transaction Pending". They should send this
response if they receive a repetition of a transaction that is still response if they receive a repetition of a transaction that is still
skipping to change at page 110, line 5 skipping to change at page 112, line 5
* entity failure, when for example an entire entity become unavail- * entity failure, when for example an entire entity become unavail-
able. able.
The entities should be able to derive from the past history an estimate The entities should be able to derive from the past history an estimate
of the packet loss rate due to transmission errors. In a properly con- of the packet loss rate due to transmission errors. In a properly con-
figured system, this loss rate should be kept very low, typically less figured system, this loss rate should be kept very low, typically less
than 1%. If a Media Gateway Controller or a Media Gateway has to repeat than 1%. If a Media Gateway Controller or a Media Gateway has to repeat
a message more than a few times, it is very legitimate to assume that a message more than a few times, it is very legitimate to assume that
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
something else than a transmission error is occurring. For example, something else than a transmission error is occurring. For example,
given a loss rate of 1%, the probability that five consecutive transmis- given a loss rate of 1%, the probability that five consecutive transmis-
sion attempts fail is 1 in 100 billion, an event that should occur less sion attempts fail is 1 in 100 billion, an event that should occur less
than once every 10 days for a Media Gateway Controller that processes 1 than once every 10 days for a Media Gateway Controller that processes 1
000 transactions per second. (Indeed, the number of repetition that is 000 transactions per second. (Indeed, the number of repetition that is
considered excessive should be a function of the prevailing packet loss considered excessive should be a function of the prevailing packet loss
rate.) We should note that the "suspicion threshold", which we will call rate.) We should note that the "suspicion threshold", which we will call
"Max1", is normally lower than the "disconnection threshold", which "Max1", is normally lower than the "disconnection threshold", which
should be set to a larger value. should be set to a larger value.
skipping to change at page 110, line 46 skipping to change at page 112, line 46
It is, however, important that the maximum delay of retransmissions be It is, however, important that the maximum delay of retransmissions be
bounded. Prior to any retransmission, it is checked that the time bounded. Prior to any retransmission, it is checked that the time
elapsed since the sending of the initial datagram is no greater than T- elapsed since the sending of the initial datagram is no greater than T-
MAX. If more than T-MAX time has elapsed, the MG concludes that the MGC MAX. If more than T-MAX time has elapsed, the MG concludes that the MGC
has failed, and it begins its recovery process. When the MG establishes has failed, and it begins its recovery process. When the MG establishes
a new control association, it can retransmit to the new MGC. The value a new control association, it can retransmit to the new MGC. The value
T-MAX is related to the LONG- TIMER value: the LONG-TIMER value is T-MAX is related to the LONG- TIMER value: the LONG-TIMER value is
obtained by adding to T-MAX the maximum propagation delay in the net- obtained by adding to T-MAX the maximum propagation delay in the net-
work. work.
D.2. using TCP D.2. Using TCP
Protocol messages as defined in this document may be transmitted over Protocol messages as defined in this document may be transmitted over
TCP. When no port is specified by the other side (see section 7.2.8), TCP. When no port is specified by the other side (see section 7.2.8),
the commands should be sent to the default port. The defined protocol the commands should be sent to the default port. The defined protocol
has messages as the unit of transfer, while TCP is a stream-oriented has messages as the unit of transfer, while TCP is a stream-oriented
protocol. TPKT, according to RFC1006 SHALL be used to delineate mes- protocol. TPKT, according to RFC1006 SHALL be used to delineate mes-
sages within the TCP stream. sages within the TCP stream.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
In a transaction-oriented protocol, there are still ways for transaction In a transaction-oriented protocol, there are still ways for transaction
requests or responses to be lost. As such, it is recommended that enti- requests or responses to be lost. As such, it is recommended that enti-
ties using TCP transport implement application level timers for each ties using TCP transport implement application level timers for each
request and each response, similar to those specified for application request and each response, similar to those specified for application
level framing over UDP. level framing over UDP.
D.2.1. Providing the At-Most-Once functionality D.2.1. Providing the At-Most-Once functionality
Messages, being carried over TCP, are not subject to transport losses, Messages, being carried over TCP, are not subject to transport losses,
skipping to change at page 112, line 5 skipping to change at page 114, line 5
send this response if they receive a repetition of a transaction that is send this response if they receive a repetition of a transaction that is
still being executed. still being executed.
Entities that receive a Transaction Pending shall switch to a longer Entities that receive a Transaction Pending shall switch to a longer
repetition timer for that transaction. repetition timer for that transaction.
Entities shall retain Transactions and replies until they are confirmed. Entities shall retain Transactions and replies until they are confirmed.
The basic procedure of section D.1.4 should be followed, but simple The basic procedure of section D.1.4 should be followed, but simple
timer values should be sufficient. timer values should be sufficient.
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
D.2.5. Ordering of commands D.2.5. Ordering of commands
TCP provides ordered delivery of transactions. No special procedures TCP provides ordered delivery of transactions. No special procedures
are required. It should be noted that ALF/UDP allows sending entity to are required. It should be noted that ALF/UDP allows sending entity to
modify its behavior under congestion, and in particular, could reorder modify its behavior under congestion, and in particular, could reorder
transactions when congestion is encountered. TCP could not achieve the transactions when congestion is encountered. TCP could not achieve the
same results. same results.
ANNEX E BASIC PACKAGES ANNEX E BASIC PACKAGES
skipping to change at page 112, line 35 skipping to change at page 114, line 35
Generic package for commonly encountered items Generic package for commonly encountered items
E.1.1. Properties E.1.1. Properties
None None
E.1.2. Events E.1.2. Events
Cause Cause
EventID: cause (0x0001) EventID: cause (0x0001)
Generic error eventEvent Descriptor Generic error event
Parameters: Event Descriptor Parameters:
General Cause General Cause
ParameterID: Generalcause (0x0001) ParameterID: Generalcause (0x0001)
This parameter groups the failures into six groups, This parameter groups the failures into six groups,
which the MGC may act upon. which the MGC may act upon.
Possible values: Enumerated, Possible values: Enumerated,
"NR" Normal Release (0x0001) "NR" Normal Release (0x0001)
"UR" Unavailable Resources (0x0002) "UR" Unavailable Resources (0x0002)
"FT" Failure, Temporary (0x0003) "FT" Failure, Temporary (0x0003)
"FP" Failure, Permanent (0x0004) "FP" Failure, Permanent (0x0004)
"IW" Interworking Error (0x0005) "IW" Interworking Error (0x0005)
"UN" Unsupported (0x0006) "UN" Unsupported (0x0006)
Failure Cause Failure Cause
ParameterID: Failurecause (0x0002) ParameterID: Failurecause (0x0002)
Possible Values: OCTET STRING Possible Values: OCTET STRING
Description: The Release Cause is the value generated Description: The Release Cause is the value generated
by the Released equipment, i.e. a released network by the Released equipment, i.e. a released network
connection. The concerned value is defined in the connection. The concerned value is defined in the
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
appropriate bearer control protocol. appropriate bearer control protocol.
Signal Completion
EventID: sc (0x0002)
Indicates termination of one or more signals for which the
notifyCompletion parameter was set to "ON". For further
procedural description, see sections 7.1.11, 7.1.17, and 7.2.7.
Internet draft MEGACO Protocol January 27, 2000 ObservedEvents Descriptor parameters:
Signal Identity
ParameterID: SigID (0x0001)
This parameter identifies the signals which have terminated.
Type: list
Possible values: a list of signals and/or sequential
signal lists which have terminated. A signal outside
of a sequential signal list shall be identified using
the pkgdName syntax without wildcarding. An
individual signal inside of a sequential signal list
shall be identified using the sequential signal list
syntax with the correct signal list identifier,
enclosing the name of the specific signal which
terminated in pkgdName syntax.
E.1.3. Signals Termination Method
ParameterID: Meth (0x0002)
Indicates the means by which the signal terminated.
Type: enumeration
Possible values:
"TO" (0x0001) Duration expired
"EV" (0x0002) Interrupted by event
"SD" (0x0003) Halted by new Signals Descriptor
"FL" (0x0004) Failure
Internet draft MEGACO Protocol February 8, 2000
19.1.3. Signals
None None
E.1.4. Statistics 19.1.4. Statistics
None None
E.2. Base Root Package 19.2. Base Root Package
Base Root Package Base Root Package
PackageID: root (0x000f) PackageID: root (0x000f)
Version: 1 Version: 1
Extends: None Extends: None
Description: Description:
This package defines Gateway wide properties. This package defines Gateway wide properties.
E.2.1. Properties 19.2.1. Properties
MaxNrOfContexts MaxNrOfContexts
PropertyID: maxNumberOfContexts (0x0001) PropertyID: maxNumberOfContexts (0x0001)
The value of this property gives the maximum number of The value of this property gives the maximum number of
contexts that can exist at any time. The NULL context contexts that can exist at any time. The NULL context
is not included in this number. is not included in this number.
Type: Double Type: Double
Possible values: 1 and up Possible values: 1 and up
MaxTerminationsPerContext MaxTerminationsPerContext
PropertyID: maxTerminationsPerContext (0x0002) PropertyID: maxTerminationsPerContext (0x0002)
skipping to change at page 115, line 5 skipping to change at page 117, line 5
the MGC expects a response to any transaction from the MGC expects a response to any transaction from
the MG (exclusive of network delay) the MG (exclusive of network delay)
Type: Integer Type: Integer
Possible Values: any integer, represents milliseconds Possible Values: any integer, represents milliseconds
normalMGCExecutionTime normalMGCExecutionTime
PropertyId: normalMGCExecutionTime (0x0004) PropertyId: normalMGCExecutionTime (0x0004)
Settable by the MGC to indicate the interval within which Settable by the MGC to indicate the interval within which
the MG should expects a response to any transaction the MG should expects a response to any transaction
from the MGC (exclusive of network delay) from the MGC (exclusive of network delay)
Internet draft MEGACO Protocol January 27, 2000 Internet draft MEGACO Protocol February 8, 2000
Type: Integer Type: Integer
Possible Values: any integer, represents milliseconds Possible Values: any integer, represents milliseconds
ProvisionalResponseTimerValue ProvisionalResponseTimerValue
PropertyId: ProvisionalResponseTimerValue (0x0005) PropertyId: ProvisionalResponseTimerValue (0x0005)
Indicates the time within which to expect a Pending Indicates the time within which to expect a Pending
Response if a Transaction cannot be completed. Response if a Transaction cannot be completed.
Initially set to normalMGExecutionTime or Initially set to normalMGExecutionTime or
normalMGCExecutionTime as appropriate, plus network normalMGCExecutionTime as appropriate, plus network
delay, but may be lowered. delay, but may be lowered.
skipping to change at page 116, line 5 skipping to change at page 118, line 5
Type: Integer Type: Integer
Possible Value: any integer Possible Value: any integer
Characteristics: Read-only Characteristics: Read-only
PatternNum PatternNum
PropertyId: PatternNum (0x0008) PropertyId: PatternNum (0x0008)
Which pattern to read, zero based. Set by the MGC to Which pattern to read, zero based. Set by the MGC to
read a specific pattern in Pattern read a specific pattern in Pattern
Type: Integer Type: Integer
Possible Value: any integer less than MaxPatterns Possible Value: any integer less than MaxPatterns