MTPI Technical Specification

A PDF version of this document is available here.

Message Transfer Part Interface (MTPI)

Message Transfer Part Interface (MTPI) Specification

About This Manual

This is Edition 7.20141001, last updated 2014-10-25, of The Message Transfer Part Interface (MTPI) Specification, for Version 1.1 release 7.20141001 of the OpenSS7 package.

Preface

Notice

Software in this document and related software is released under the AGPL (see GNU Affero General Public License). Please note, however, that there are different licensing terms for some of the manual package and some of the documentation. Consult permission notices contained in the documentation of those components for more information.

This document is released under the FDL (see GNU Free Documentation License) with no invariant sections, no front-cover texts and no back-cover texts.

Abstract

This document is a Specification containing technical details concerning the implementation of the Message Transfer Part Interface (MTPI) for OpenSS7. It contains recommendations on software architecture as well as platform and system applicability of the Message Transfer Part Interface (MTPI).

This document specifies a Message Transfer Part Interface (MTPI) Specification in support of the OpenSS7 Message Transfer Part (MTP) protocol stacks. It provides abstraction of the Message Transfer interface to these components as well as providing a basis for Message Transfer control for other Message Transfer protocols.

Purpose

The purpose of this document is to provide technical documentation of the Message Transfer Part Interface (MTPI). This document is intended to be included with the OpenSS7 STREAMS software package released by OpenSS7 Corporation. It is intended to assist software developers, maintainers and users of the Message Transfer Part Interface (MTPI) with understanding the software architecture and technical interfaces that are made available in the software package.

Intent

It is the intent of this document that it act as the primary source of information concerning the Message Transfer Part Interface (MTPI). This document is intended to provide information for writers of OpenSS7 Message Transfer Part Interface (MTPI) applications as well as writers of OpenSS7 Message Transfer Part Interface (MTPI) Users.

Audience

The audience for this document is software developers, maintainers and users and integrators of the Message Transfer Part Interface (MTPI). The target audience is developers and users of the OpenSS7 SS7 stack.

Revision History

Take care that you are working with a current version of this documentation: you will not be notified of updates. To ensure that you are working with a current version, check the OpenSS7 Project website for a current version.

A current version of this specification is normally distributed with the OpenSS7 package, openss7-1.1.7.20141001.¹

Version Control

Although the author has attempted to ensure that the information in this document is complete and correct, neither the Author nor OpenSS7 Corporation will take any responsibility in it. OpenSS7 Corporation is making this documentation available as a reference point for the industry. While OpenSS7 Corporation believes that these interfaces are well defined in this release of the document, minor changes may be made prior to products conforming to the interfaces being made available. OpenSS7 Corporation reserves the right to revise this software and documentation for any reason, including but not limited to, conformity with standards promulgated by various agencies, utilization of advances in the state of the technical arts, or the reflection of changes in the design of any techniques, or procedures embodied, described, or referred to herein. OpenSS7 Corporation is under no obligation to provide any feature listed herein.

$Log: mtpi.texi,v $
Revision 1.1.2.2  2011-02-07 02:21:40  brian
- updated manuals

Revision 1.1.2.1  2009-06-21 10:54:11  brian
- added files to new distro

ISO 9000 Compliance

Only the TeX, texinfo, or roff source for this maual is controlled. An opaque (printed, postscript or portable document format) version of this manual is a UNCONTROLLED VERSION.

Disclaimer

OpenSS7 Corporation disclaims all warranties with regard to this documentation including all implied warranties of merchantability, fitness for a particular purpose, non-infrincement, or title; that the contents of the manual are suitable for any purpose, or that the implementation of such contents will not infringe on any third party patents, copyrights, trademarks or other rights. In no event shall OpenSS7 Corporation be liable for any direct, indirect, special or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action or contract, negligence or other tortious action, arising out of or in connection with any use of this documentation or the performance or implementation of the contents thereof.

U.S. Government Restricted Rights

If you are licensing this Software on behalf of the U.S. Government ("Government"), the following provisions apply to you. If the Software is supplied by the Department of Defense ("DoD"), it is classified as "Commercial Computer Software" under paragraph 252.227-7014 of the DoD Supplement to the Federal Aquisition Regulations ("DFARS") (or any successor regulations) and the Government is acquiring only the license rights granded herein (the license rights customarily provided to non-Government users). If the Software is supplied to any unit or agency of the Government other than DoD, it is classified as "Restricted Computer Software" and the Government’s rights in the Software are defined in paragraph 52.227-19 of the Federal Acquisition Regulations ("FAR") (or any successor regulations) or, in the cases of NASA, in paragraph 18.52.227-86 of the NASA Supplerment to the FAR (or any successor regulations).

Acknowledgements

The OpenSS7 Project was funded in part by:

Thanks to the subscribers to and sponsors of The OpenSS7 Project. Without their support, open software like this would not be possible.

As with most open source projects, this project would not have been possible without the valiant efforts and productive software of the Free Software Foundation, the Linux Kernel Community, and the open source software movement at large.

1 Introduction

This document specifies a STREAMS-based kernel-level instantiation of the ITU-T Message Transfer Part Interface (MTPI) definition. The Message Transfer Part Interface (MTPI) enables the user of a Message Transfer service to access and use any of a variety of conforming Message Transfer providers without specific knowledge of the provider’s protocol. The service interface is designed to support any network Message Transfer protocol and user Message Transfer protocol. This interface only specifies access to Message Transfer service providers, and does not address issues concerning Message Transfer management, protocol performance, and performance analysis tools.

This specification assumes that the reader is familiar with ITU-T state machines and Message Transfer interfaces (e.g. Q.704, T1.111.4), and STREAMS.

1.1 Related Documentation

— ITU-T Recommendation Q.704 (White Book)
— ETSI ETS 300 008-1
— ANSI T1.111.4/2002
— System V Interface Definition, Issue 2 — Volume 3

1.1.1 Role

This document specifies an interface that supports the services provided by the Signalling System No. 7 (SS7) for ITU-T, ANSI and ETSI applications as described in ITU-T Recommendation Q.704, ANSI T1.111.4, ETSI ETS 300 008-1. These specifications are targeted for use by developers and testers of protocol modules that require Message Transfer service.

1.2 Definitions, Acronyms, Abbreviations

Originating SL User: A SL-User that initiates a Signalling Link.
Destination SL User: A SL-User with whom an originating SL user wishes to establish a Signalling Link.
ISO: International Organization for Standardization
SL User: Kernel level protocol or user level application that is accessing the services of the Signalling Link sub-layer.
SL Provider: Signalling Link sub-layer entity/entities that provide/s the services of the Signalling Link interface.
SLI: Signalling Link Interface
TIDU: Signalling Link Interface Data Unit
TSDU: Signalling Link Service Data Unit
OSI: Open Systems Interconnection
QOS: Quality of Service
STREAMS: A communication services development facility first available with UNIX System V Release 3.

2 The MTP Layer

The MTP Layer provides the means to manage the association of MTP-Users into connections. It is responsible for the routing and management of data to and from SS7 network connections between MTP-user entities.

2.1 Model of the MTPI

The MTPI defines the services provided by the signalling link layer to the signalling link user at the boundary between the signalling link provider and the signalling link user entity. The interface consists of a set of primitives defined as STREAMS messages that provide access to the signalling link layer services, and are transferred between the MTP user entity and the MTP provider. These primitives are of two types; ones that originate from the MTP user, and other that originate from the MTP provider. The primitives that originate from the MTP user make requests to the MTP provider, or respond to an indication of an event of the MTP provider. The primitives that originate from the MTP provider are either confirmations of a request or are indications to the CCS user that an event has occurred. Figure 1 shows the model of the MTPI.

Figure 1. Model of the MTPI

The MTPI allows the MTP provider to be configured with any MTP user (such as ISUP) that also conforms to the MTPI. A call control layer user can also be a user program that conforms to the MTPI and accesses the MTP provider via putmsg(2s) and getmsg(2s) system calls.

2.2 MTPI Services

The features of the MTPI are defined in terms of the services provided by the MTP, and the individual primitives that may flow between the MTP-User and the MTP.

The services supported by the MTPI are based on two distinct modes of communication, connectionless (CLMS) and connection oriented (COMS). Within these modes, the MTPI provides support for both sequenced and unsequenced message transfer. Also, the MTPI supports services for local mangement.

2.2.1 CLMS

The main features of the connectionless mode of communication are:

it is datagram oriented;
it provides transfer of data in self contained units;
there is no logical relationship between these units of data.

Connectionless mode communication has no separate phases. Each unit of data is transmitted from source to destination independently, appropriate addressing information is included with each unit of data. Although the units of data are transmitted independently from source to destination, MTP provides a high level of assurance of sequencing if sequenced service is requested. When unsequenced service is requested, there are no guarantees of proper sequence. Although MTP services are inherently unreliable, MTP provide a high level of assurance that messages are not lost.

The connectionless service of MTP is suited to MTP User protocols such as the Signalling Connection Control Part (SCCP).²

2.2.2 COMS

The main features of the MTP connection oriented mode of communication are:

it is virtual circuit oriented;
it provides transfer of data via a pre-established path.

There are three phases to each instance of communication: Connection Establishment, Data Transfer; and Connection Termination. Units of data arrive at their destination in the same order as they departed their source when the sequenced delivery service is requested and the data is protected against duplication or loss of data within some specified quality of service.

The connection oriented service of MTP is suited to MTP User protocols such as the Integrated Services Digital Network User Part (ISUP), [Q.764] Telephone User Part (TUP), [Q.724] and Bearer Indexed Call Control (BICC).³

2.2.3 Local Management

The MTPI specifications also defines a set of local management functions that apply to COMS and CLMS modes of communication. These services have local significance only.

2.2.4 Provider Management

The MTPI specification also defines a set of provider management functions that apply to the MTP service provider. These services have local and end-to-end significance.

2.3 MTP Service Primitives

Table 1, Table 2, Table 3 and Table 4 summarize the MTPI service primitives by their state and service

Table 1. MTPI Service Primitives for Local Management

Table 2. MTPI Service Primitives for Connectionless Mode Data Transfer

Table 3. MTPI Service Primitives for Connection Mode Data Transfer

Table 4. MTPI Service Primitives for MTP Management

3 MTPI Services Definition

This section describes the services of the MTPI primitives. Time-sequence diagrams that illustrate the sequence of primitives are included.⁴ The format of the primitives will be defined later in this document.

3.1 Local Management Services

The services defined in this section are outside the scope of international standards. These services apply to COMS and CLMS modes of communication. They are invoked for the initialization/de-initialization of a stream connected to the MTP. They are also used to manage options supported by the MTP and to report information on the supported parameter values.

3.1.1 Message Transfer Part Information Reporting Service

This service provides information on the options supported by the MTP provider.

MTP_INFO_REQ:: This primitive requests that the MTP return the values of all the supported protocol parameters. This request may be invoked during any phase.
MTP_INFO_ACK:: This primitive is in response to the MTP_INFO_REQ primitive and returns the values of the supported protocol parameters to the MTP-User.

The sequence of primitives for MTP information management is shown in Figure 2.

Figure 2. Message Transfer Part Information Reporting Service

3.1.2 MTP Address Service

This service allows an MTP-User to determine the MTP address (MTP-SAPI or signalling point code and service indicator) that has been associated with a Stream. It permits the MTP-User to not necessarily retain this information locally, and allows the MTP-User to determine this information from the MTP provider at any time.

MTP_ADDR_REQ:: This primitive requests that the MTP return information concerning which MTP address (MTP-SAPI) the MTP-User is bound as well as the MTP address upon which the MTP-User is currently engaged in association.
MTP_ADDR_ACK:: This primitive is in response to the MTP_ADDR_REQ primitive and indicates to the MTP-User the requested information.

The sequence of primitives is shown in Figure 3.

Figure 3. Message Transfer Part User Address Service

3.1.3 MTP User Bind Service

This service allows an MTP address (MTP-SAPI: signalling point code and service indicator) to be associated with a Stream.

It allows the MTP-User to negotiate the number of connect indications that can remain unacknowledged for that MTP-User (a connect indication is considered unacknowledged while it is awaiting a corresponding connect response or release request from the MTP-User). This service also defines a mechanism that allows a Stream (bound to an MTP address of the MTP-User) to be reserved to handle incoming connections only. This Stream is referred to as the listener Stream.

MTP_BIND_REQ:: This primitive requests that the MTP-User be bound to a particular MTP address (MTP-SAPI), and negotiate the number of allowable outstanding connect indications for that address.
MTP_BIND_ACK:: This primitive is in response to the MTP_BIND_REQ primitive and indicates to the user that the specified MTP-User has been bound to an MTP address.

The sequence of primitives is shown in Figure 4.

Figure 4. Message Transfer Part User Bind Service

3.1.4 MTP User Unbind Service

This service allows the MTP-User to be unbound from an MTP address.

MTP_UNBIND_REQ:: This primitive requests that the MTP-User be unbound from the MTP address that it had previously been bound to.

The sequence of primitives is shown in Figure 5.

Figure 5. Message Transfer Part User Unbind Service

3.1.5 Receipt Acknowledgement Service

MTP_OK_ACK:: This primitive indicates to the MTP-User that the previous MTP-User originated primitive was received successfully by the MTP.

An example showing the sequence of primitives for successful receipt acknowledgement is depicted in Figure 6.

Figure 6. Message Transfer Part Receipt Ackknowledgement Service

3.1.6 Options Management Service

This service allows the MTP-User to manage options parameter values associated wtih the MTP.

MTP_OPTMGMT_REQ:: This primitive allows the MTP-User to select default values for options parameters within the range supported by the MTP, and to indicate the default selection of receipt confirmation.

Figure 7 shows the sequence of primitives for MTP options management.

Figure 7. Message Transfer Part Options Management Service

3.1.7 Error Acknowledgement Service

MTP_ERROR_ACK:: This primitive indicates to the MTP-User that a non-fatal error has occured in the last MTP-User originated request or response primitive (listed in Figure 8), on the stream.

Figure 8 shows the sequence or primitives for the error management primitive.

Figure 8. Message Transfer Part Error Acknowledgement Service

3.2 Connectionless Services

The CLMS allows for the transfer of MTP-User data in one or both directions simultaneously without establishing an association between MTP-User peers. A set of primitives are defined that carry user data and control information between the MTP-User and MTP entities. The primitives are modeled as requests initiated by the MTP-User and indications initiated by the MTP provider. Indications may be initiated by the MTP independently from requests by the MTP-User.

The connectionless MTP service consists of one phase.

3.2.1 Data Transfer

3.2.1.1 User Primitives for Data Transfer

MTP_TRANSFER_REQ:: This primitive requests that the MTP send the data unit to the specified destination with the specified sequence control.

3.2.1.2 Provider Primitives for Data Transfer

MTP_TRANSFER_IND:: This primitive indicates to the MTP-User that a data unit has been received from the specified source address.

Figure 9 shows the sequence of primitives for the connectionless mode of data transfer.

Figure 9. Message Transfer Part Data Transfer

3.2.2 Error Management

3.2.2.1 Provider Primitives for Error Management

MTP_PAUSE_IND:: This primitive indicates to the MTP-User that the specified destination address is no longer accessible.
MTP_RESUME_IND:: This primitive indicates to the MTP-User that the specified destination address is now accessible.
MTP_STATUS_IND:: This primitive indicates ot the MTP-User that the congestions status to the specified destination address has changed, or that the remote MTP-User is no longer available.

Figure 10 shows the sequence of primitives for the connectionless mode error management primitives.

Figure 10. Message Transfer Part Error Management

3.3 Connection Oriented Services

This section describes the required MTP service primitives that define the CLMS interface.

The queue model for CLMS is discused in more detail in ITU-T Q.704. [Q.704] For Q.704 specific conformance considerations, see Addendum 1.

The queue model represents the operation of an MTP connection in the abstract by a pair of queues linking the two MTP addresses. There is one queue for each direction of signalling transfer. The ability of a user to add objects to a queue will be determined by the behavior of the user removing objects from that queue, and the state of the queue. The pair of queues is considered to be available for each potential association. Objects that are entered or removed from the queue are either as a result of interactions at the two MTP addresses, or as the result of MTP initiatives.

- A queue is empty until a connect object has been entered and can be returned to this state, with loss of its contents, by the MTP.
- Objects may be entered into a queue as a result of the action of the source MTP-User, subject to control by the MTP.
- Objects may also be entered into a queue by the MTP.
- Objects are removed from the queue under the control of the receiving MTP user.
- Objects are normally removed under the control of the MTP-User in the same order as they were entered except:
- if the object is of a type defined to be able to advance ahead of the preceding object (however, no object is defined to be able to advance ahead of another object of the same type), or
- if the following object is defined to be destructive with respect to the preceding object on the queue. If necessary, the last object on the queue will be deleted to allow a destructive object to be entered — they will therefore always be added to the queue. For example, "reset" objects are defined to be destructive with respect to all other objects.

Table 5 shows the ordering relationship amoung the queue model objects.

Table 5. Flow Control Relationships Between Queue Model Objects

AA	Indicates that Object X is defined to be able to advance ahead of preceding Object Y.
DES	Indicates that Object X is defined to be destructive with respect to preceding Object Y.
-	Indicates that Object X is neither destructive with respect to Object Y, nor able to advance ahead of Object Y.
N/A	Indicates that Object X will not occur in a position succeeding Object Y in a valid state of a queue.

3.3.1 Connection Establishment Phase

A pair of queues is associated with an MTP association between two MTP addresses when the MTP receives an MTP_CONN_REQ primitive at one of the MTP addresses resulting in a connect object being entered into the queue. The queues will remain associated with the MTP association until an MTP_DISCON_REQ primitive (resulting in a disconnect object) is either entered or removed from a queue. Similarly, in the queue from the remote MTP-User, objects can be entered into the queue only after the connect object associated with an MTP_CONN_REQ has been entered into the queue.

The MTP association procedure will fail if the MTP is unable to route to the remote MTP-User.

3.3.1.1 User primitives for Successful MTP Association Establishment

MTP_CONN_REQ:: This primitive requests that the MTP establish an association between the local MTP-User and the specified destination.

3.3.1.2 Provider primitives for Successful MTP Association Establishment

MTP_CONN_CON:: This primitive indicates to the MTP-User that an association request has been confirmed.

The sequence of primitives in a successful MTP association establishment is defined by the time sequence diagram as shown in Figure 11.

Figure 11. Message Transfer Part Association Service

3.3.2 Data Transfer Phase

Flow control on the MTP association is done by management of queue capacity, by allowing objects of certain type to be inserted to the queues as shown in Table 5.

3.3.2.1 User primitives for MTP Data Transfer

MTP_TRANSFER_REQ:: This primitive requests that the MTP transfer the specified data.

3.3.2.2 Provider primitives for MTP Data Transfer

MTP_TRANSFER_IND:: This primitive indicates to the MTP-User that this message contains data.

Figure 12 shows the sequence of primitives for successful data transfer. The sequence of primitives may remain incomplete if an MTP_DISCON_REQ primitive occurs.

Figure 12. Message Transfer Part Data Transfer

This sequence of primtives may remain incomplete if an MTP_PAUSE or MTP_STATUS indication is received from the MTP.

3.3.3 Error Management Primitives

The MTP error management service is used by the MTP to report detected loss of unrecoverable data.

3.3.3.1 Provider Primitives for Management

MTP_PAUSE_IND:: This primitive indicates to the MTP-User that the remote MTP is no longer accessible.
MTP_RESUME_IND:: This primitive indicates to the MTP-User that the remote MTP is now accesible.
MTP_STATUS_IND:: This pirmitive indicates to the MTP-User that the congestion status to te remote MTP has changed, or that the remote MTP User is no longer accessible.

Figure 13 shows the sequence of primitives for the connection mode error management primitives. The sequence of primitives may remain incomplete if an MTP_DISCON_REQ or MTP_DISCON_IND primitive occurs.

Figure 13. Message Transfer Part Error Management

3.3.4 Connection Termination Phase

The MTP association release procedure is initialized by the insertion of a disconnect object (associated with an MTP_DISCON_REQ) into the queue. As shown in Figure 13, the disconnect procedure is destructive with respect to other objects in the queue, and eventually results in the emptying of queues and termination of the MTP association.

3.3.4.1 User Primitives for MTP Association Termination

MTP_DISCON_REQ:: This primitive requests that the MTP disconnect an existing MTP association.

The sequence of primitives are shown in the time sequence diagram in Figure 14.

Figure 14. Message Transfer Part Connection Termination

3.4 MTP Provider Management Services

This section describes the required MTP service primitives that define the MTP Provider Management interface.

MTP Provider Management allows for the coordination of MTP management messages between MTP Provider peers. A set of primitives are defined that invoke management actions that are communicated from MTP to MTP entities. The primitives are modeled as requires initiated by the MTP management and indications initiated by the MTP. Indications may be initiated by the MTP independently from requests by the MTP management.

The MTP Provider Management service consists of one phase.

3.4.1 Link Management

The MTP link management service allows MTP management to inhibit or uninhibit a link, linkset or combined linkset.

3.4.1.1 User Primitives for Link Inhibit Service

MTP_INHIBIT_REQ:: Requests that the MTP inhibit the specified link, linkset or combined linkset.

3.4.1.2 Provider Primitives for Link Inhibit Service

MTP_INHIBIT_IND:: Indicates that the remote MTP has inibited the specified link, linkset or combined linkset.
MTP_INHIBIT_CON:: Confirms that the MTP has successfully inhibited the specified link, linkset or combined linkset in coordination with the MTP peer.

Figure 15 shows the sequence of primitives for the MTP management link inihibit service, for a successful link inhibit.

Figure 15. Message Transfer Part Successful Link Inhibit

Figure 16 shows the sequence of primitives for the MTP management link inihibit service, for an unsuccessful link inhibit.

Figure 16. Message Transfer Part Unsuccessful Link Inhibit

3.4.1.3 User Primitives for Link Uninhibit Service

MTP_UNINHIBIT_REQ:: Requests that the MTP uninhibit the specified link, linkset or combined linkset.

3.4.1.4 Provider Primitives for Link Uninhibit Service

MTP_UNINHIBIT_IND:: Indicates that an inhibit attempt has failed or the remote MTP has uninibited the specified link, linkset or combined linkset.
MTP_UNINHIBIT_CON:: Confirms that the MTP has successfully uninhibited the specified link, linkset or combined linkset in coordination with the MTP peer.

Figure 17 shows the sequence of primitives for the MTP management link uninihibit service.

Figure 17. Message Transfer Part Link Uninhibit Service

3.4.2 Route Management

The MTP route management service allows MTP management to allow or prohibit a route or routeset to a specific destination.

3.4.2.1 User Primitives for Route Allow Service

MTP_ALLOW_REQ:: Requests that the MTP allow the specified route or routeset for the specified destination.

3.4.2.2 Provider Primitives for Route Allow Service

MTP_ALLOW_IND:: Indicates to the MTP-User that the network has allowed the specified route or routeset for the specified destination.
MTP_ALLOW_CON:: Confirms to the MTP-User that the MTP has successfully allowed the specified route or routeset for the specified destination to the network.

Figure 18 shows the sequence of primitives for the MTP management route allow service.

Figure 18. Message Transfer Part Route Allow Service

3.4.2.3 User Primitives for Route Prohibit Service

MTP_PROHIBIT_REQ:: Requests that the MTP prohibit the specified route or routeset for the specified destination.

3.4.2.4 Provider Primitives for Route Prohibit Service

MTP_PROHIBIT_IND:: Indicates to the MTP-User that an allow request has failed or the network has prohibitted the specified route or routeset for the specified destination.
MTP_PROHIBIT_CON:: Confirms to the MTP-User that the MTP has successfully prohibited the specified route or routeset for the specified destination to the newtork.

Figure 19 shows the sequence of primitives for the MTP management route prohibit service.

Figure 19. Message Transfer Part Route Prohibit Service

3.4.3 Layer Management

The MTP layer management service allows MTP management to request and receive event indications (alarms and 1st and deltas) and to request and receive stats indications (statistics and operational measurements) for specified intervals.

3.4.3.1 User Primitives for Event Indications

MTP_NOTIFY_REQ:: Requests that the MTP issue notifications for specified events.

3.4.3.2 Provider Primitives for Event Indications

MTP_EVENT_IND:: Indicates to the MTP-User a notification of a requested event.

Figure 20 shows the sequence of primitives for the MTP management event service.

Figure 20. Message Transfer Part Event Service

3.4.3.3 User Primitives for Statistics Indications

MTP_STATS_REQ:: Requests that the MTP collect specified statistics and operational measurements on specified intervals.

3.4.3.4 Provider Primitives for Statistics Indications

MTP_STATS_IND:: Indicates to the MTP-User that the specified statistics and operational measurements have been collected as requested.

Figure 21 shows the sequence of primitives for the MTP management statistics service.

Figure 21. Message Transfer Part Measurements Service

4 MTPI Primitives

This section describes the format and parameters of the MTPI primitives (Mapping MTPI Primitives, shows the mapping of MTPI primitives for the primitives defined in Q.701 [Q.701] and T1.111.1 [T1.111.1]).

Also, it discusses the states the primitive is valid in, the resulting state, and the acknowledgement that the primitive expects. (The state/event tables for these primitives are shown in State/Event Tables. The precedence tables for the MTPI primitives are shown in Precedence Tables.) Rules for ITU-T conformance [Q.704] are described in addendum to this document in Addendum for MTP Conformance, rules for ANSI conformance [T1.111] are described in addendum Addendum for MTP Conformance, and rules for JITC conformance [JQ.704] are described in addendum Addendum for MTP Conformance.

Table 6, Table 7 and ‘Table 8’ provide a summary of the MTP MTP primitives and their parameters.

4.1 Local Management Primitives

These primitives apply to CLMS and COMS.

4.1.1 Message Transfer Part Information Request

MTP_INFO_REQ

This primitive requests the MTP to return the values of all supported protocol parameters (see under MTP_INFO_ACK), and also the current state of the MTP (as defined in Appendix B). This primitive does not affect the state of the MTP and does not appear in the state tables.

Format

The format of the message is one M_PCPROTO message block and its structure is as follows:

typedef struct MTP_info_req {
        mtp_ulong mtp_primitive;        /* always MTP_INFO_REQ */
} MTP_info_req_t;

Parameters

mtp_primitive: Indicates the primitive type. This field is always coded MTP_INFO_REQ.

Valid States

This primitive is valid in any state where a local acknowledgement is not pending.

New State

The new state remains unchanged.

Acknowledgements

This primitive requires the MTP to generate one of the following acknowledgements upon receipt of the primitive:

– Successful: Acknowledgement of the primitive via the MTP_INFO_ACK primitive.
– Non-fatal errors: There are no errors associated with the issuance of this primitive.

4.1.2 Message Transfer Part Information Acknowledgement

MTP_INFO_ACK

This primitive indicates to the MTP-User any relevant protocol-dependent parameters. It should be initiated in response to the MTP_INFO_REQ primitive described above.

Format

The format of this message is one M_PCPROTO message block and its structure is as follows:

typedef struct MTP_info_ack {
        mtp_ulong mtp_primitive;        /* always MTP_INFO_ACK */
        mtp_ulong mtp_msu_size;         /* maximum MSU size for guaranteed delivery */
        mtp_ulong mtp_addr_size;        /* maximum address size */
        mtp_ulong mtp_addr_length;      /* address length */
        mtp_ulong mtp_addr_offset;      /* address offset */
        mtp_ulong mtp_current_state;    /* current interface state */
        mtp_ulong mtp_serv_type;        /* service type */
        mtp_ulong mtp_version;          /* version of interface */
} MTP_info_ack_t;

#define M_COMS  1               /* Connection-mode MTP service supported */
#define M_CLMS  2               /* Connection-less MTP service supported */

Parameters

The above fields have the following meaning:

mtp_primitive: Indicates the primitive type. This field is always coded MTP_INFO_ACK.
mtp_msu_size: Indicates the maximum MSU size.
mtp_addr_size: Indicates the (maximum) size of an MTP address (MTP-SAPI).
mtp_addr_length: Indicates the length of the bound and connected MTP addresses. When the stream is in a bound state, the MTP addresses include the bound address. When the stream is in a connected state and the service type is M_COMS, the MTP addresses also includes the connected address.
mtp_addr_offset: Indicates the offset of the bound and connected MTP addresses from the start of the M_PCPROTO block.
mtp_current_state: Indicates the current state of the MTP interface.
mtp_serv_type: Indicates the service type of the interface. The service type is either M_COMS or M_CLMS.
mtp_version: Indicates the version of the interface.

Flags

Valid States

This primitive is valid in any state in response to an MTP_INFO_REQ primitive.

New State

The state remains the same.

4.1.3 Protocol Address Request

MTP_ADDR_REQ

This primitive requests that the MTP return information concerning the MTP addresses upon which the MTP-User is bound or engaged in an association.

The format of the message is one M_PROTO message block and its structure is as follows:

typedef struct MTP_addr_req {
        mtp_ulong mtp_primitive;        /* always MTP_ADDR_REQ */
} MTP_addr_req_t;

Parameters

mtp_primitive: Specifies the primitive type. This field is always coded MTP_ADDR_REQ.

Valid States

This primitive is valid in any state.

New State

The new state is MTPS_WACK_AREQ.

Rules

— If the stream is not in a bound state, no bound or connected address information will be returned in the MTP_ADDR_ACK.
— If the stream is bound and not connected, no connected address information will be returned in the MTP_ADDR_ACK.

Acknowledgements

The MTP will generate on of the following acknowledgements upon receipt of the MTP_ADDR_REQ primitive:

— Successful: Correct acknowledgment of the primitive is indicated via the MTP_ADDR_ACK primitive.
— Unsuccessful (Non-fatal errors): These errors will be indicated via the MTP_ERROR_ACK primitive. The applicable non-fatal errors are as follows:

MSYSERR

A system error occured and the UNIX system error is indicated in the primitive.

4.1.4 Protocol Address Acknowledgement

MTP_ADDR_ACK

This primitive acknowledges the corresponding request primitive and is used by the MTP to return information concerning the local and remote protocol addresses for the stream.

The format of the message is one M_PCPROTO message block and its structure is as follows:

typedef struct MTP_addr_ack {
        mtp_ulong mtp_primitive;        /* always MTP_ADDR_ACK */
        mtp_ulong mtp_loc_length;       /* length of local MTP address */
        mtp_ulong mtp_loc_offset;       /* offset of local MTP address */
        mtp_ulong mtp_rem_length;       /* length of remote MTP address */
        mtp_ulong mtp_rem_offset;       /* offset of remote MTP address */
} MTP_addr_ack_t;

Parameters

mtp_primitive: Indicates the primitive type. This field is always coded MTP_ADDR_ACK.
mtp_loc_length: Indicates the length of the local MTP address (MTP-SAPI). If the stream is not bound to a local MTP-SAPI, this field will be coded zero (0).
mtp_loc_offset: Indicates the offset of the local MTP address (MTP-SAPI) from the start of the M_PCPROTO message block. If the stream is not bound to a local MTP-SAPI, this field will be coded zero (0).
mtp_rem_length: Indicates the length of the remote MTP address (MTP-SAPI). If the stream is not connected to a remote MTP-SAPI, this field will be coded zero (0).
mtp_rem_offset: Indicates the offset of the remote MTP address (MTP-SAPI) from the start of the M_PCPROTO message block. If the stream is not connected to a remote MTP-SAPI, this field will be coded zero (0).

Valid State

This primitive is valid in state MTP_WACK_AREQ.

New State

The new state is the state previous to the MTP_ADDR_REQ.

Rules

— If the requesting stream is not bound to an MTP address (MTP-SAPI), the MTP will code the mtp_loc_length and mtp_loc_offset fields to zero. Otherwise, the MTP will return the same MTP address that was returned in the MTP_BIND_ACK.
— If the requesting stream is not associated with a remote peer (i.e, not bound in a signalling relation), the MTP will code the mtp_rem_length and mtp_rem_offset fields to zero. Otherwise, the MTP will indicate the remote MTP address (MTP-SAPI) of the associated remote MTP-User.

4.1.5 Bind Protocol Address Request

MTP_BIND_REQ

This primitive requests that the MTP bind an MTP-User entity to an MTP address (MTP-SAPI).

Format

The format of the message is one M_PROTO message block and its structure is as follows:

typedef struct MTP_bind_req {
        mtp_ulong mtp_primitive;        /* always MTP_BIND_REQ */
        mtp_ulong mtp_addr_length;      /* length of MTP address */
        mtp_ulong mtp_addr_offset;      /* offset of MTP address */
        mtp_ulong mtp_bind_flags;       /* bind flags */
} MTP_bind_req_t;

Parameters

mtp_primitive: Is the primitive type. This field is always coded MTP_BIND_REQ.
mtp_addr_length: Is the length in bytes of the MTP address (MTP-SAPI) to be bound to the stream.
mtp_addr_offset: Is the offset from the beginning of the M_PROTO block where the MTP address (MTP-SAPI) begins.
mtp_bind_flags: See "Flags" below.

Flags

Only one of the following flags may be set:

MTP_MANAGEMENT: When set, this flag indicates that this stream is to be bound only as MTP management and not as an MTP-User. The stream can then invoke MTP Management services for the bound MTP entity.
MTP_CONNECTION_ORIENTED: When set, this flag specifies that this stream is to be bound for COMS service regardless of the Service Indicator in the bound address.
MTP_CONNECTIONLESS: When set, this flag specifies that this stream is to be bound for CLMS service regardless of the Service Indicator in the bound address.

When all flags are clear, the COMS or CLMS service type will be chosen according to the Service Indicator in the specified address.

Valid States

This primitive is valid in state MTPS_UNBND (see Appendix B).

New State

The new state is MTPS_WACK_BREQ.

Acknowledgements

The MTP will generate one of the following acknowledgements upon receipt of the MTP_BIND_REQ primitive:

— Successful: Correct acknowledgement of the primitive is indicated via the MTP_BIND_ACK primitive.
— Non-fatal errors: These errors will be indicated viat the MTP_ERROR_ACK primitive. The applicable non-fatal errors are as follows:

MSYSERR

A system error occured and the UNIX system error is indicated in the primitive.

MOUTSTATE

The primitive was issued from an invalid state.

MBADADDR

The MTP address (MTP-SAPI) was in an incorrect format or the address contained illegal information. It is not intended to indicate protocol errors.

MNOADDR

The MTP-User did not provide an MTP address (MTP-SAPI) and the MTP could not allocate an address to the user.

MADDRBUSY

The MTP-User attempted to bind a second stream to an MTP address (MTP-SAPI).

MACCESS

The MTP-User attempted to bind to an MTP address (MTP-SAPI) for which it did not have sufficient access permissions or attemtped to bind with the MTP_MANAGEMENT flag set and did not have permission to bind as MTP management.

MBOUND

The MTP-User attempted to bind a second stream to an MTP address with the MTP_MANAGEMENT flag set.

MBADPRIM

The primitive format was incorrect (i.e. too short).

4.1.6 Bind Protocol Address Acknowledgement

MTP_BIND_ACK

This primitive indicates to the MTP-User that the specified MTP-User entity has been bound to the requested MTP address (MTP-SAPI).

Format

The format of the meessage is one M_PCPROTO message block, and its structure is the following:

typedef struct MTP_bind_ack {
        mtp_ulong mtp_primitive;        /* always MTP_BIND_ACK */
        mtp_ulong mtp_addr_length;      /* length of bound MTP address */
        mtp_ulong mtp_addr_offset;      /* offset of bound MTP address */
} MTP_bind_ack_t;

Parameters

mtp_primitive

Indicates the primitive type. This field is always coded MTP_BIND_ACK.

mtp_addr_length

Is the length of the MTP address (MTP-SAPI) that was bound.

mtp_addr_offset

Is the offset from the beginning of the M_PCPROTO block where the MTP address (MTP-SAPI) begins.

The proper alignment of the address in the M_PCPROTO message block is not guaranteed.

Rules

The following rules apply to the binding of the specified MTP address to the stream:

— If the mtp_addr_length field in the MTP_BIND_REQ primitive is zero, then the MTP is to assign an MTP address (MTP-SAPI) to the user.
— The MTP is to bind the MTP address (MTP-SAPI) as specified in the MTP_BIND_REQ primitive. If the MTP cannot bind the specified address, it may assign another MTP address to the user. It is the MTP-User’s responsibility to check the MTP address returned in the MTP_BIND_ACK primitive to see if it is the same as the one requested.

If the above rules result in an error condition, then the MTP must issue an MTP_ERROR_ACK primitive to the MTP-User specifying the error as defined in the description of the MTP_BIND_REQ primitive.

Valid States

This primitive is in response to an MTP_BIND_REQ primitive and is valid in the state MTPS_WACK_BREQ.

New State

The new state is MTPS_IDLE.

4.1.7 Unbind Protocol Address Request

MTP_UNBIND_REQ

This primitive requests that the MTP unbind the MTP-User entity that was previously bound to the MTP address (MTP-SAPI).

Format

The format of the message is one M_PROTO block, and its structure is as follows:

typedef struct MTP_unbind_req {
        mtp_ulong mtp_primitive;        /* always MTP_UNBIND_REQ */
} MTP_unbind_req_t;

Parameters

mtp_primitive: Indicates the primitive type. This field is always coded MTP_UNBIND_REQ.

Valid States

This primitive is valid in the MTPS_IDLE state.

New State

The new state is MTPS_WACK_UREQ.

Acknowledgements

This primitive requires the MTP to generate the following acknolwedgements upon receipt of the primitive:

— Successful: Correct acknowledgement of the primitive is indicated via the MTP_OK_ACK primtiive.
— Unsuccessful (Non-fatal errors): These errors will be indicated via the MTP_ERROR_ACK primitive. The applicable non-fatal errors are as follows:

MOUTSTATE

The primitive was issued from an invalid state.

MSYSERR

A system error has occured and the UNIX system error is indicated in the primtiive.

4.1.8 Message Transfer Part Options Management Request

MTP_OPTMGMT_REQ

This primitive allows the MTP-User to manage the MTP parameter values associated with the stream.

Format

The format of the message is one M_PROTO message block, and its structure is as follows:

typedef struct MTP_optmgmt_req {
        mtp_ulong mtp_primitive;        /* always MTP_OPTMGMT_REQ */
        mtp_ulong mtp_opt_length;       /* length of options */
        mtp_ulong mtp_opt_offset;       /* offset of options */
        mtp_ulong mtp_mgmt_flags;       /* management flags */
} MTP_optmgmt_req_t;

#define MTP_DEFAULT     0UL
#define MTP_CHECK       1UL
#define MTP_NEGOTIATE   2UL
#define MTP_CURRENT     3UL

Parameters

mtp_primitive: Specifies the primitive type. This field is always coded MTP_OPTMGMT_REQ.
mtp_opt_length: Specifies the length of the default values of the options parameters as selected by the MTP-User. These values will be used in subsequent M_DATA transfers to the stream. If the MTP-User cannot determine the value of an option, it value should be set to MTP_UNKNOWN. If the MTP-User does not specify any option parameter values, the length of this field should be set to zero.
mtp_opt_offset: Specifies the offset of the options parameters from the beginning of the M_PROTO message block.
mtp_mgmt_flags: See "Flags" below.

Flags

MTP_DEFAULT: Requests that the MTP return the default option settings for the specified (or all) options in a MTP_OPTMGMT_ACK primitive.
MTP_CHECK: Requests that the MTP check the specified options and return the success or failure of each specified option in an MTP_OPTMGMT_ACK primitive.
MTP_NEGOTIATE: Requests that the MTP negotiate the value of the specified options and return the success or failure and the negotiated value in an MTP_OPTMGMT_ACK primitive.
MTP_CURRENT: Requests that the MTP return the current option settings for the specified (or all) options in a MTP_OPTMGMT_ACK primitive.

Only one of the above flags can be set.

Valid States

This primitive is valid in the MTPS_IDLE state.

New State

The new state is MTPS_WACK_OPTREQ.

Acknowledgements

The MTP_OPTMGMT_REQ primitive requires the MTP to generate one of the following acknowledgements upon receipt of the primitive:

— Successful: Acknowledgement is via the MTP_OK_ACK primitive. At successful completions, the resulting state is MTPS_IDLE.
— Non-fatal errors: These errors are indicated in the MTP_ERROR_ACK primitive. The resulting state remains unchanged. The applicable non-fatal errors are defined as follows:

MSYSERR

A system error has occurred and the UNIX system error is indicated in the primitive.

MOUTSTATE

The primitive was issued from an invalid state.

MBADOPT

The option parameter values specified are outside the range supported by the MTP.

MBADOPTTYPE

The option structure tupe is not supported by the MTP.

MBADFLAG

The flags were invalid or unsupported, or the combination of flags was invalid.

MBADPRIM

The primitive format was incorrect (i.e. too short).

MACCESS

The user did not have proper permissions.

4.1.9 Error Acknowledgement

MTP_ERROR_ACK

This primitive indicates to the MTP-User that a non-fatal error has occured in the last MTP-User or MTP-Management originated primitive. This may only be initiated as an acknowledgement for those primitives that require one. It also indicates to the user that no action was taken on the primitive that caused the error.

Format

The format of the mssage is one M_PCPROTO message block, and its structure is as follows:

typedef struct MTP_error_ack {
        mtp_ulong mtp_primitive;        /* always MTP_ERROR_ACK */
        mtp_ulong mtp_error_primitive;  /* primitive in error */
        mtp_ulong mtp_mtpi_error;       /* MTP interface error */
        mtp_ulong mtp_unix_error;       /* UNIX error */
} MTP_error_ack_t;

Parameters

mtp_primitive: Identifies the primitive type. This field is always coded MTP_ERROR_ACK.
mtp_error_primitive: Identifies the primitive type that cause the error.
mtp_mtpi_error: Contains the Message Transfer Part Interface error code.
mtp_unix_error: Contains the UNIX system error code. This may only be non-zero if the mtp_mtpi_error is equal to MSYSERR.

Valid Error Codes

The following error codes are allowed to be returned:

MSYSERR: A system error has occurred and the UNIX system error is indicated in the primitive.
MOUTSTATE: The primitive was issued from an invalid state.
MBADADDR: The MTP address as specified in the primitive was in an incorrect format, or the address contained illegal information.
MBADOPT: The options values as specified in the primitive were in an incorrect format, or they contained illegal information.
MBADOPTTYPE: The option structure tupe is not supported by the MTP.
MNOADDR: The MTP could not allocate an address.
MADDRBUSY: The MTP could not use the specified address because the specified address is already in use.
MBADFLAG: The flags specified in the primitive were incorrect or illegal.
MNOTSUPPORT: Specified primitive type is not known to the MTP.
MBADPRIM: The primitive was of an incorrect format (i.e. too small, or an offset it out of range).
MACCESS: The user did not have proper permissions.

Valid States

This primitive is valid in all states that have a pending acknowledgment or confirmation.

New State

The new state is the same as the one from which the acknowledged request or response was issued.

4.1.10 Successful Receipt Acknowledgements

MTP_OK_ACK

The primitive indicates to the MTP-User that the previous MTP-User or management originated primitive was received successfully by the MTP. It does not indicate to the MTP-User any MTP protocol action taken due to the issuance of the last primitive. The MTP_OK_ACK primitive may only be initiated as an acknowledgement for those user or management originated primitives that have no other means of confirmation.

Format

The format of the mssage is one M_PCPROTO message block, and its structrue is as follows:

typedef struct MTP_ok_ack {
        mtp_ulong mtp_primitive;        /* always MTP_OK_ACK */
        mtp_ulong mtp_correct_prim;     /* correct primitive */
} MTP_ok_ack_t;

Parameters

mtp_primitive: Identifies the primitive. This field is always coded MTP_OK_ACK.
mtp_correct_prim: Identifies the successfully received primitive type.

Valid States

This primitive is issued in states MTPS_WACK_UREQ, MTPS_WACK_OPTREQ, MTPS_WACK_CREQ and MTPS_WACK_DREQ.

New State

The resulting state depends on the current state (see Appendix B, Tables B-7 and B-8.).

4.2 Connection Mode and Connectionless Primitives

This section describes the format of the COMS primitives and the rules associated with these primitives. The default values of the options parameters associated with an MTP association may be selected via the MTP_OPTMGMT_REQ primitive.

4.2.1 Signalling Relation Establishment Phase

The following MTP service primitives pertain to the establishment of an association between local and remote MTP-SAPs, provided the MTP users exist, and are known to the MTP.

4.2.1.1 Message Transfer Part Connection Request

MTP_CONN_REQ

This primitive requests that the MTP form an association to the specified destination.

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO message block is as follows:

typedef struct MTP_conn_req {
        mtp_ulong mtp_primitive;        /* always MTP_CONN_REQ */
        mtp_ulong mtp_addr_length;      /* length of MTP address to connect */
        mtp_ulong mtp_addr_offset;      /* offset of MTP address to connect */
        mtp_ulong mtp_conn_flags;       /* connect flags */
} MTP_conn_req_t;

Parameters

mtp_primitive: Specifies the primitive type. This field is always coded MTP_CONN_REQ.
mtp_addr_length: Specifies the length of the MTP address (MTP-SAPI) of the peer to which a signalling relation is to be established. If no MTP address is provided by the MTP-User, this field must be coded zero (0). The coding of the MTP address (MTP-SAPI) is protocol and provider-specific.
mtp_addr_offset: Specifies the offset of the MTP address (MTP-SAPI) from the beginning of the M_PROTO message block.
mtp_conn_flags: Indicates a bit field of connection options. (See Flags below.)

Flags

Rules

The following rules apply to the establishment of associations between the specified addresses:

— If the mtp_addr_length field in the MTP_CONN_REQ primitive is zero, then the MTP is to select a remote MTP address (MTP-SAPI) with which to associate. If the MTP cannot select a address for the association, the MTP responds with an MTP_ERROR_ACK primitive with error MNOADDR.
— If the mtp_addr_length field in the MTP_CONN_REQ primitive is non-zero, the MTP is to associate with the specified remote MTP address (MTP-SAPI). if the MTP cannot associate with the specified remote MTP address (MTP-SAPI), the primitive will fail and the MTP will return an MTP_ERROR_ACK primitive with the appropriate error value (e.g, MBADADDR).

The following rules apply to the MTP addresses (MTP-SAPIs):

— If the MTP-User does not specify an MTP address (i.e. mtp_addr_length is set to zero), then the MTP may attempt to assign a remote MTP address (MTP-SAPI) and associate it with the stream for the duration of the association.

Valid States

This primitive is valid in state MTPS_IDLE.

New State

The new state is MTPS_DATA_XFER.

Acknowledgements

The following acknolwedgements are valid for this primitive:

— Successful: Correct acknowledgement of the primtive is indicated via the MTP_OK_ACK primitive.
— Unsuccessful (Non-fatal errors): These are indicated via the MTP_ERROR_ACK primitive. The applicable non-fatal errors are defined as follows:

MSYSERR

A system error has occurred and the UNIX system eror is indicated in the primitive.

MOUTSTATE

The primitive was issued from an invalid state.

MBADADDR

The MTP address as specified in the primitive was in an incorrect format, or the address contained illegal information.

MNOADDR

The user did not provide an MTP address and one was required by the MTP. The MTP could not select a remote MTP address (MTP-SAPI).

MADDRBUSY

The MTP could not use the specified address because the specified address is already in use.

MBADFLAG

The specified flags were invalid.

MNOTSUPPORT

The primitive is not supported for by the MTP provider.

MBADPRIM

The primitive was of an incorrect format (i.e. too small, or an offset it out of range).

MACCESS

The user did not have proper permissions for the use of the requested address.

4.2.2 Signalling Relation Data Transfer Phase

The data transfer service primitive provide for an exchange of MTP-User data, known as MSDUs, in either direction or in both directions simultaneously on a signalling relation. The MTP service preserves the sequence of MSDUs that have the same Signalling Link Selection (SLS) value specified in the MTP_TRANSFER_REQ. MSDUs are self-contained messages with implicit boundaries.

The following MTP service primtiives pertain to the Data Transfer phase of a signalling relation.

4.2.2.1 Message Transfer Part Transfer Request

MTP_TRANSFER_REQ

This user-originated primitive indicates to the MTP that this message contains MTP-User data. It allows the transfer of MTP-User data between MTP-Users, without modification by the MTP provider.

The MTP-User must send an integral number of octets of data greater than zero. In a case where the size of the MSDU exceeds the MIDU (as specified by the size of the MIDU_size parameter of the MTP_INFO_ACK primitive), the MSDU may be broken up into more than one MIDU. When an MSDU is broken up into more than one MIDU, the MTP_MORE_DATA_FLAG will be set on each MIDU except the last one.

Format

The format of the message is one or more M_DATA blocks. Use of a M_PROTO message block is optional. The M_PROTO message block is used for two reasons:

to indicate that the MSDU is broken into more than one MIDU, and that the data carried in the following M_DATA message block constitutes one MIDU;
to indicate the message priority and signalling link selection to be associated with the MSDU.

Guidelines for the use of M_PROTO

The following guidelines must be followed with respect to the use of the M_PROTO message block:

The M_PROTO message block need not be present when the MSDU size is less than or equal to the MIDU size and one of the following is true:
- - the values of the message priority and signalling link selection have been previously set with the MTP_OPTMGMT_REQ primitive; or
- - the default values of the message priority and signalling link selection are to be specified.
The M_PROTO message block must be present when:
- - The MSDU size is greater than the MIDU size.
- - the values of the message priority or signalling link selection as specified by the MTP_OPTMGMT_REQ primitive needs to be overriden for this MSDU.

The format of the M_PROTO message block, if present, is as follows:

typedef struct MTP_transfer_req {
        mtp_ulong mtp_primitive;        /* always MTP_TRANSFER_REQ */
        mtp_ulong mtp_dest_length;      /* length of destination address */
        mtp_ulong mtp_dest_offset;      /* offset of destination address */
        mtp_ulong mtp_mp;               /* message priority */
        mtp_ulong mtp_sls;              /* signalling link selection */
} MTP_transfer_req_t;

Parameters

mtp_primitive: Specifies the primitive type. This field is always coded MTP_TRANSFER_REQ.
mtp_dest_length: Specifies the length of the destination MTP address (MTP-SAPI) to which the message is to be sent. If the stream is connected in an established signalling relation, this field may be coded zero (0).
mtp_dest_offset: Specifies the offset of the destination MTP address (MTP-SAPI) from the beginning of the M_PROTO message block.
mtp_mp: Specifies the message priority to be used when sending the message. Support for message priority is protocol variant and provider specific.
mtp_sls: Specifies the signalling link selection value to be used when sending the message. If this field is coded MTP_UNKNOWN (-1) then the MTP provider will choose a value of the signalling link selection which best performs loadsharing of the resulting message traffic.

Rules

If the signalling relation is associated with a single destination address (MTP-SAPI), M_DATA blocks can be used with no M_PROTO block to transfer messages. The destination adddress and the values of SLS and MP will be the default values or the laster values that were successfully set with MTP_OPTMGMT_REQ.

Valid States

This primitive is valid in state MTP_IDLE for connectionless streams and in state MTP_DATA_XFER for pseudo-connection oriented streams.

New State

The new state is unchanged.

Acknowledgements

This primitive does not require any acknowledgements, although it may generate a fatal error. This is indicated to the MTP-User via a M_ERROR STREAMS message type (specifying an errno value of [EPROTO]) which results in the failure of all system calls on that stream. The applicable errors are defined as follows:

[EPROTO]

This indicates one of the following unrecoverable protocol conditions:

— The MTP interface was found to be in an incorrect state.
— The amount of MTP-User data associated wtih the primitive was outside the range supported by the MTP (as specified in the MIDU_size parameter of the MTP_INFO_ACK primitive).
— The options requested are either not support by the MTP.
— The M_PROTO message block was not followed by one or more M_DATA message blocks.
— The amount of MTP-User data associated with the current MSDU is outside the range supported by the MTP (as specified by the MSDU_size parameter in the MTP_INFO_ACK primitive.)
— The flags field contained an unknown value.

Note. If the interface is in the MTP_IDLE state when the provider received the MTP_TRANSFER_REQ primitive, then the MTP should discard the request without generating a fatal error.

4.2.2.2 Message Transfer Part Transfer Indication

MTP_TRANSFER_IND

Format

The format of this message is one M_PROTO message block followed by one or more M_DATA message blocks. The structure of the M_PROTO message block is as follows:

typedef struct MTP_transfer_ind {
        mtp_ulong mtp_primitive;        /* always MTP_TRANSFER_IND */
        mtp_ulong mtp_srce_length;      /* length of source address */
        mtp_ulong mtp_srce_offset;      /* offset of source address */
        mtp_ulong mtp_mp;               /* message priority */
        mtp_ulong mtp_sls;              /* signalling link selection */
} MTP_transfer_ind_t;

Parameters

mtp_primitive: Indicates the primitive type. This field is always coded MTP_TRANSFER_IND.
mtp_srce_length
mtp_srce_offset
mtp_mp
mtp_sls

Rules

Valid States

This primitive is valid in state MTP_DATA_XFER.

New State

The new state is unchanged.

4.2.2.3 Message Transfer Part Status Indication

MTP_STATUS_IND

Format

The format of the message is one M_PCPROTO message block. The structure of the M_PCPROTO message block is as follows:

typedef struct MTP_status_ind {
        mtp_ulong mtp_primitive;        /* always MTP_STATUS_IND */
        mtp_ulong mtp_addr_length;      /* length of affected MTP address */
        mtp_ulong mtp_addr_offset;      /* offset of affected MTP address */
        mtp_ulong mtp_type;             /* type */
        mtp_ulong mtp_status;           /* status */
} MTP_status_ind_t;

/* Type for MTP_STATUS_IND */
#define MTP_STATUS_TYPE_CONG            0x00    /* congestion */
#define MTP_STATUS_TYPE_UPU             0x01    /* user part unavailability */

/* Status for MTP_STATUS_IND, with MTP_STATUS_TYPE_UPU */
#define MTP_STATUS_UPU_UNKNOWN          0x01    /* unknown */
#define MTP_STATUS_UPU_UNEQUIPPED       0x02    /* unequipped remote user. */
#define MTP_STATUS_UPU_INACCESSIBLE     0x03    /* inaccessible remote user. 
                                                 */

/* Status for MTP_STATUS_IND, with MTP_STATUS_TYPE_CONG */
#define MTP_STATUS_CONGESTION_LEVEL0    0x00    /* congestion level 0 */
#define MTP_STATUS_CONGESTION_LEVEL1    0x01    /* congestion level 1 */
#define MTP_STATUS_CONGESTION_LEVEL2    0x02    /* congestion level 2 */
#define MTP_STATUS_CONGESTION_LEVEL3    0x03    /* congestion level 3 */
#define MTP_STATUS_CONGESTION           0x04    /* congestion */

Parameters

mtp_primitive: Indicates the primitive type. This field is always coded MTP_STATUS_IND.
mtp_addr_length: Indicates the length of the affected MTP address (MTP-SAPI).
mtp_addr_offset: Indicates the offset of the affected MTP address (MTP-SAPI) from the beginning of the M_PCPROTO message block.
mtp_type: Inidcates the type of the status indication. See Type and Status below.
mtp_status: Inidcates the status of the status indication. See Type and Status below.

Type and Status

MTP_STATUS_TYPE_CONG

This type indicates that the affected MTP adddress (MTP-SAPI) is experiencing congestion and that the mtp_status field contains information pertaining to the degree of congestion experienced by the affected destination as follows:

MTP_STATUS_CONGESTION_LEVEL0: Signalling network congestion towards the affected destination has dropped to level zero (0), indicating that there is no longer signalling network congestion towards the affected destination. Whether this indication is given at all is protocol variant and provider-specific.
MTP_STATUS_CONGESTION_LEVEL1: Signalling network congestion towards the affected destination has onset or abated to level one (1). If possible, the MTP-User should withdraw from issuing MTP_TRANSFER_REQ primitives with mtp_mp fields set to less than one (1) to the affected destination.
MTP_STATUS_CONGESTION_LEVEL2: Signalling network congestion towards the affected destination has onset or abated to level two (2). If possible, the MTP-User should withdraw from issuing MTP_TRANSFER_REQ primitives with mtp_mp fields set to less than two (2) to the affected destination.
MTP_STATUS_CONGESTION_LEVEL3: Signalling network congestion towards the affected destination has onset or abated to level three (3). If possible, the MTP-User should withdraw from issuing MTP_TRANSFER_REQ primitives with mtp_mp fields set to less than three (3) to the affected destination.
MTP_STATUS_CONGESTION: Signalling network congestion exists towards the affected destination. If possible, the MTP-User should withdraw from issuing MTP_TRANSFER_REQ primitives of lower priority to the affected destination.

MTP congestion level status is protocol variant and provider specific. See the Addendum for more information.

MTP_STATUS_TYPE_UPU

This type indicates that the affected MTP address (MTP-SAPI) has no accessible corresponding MTP-User and that the mtp_status field contains information pertianing to the nature of the inaccessibility of the remote MTP-User at the affected destination as follows:

MTP_STATUS_UPU_UNKNOWN

Indicates that the reason for inaccessibility of the remote MTP-User is unknown.

MTP_STATUS_UPU_UNEQUIPPED

Indicates that the reason for inaccessibility of the remote MTP-User is that the remote MTP-User is not equipped at the affected MTP address (MTP-SAPI).

MTP_STATUS_UPU_INACCESSIBLE

Indicates that the reason for inaccessibility of the remote MTP-User is that the remote MTP-User is temporarily inaccessible at the affected MTP address (MTP-SAPI).

MTP user part status is protocol variant and provider specific. See the Addendum for more information.

Rules

Valid States

This primitive is valid in state MTPS_DATA_XFER.

New State

The new state is unchanged (MTPS_DATA_XFER).

4.2.2.4 Message Transfer Part Pause Indication

MTP_PAUSE_IND

This primitive indicates to the MTP-User that the indicated remote MTP-entity (signalling point) is temporarily inaccessible. This implies the inaccessibility of remote MTP-User at the affected signalling point.

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO message block is as follows:

typedef struct MTP_pause_ind {
        mtp_ulong mtp_primitive;        /* always MTP_PAUSE_IND */
        mtp_ulong mtp_addr_length;      /* length of affected MTP address */
        mtp_ulong mtp_addr_offset;      /* offset of affected MTP address */
} MTP_pause_ind_t;

Parameters

mtp_primitive: Indicates the primitive type.
mtp_addr_length: Indicates the length of the MTP address (MTP-SAPI) corresponding to the affected remote MTP-entity.
mtp_addr_offset: Indicates the offset of the MTP address (MTP-SAPI) from the beginning of the M_PROTO message block.

Rules

Valid States

This primitive is valid in state MTPS_DATA_XFER.

New State

The new state is unchanged (MTPS_DATA_XFER).

4.2.2.5 Message Transfer Part Resume Indication

MTP_RESUME_IND

This primitive indicates to the MTP-User that a previously inaccesible remote MTP-entity (signalling point) is now accessible. This does not imply the accessibility of the remote MTP-User at the affected signalling point: the MTP-User is responsible for sending protocol messages to the remote MTP-User to test its accessibility.

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO block is as follows:

typedef struct MTP_resume_ind {
        mtp_ulong mtp_primitive;        /* always MTP_RESUME_IND */
        mtp_ulong mtp_addr_length;      /* length of affected MTP address */
        mtp_ulong mtp_addr_offset;      /* offset of affected MTP address */
} MTP_resume_ind_t;

Parameters

mtp_primitive: Indicates the primitive type.
mtp_addr_length: Indicates the length of the MTP address (MTP-SAPI) corresponding to the affected remote MTP-entity.
mtp_addr_offset: Indicates the offset of the MTP address (MTP-SAPI) from the beginning of the M_PROTO message block.

Rules

Valid States

This primitive is valid in state MTPS_DATA_XFER.

New State

The new state is unchanged (MTPS_DATA_XFER).

4.2.2.6 Message Transfer Part Restart Complete Indication

MTP_RESTART_COMPLETE_IND

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO block is as follows:

typedef struct MTP_restart_complete_ind {
        mtp_ulong mtp_primitive;        /* always MTP_RESTART_COMPLETE_IND */
} MTP_restart_complete_ind_t;

Parameters

mtp_primitive: Indicates the primitive type.

Rules

Valid States

This primitive is valid in state MTPS_DATA_XFER.

New State

The new state is unchanged (MTPS_DATA_XFER).

4.2.3 Signalling Relation Release Phase

4.2.3.1 Message Transfer Part Disconnect Request

MTP_DISCON_REQ

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO block is as follows:

typedef struct MTP_discon_req {
        mtp_ulong mtp_primitive;        /* always MTP_DISCON_REQ */
} MTP_discon_req_t;

Parameters

mtp_primitive: Specifies the primitive type.

4.3.2.1 Route Prohibit Request

MTP_PROHIBIT_REQ

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO block is as follows:

Parameters

mtp_primitive: Specifies the primitive type.

Valid States

New State

Acknowledgements

4.3.2.2 Route Prohibit Indication

MTP_PROHIBIT_IND

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO block is as follows:

Parameters

mtp_primitive: Indicates the primitive type.

Rules

Valid States

New State

4.3.2.3 Route Prohibit Confirmation

MTP_PROHIBIT_CON

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO block is as follows:

Parameters

mtp_primitive: Indicates the primitive type.

Rules

Valid States

New State

4.3.2.4 Route Allow Request

MTP_ALLOW_REQ

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO block is as follows:

Parameters

mtp_primitive: Specifies the primitive type.

Valid States

New State

Acknowledgements

4.3.2.5 Route Allow Indication

MTP_ALLOW_IND

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO block is as follows:

Parameters

mtp_primitive: Indicates the primitive type.

Rules

Valid States

New State

4.3.2.6 Route Allow Confirmation

MTP_ALLOW_CON

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO block is as follows:

Parameters

mtp_primitive: Indicates the primitive type.

Rules

Valid States

New State

4.3.3 Layer Management Primitives

4.3.3.1 Layer Event Indication

MTP_EVENT_IND

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO block is as follows:

Parameters

mtp_primitive: Indicates the primitive type.

Rules

Valid States

New State

4.3.3.2 Statistics Indication

MTP_STATS_IND

Format

The format of the message is one M_PROTO message block. The structure of the M_PROTO block is as follows:

Parameters

mtp_primitive: Indicates the primitive type.

Rules

Valid States

New State

5 Diagnostics Requirements

Two error handling facilities should be provided to the MTP user: one to handle non-fatal errors, and the other to handle fatal errors.

5.1 Non-Fatal Error Handling Facility

These are errors that do not change the state of the MTP service interface as seen by the MTP service user, and provide the user the option of reissuing the MTP service primitive with the corrected options specification. The non-fatal error handling is provided only to those primitive that require acknowledgements, and uses the MTP_ERROR_ACK primitive to report these errors. These errors retain the state of hte MTP service interface the same as it was before the MTP service provider received the primitive that was in error. Syntax errros and rule violations are reported via the non-fatal error handling facility.

5.2 Fatal Error Handling Facility

These errors are issued by the MTP provider when it detects errors that are not correctable by the MTP user, or if it is unable to report a correctible error to the MTP user. Fatal errors are indicated via the STREAMS message type M_ERROR with the UNIX system error [EPROTO]. The M_ERROR STREAMS message type will result in the failure of all the UNIX system calls on the stream. The MTP user can recover from a fatal error by having all the processes close the files associated with the stream, and then reopening them for processing.

These errors are issued by the MTP when it detects errors that are not correctable by the MTP service user, or if it is unable to report a correctable error to the MTP service user. Fatal errors are indicated via the STREAMS message type M_ERROR with the UNIX system error [EPROTO]. The M_ERROR STREAMS message type will result in the failure of all the UNIX system calls on the stream. The MTP service user can recover from a fatal error by having all the processes close the files associated with the stream, and then reopening them for processing.

6 MTPI Input-Output Controls

6.1 MTP Protocol Object Options

Argument Format

typedef struct mtp_option {
        ulong type;                             /* object type */
        ulong id;                               /* object id */
        /* followed by object-specific protocol options structure */
} mtp_option_t;

Fields

type

The object type. The object type is one of the following objects:

MTP_OBJ_TYPE_SL: Signalling link object.
MTP_OBJ_TYPE_LK: Link set object.
MTP_OBJ_TYPE_LS: Combined Link Set object.
MTP_OBJ_TYPE_RT: Route object.
MTP_OBJ_TYPE_RL: Route List object.
MTP_OBJ_TYPE_RS: Route Set object.
MTP_OBJ_TYPE_SP: Signalling Point object.
MTP_OBJ_TYPE_NA: Network Appearance object.
MTP_OBJ_TYPE_DF: Default object.

id

The object identifier.

6.1.1 Get MTP Protocol Object Options

MTP_IOCGOPTION

Get the protocol options associated with the identified object.

6.1.2 Set MTP Protocol Object Options

MTP_IOCSOPTION

Set the protocol options associated with the identified object.

6.1.3 Signalling Link Options

typedef struct mtp_opt_conf_sl {
        /* signalling link timers */
        ulong t1;                               /* timer t1 value */
        ulong t2;                               /* timer t2 value */
        ulong t3;                               /* timer t3 value */
        ulong t4;                               /* timer t4 value */
        ulong t5;                               /* timer t5 value */
        ulong t12;                              /* timer t12 value */
        ulong t13;                              /* timer t13 value */
        ulong t14;                              /* timer t14 value */
        ulong t17;                              /* timer t17 value */
        ulong t19a;                             /* timer t19a value */
        ulong t20a;                             /* timer t20a value */
        ulong t21a;                             /* timer t21a value */
        ulong t22;                              /* timer t22 value */
        ulong t23;                              /* timer t23 value */
        ulong t24;                              /* timer t24 value */
        ulong t31a;                             /* timer t31a value */
        ulong t32a;                             /* timer t32a value */
        ulong t33a;                             /* timer t33a value */
        ulong t34a;                             /* timer t34a value */
        ulong t1t;                              /* timer t1t value */
        ulong t2t;                              /* timer t2t value */
        ulong t1s;                              /* timer t1s value */
} mtp_opt_conf_sl_t;

6.1.4 Link Set Options

typedef struct mtp_opt_conf_lk {
        /* signalling link timers */
        ulong t1;                               /* timer t1 value */
        ulong t2;                               /* timer t2 value */
        ulong t3;                               /* timer t3 value */
        ulong t4;                               /* timer t4 value */
        ulong t5;                               /* timer t5 value */
        ulong t12;                              /* timer t12 value */
        ulong t13;                              /* timer t13 value */
        ulong t14;                              /* timer t14 value */
        ulong t17;                              /* timer t17 value */
        ulong t19a;                             /* timer t19a value */
        ulong t20a;                             /* timer t20a value */
        ulong t21a;                             /* timer t21a value */
        ulong t22;                              /* timer t22 value */
        ulong t23;                              /* timer t23 value */
        ulong t24;                              /* timer t24 value */
        ulong t31a;                             /* timer t31a value */
        ulong t32a;                             /* timer t32a value */
        ulong t33a;                             /* timer t33a value */
        ulong t34a;                             /* timer t34a value */
        ulong t1t;                              /* timer t1t value */
        ulong t2t;                              /* timer t2t value */
        ulong t1s;                              /* timer t1s value */
        /* link timers */
        ulong t7;                               /* timer t7 value */
} mtp_opt_conf_lk_t;

6.1.5 Combined Link Set Options

typedef struct mtp_opt_conf_ls {
        /* signalling link timers */
        ulong t1;                               /* timer t1 value */
        ulong t2;                               /* timer t2 value */
        ulong t3;                               /* timer t3 value */
        ulong t4;                               /* timer t4 value */
        ulong t5;                               /* timer t5 value */
        ulong t12;                              /* timer t12 value */
        ulong t13;                              /* timer t13 value */
        ulong t14;                              /* timer t14 value */
        ulong t17;                              /* timer t17 value */
        ulong t19a;                             /* timer t19a value */
        ulong t20a;                             /* timer t20a value */
        ulong t21a;                             /* timer t21a value */
        ulong t22;                              /* timer t22 value */
        ulong t23;                              /* timer t23 value */
        ulong t24;                              /* timer t24 value */
        ulong t31a;                             /* timer t31a value */
        ulong t32a;                             /* timer t32a value */
        ulong t33a;                             /* timer t33a value */
        ulong t34a;                             /* timer t34a value */
        ulong t1t;                              /* timer t1t value */
        ulong t2t;                              /* timer t2t value */
        ulong t1s;                              /* timer t1s value */
        /* link timers */
        ulong t7;                               /* timer t7 value */
} mtp_opt_conf_ls_t;

6.1.6 Route Options

typedef struct mtp_opt_conf_rt {
        /* route timers */
        ulong t6;                               /* timer t6 value */
        ulong t10;                              /* timer t10 value */
} mtp_opt_conf_rt_t;

6.1.7 Route List Options

typedef struct mtp_opt_conf_rl {
        /* route timers */
        ulong t6;                               /* timer t6 value */
        ulong t10;                              /* timer t10 value */
} mtp_opt_conf_rl_t;

6.1.8 Route Set Options

typedef struct mtp_opt_conf_rs {
        /* route timers */
        ulong t6;                               /* timer t6 value */
        ulong t10;                              /* timer t10 value */
        /* route set timers */
        ulong t8;                               /* timer t8 value */
        ulong t11;                              /* timer t11 value */
        ulong t15;                              /* timer t15 value */
        ulong t16;                              /* timer t16 value */
        ulong t18a;                             /* timer t18a value */
} mtp_opt_conf_rs_t;

6.1.9 Signalling Point Options

typedef struct mtp_opt_conf_sp {
        /* signalling link timers */
        ulong t1;                               /* timer t1 value */
        ulong t2;                               /* timer t2 value */
        ulong t3;                               /* timer t3 value */
        ulong t4;                               /* timer t4 value */
        ulong t5;                               /* timer t5 value */
        ulong t12;                              /* timer t12 value */
        ulong t13;                              /* timer t13 value */
        ulong t14;                              /* timer t14 value */
        ulong t17;                              /* timer t17 value */
        ulong t19a;                             /* timer t19a value */
        ulong t20a;                             /* timer t20a value */
        ulong t21a;                             /* timer t21a value */
        ulong t22;                              /* timer t22 value */
        ulong t23;                              /* timer t23 value */
        ulong t24;                              /* timer t24 value */
        ulong t31a;                             /* timer t31a value */
        ulong t32a;                             /* timer t32a value */
        ulong t33a;                             /* timer t33a value */
        ulong t34a;                             /* timer t34a value */
        ulong t1t;                              /* timer t1t value */
        ulong t2t;                              /* timer t2t value */
        ulong t1s;                              /* timer t1s value */
        /* link timers */
        ulong t7;                               /* timer t7 value */
        /* route timers */
        ulong t6;                               /* timer t6 value */
        ulong t10;                              /* timer t10 value */
        /* route set timers */
        ulong t8;                               /* timer t8 value */
        ulong t11;                              /* timer t11 value */
        ulong t15;                              /* timer t15 value */
        ulong t16;                              /* timer t16 value */
        ulong t18a;                             /* timer t18a value */
        /* signalling point timers */
        ulong t1r;                              /* timer t1r value */
        ulong t18;                              /* timer t18 value */
        ulong t19;                              /* timer t19 value */
        ulong t20;                              /* timer t20 value */
        ulong t21;                              /* timer t21 value */
        ulong t22a;                             /* timer t22a value */
        ulong t23a;                             /* timer t23a value */
        ulong t24a;                             /* timer t24a value */
        ulong t25a;                             /* timer t25a value */
        ulong t26a;                             /* timer t26a value */
        ulong t27a;                             /* timer t27a value */
        ulong t28a;                             /* timer t28a value */
        ulong t29a;                             /* timer t29a value */
        ulong t30a;                             /* timer t30a value */
} mtp_opt_conf_sp_t;

6.1.10 Network Appearance Options

typedef struct mtp_opt_conf_na {
        /* signalling link timers */
        ulong t1;                               /* timer t1 value */
        ulong t2;                               /* timer t2 value */
        ulong t3;                               /* timer t3 value */
        ulong t4;                               /* timer t4 value */
        ulong t5;                               /* timer t5 value */
        ulong t12;                              /* timer t12 value */
        ulong t13;                              /* timer t13 value */
        ulong t14;                              /* timer t14 value */
        ulong t17;                              /* timer t17 value */
        ulong t19a;                             /* timer t19a value */
        ulong t20a;                             /* timer t20a value */
        ulong t21a;                             /* timer t21a value */
        ulong t22;                              /* timer t22 value */
        ulong t23;                              /* timer t23 value */
        ulong t24;                              /* timer t24 value */
        ulong t31a;                             /* timer t31a value */
        ulong t32a;                             /* timer t32a value */
        ulong t33a;                             /* timer t33a value */
        ulong t34a;                             /* timer t34a value */
        ulong t1t;                              /* timer t1t value */
        ulong t2t;                              /* timer t2t value */
        ulong t1s;                              /* timer t1s value */
        /* link timers */
        ulong t7;                               /* timer t7 value */
        /* route timers */
        ulong t6;                               /* timer t6 value */
        ulong t10;                              /* timer t10 value */
        /* route set timers */
        ulong t8;                               /* timer t8 value */
        ulong t11;                              /* timer t11 value */
        ulong t15;                              /* timer t15 value */
        ulong t16;                              /* timer t16 value */
        ulong t18a;                             /* timer t18a value */
        /* signalling point timers */
        ulong t1r;                              /* timer t1r value */
        ulong t18;                              /* timer t18 value */
        ulong t19;                              /* timer t19 value */
        ulong t20;                              /* timer t20 value */
        ulong t21;                              /* timer t21 value */
        ulong t22a;                             /* timer t22a value */
        ulong t23a;                             /* timer t23a value */
        ulong t24a;                             /* timer t24a value */
        ulong t25a;                             /* timer t25a value */
        ulong t26a;                             /* timer t26a value */
        ulong t27a;                             /* timer t27a value */
        ulong t28a;                             /* timer t28a value */
        ulong t29a;                             /* timer t29a value */
        ulong t30a;                             /* timer t30a value */
} mtp_opt_conf_na_t;

6.1.11 Default Options

typedef struct mtp_opt_conf_df {
} mtp_opt_conf_df_t;

6.2 MTP Protocol Object Configuration

Argument Format

typedef struct mtp_config {
        ulong type;                             /* object type */
        ulong id;                               /* object id */
        ulong cmd;                              /* configuration command */
        /* followed by object-specific configuration structure */
} mtp_config_t;

#define MTP_GET         0       /* get configuration */
#define MTP_ADD         1       /* add configuration */
#define MTP_CHA         2       /* cha configuration */
#define MTP_DEL         3       /* del configuration */

type

The object type. The object type is one of the following objects:

MTP_OBJ_TYPE_SL: Signalling link object.
MTP_OBJ_TYPE_LK: Link set object.
MTP_OBJ_TYPE_LS: Combined Link Set object.
MTP_OBJ_TYPE_RT: Route object.
MTP_OBJ_TYPE_RL: Route List object.
MTP_OBJ_TYPE_RS: Route Set object.
MTP_OBJ_TYPE_SP: Signalling Point object.
MTP_OBJ_TYPE_NA: Network Appearance object.
MTP_OBJ_TYPE_DF: Default object.

id

The object identifier.

cmd

The configuration command to execute. The command may be one of the following:

MTP_GET: Get the specified protocol object configuration including the configuration of as many direct descendants of the object as possible.
MTP_ADD: Add the specified protocol object.
MTP_CHA: Change the specified protocol object.
MTP_DEL: Delete the specified protocol object.

6.2.1 Get MTP Protocol Object Configuration

MTP_IOCGCONFIG

6.2.2 Set MTP Protocol Object Configuration

MTP_IOCSCONFIG

6.2.3 Test MTP Protocol Object Configuration

MTP_IOCTCONFIG

6.2.4 Commit MTP Protocol Object Configuration

MTP_IOCCCONFIG

6.2.5 Signalling Link Configuration

typedef struct mtp_conf_sl {
        ulong muxid;                            /* lower multiplexor id */
        ulong lkid;                             /* link set id */
        ulong slc;                              /* signalling link code in lk */
} mtp_conf_sl_t;

6.2.6 Link Set Configuration

typedef struct mtp_conf_lk {
        ulong lsid;                             /* combined link set id */
        ulong rsid;                             /* routeset of adjacent signalling point */
        ulong ni;                               /* network indicator for link set */
        ulong slot;                             /* slot of SLS for this link set */
} mtp_conf_lk_t;

6.2.7 Combined Link Set Configuration

typedef struct mtp_conf_ls {
        ulong spid;                             /* signalling point id */
        ulong sls_mask;                         /* mask of bits selecting link set */
} mtp_conf_ls_t;

6.2.8 Route Configuration

typedef struct mtp_conf_rt {
        ulong rlid;                             /* route list id */
        ulong lkid;                             /* link id */
        ulong slot;                             /* slot of SLS for this route */
} mtp_conf_rt_t;

6.2.9 Route List Configuration

typedef struct mtp_conf_rl {
        ulong rsid;                             /* route set id */
        ulong lsid;                             /* combined link set id */
        ulong cost;                             /* cost in routeset */
} mtp_conf_rl_t;

6.2.10 Route Set Configuration

typedef struct mtp_conf_rs {
        ulong spid;                             /* signalling point id */
        ulong dest;                             /* destination point code */
        ulong flags;                            /* options flags */
} mtp_conf_rs_t;

6.2.11 Signalling Point Configuration

typedef struct mtp_conf_sp {
        ulong naid;                             /* network appearance id */
        ulong pc;                               /* point code */
        ulong users;                            /* mask of equipped users */
        ulong flags;                            /* options flags */
} mtp_conf_sp_t;

6.2.12 Network Appearance Configuration

typedef struct mtp_conf_na {
        lmi_option_t options;                   /* protocol options */
        struct {
                ulong member;                   /* PC member mask */
                ulong cluster;                  /* PC cluster mask */
                ulong network;                  /* PC network mask */
        } mask;
        ulong sls_bits;                         /* bits in SLS */
} mtp_conf_na_t;

/* additional MTP protocol options */
#define SS7_POPT_TFR    0x00010000      /* old broadcast method - no responsive */
#define SS7_POPT_TFRB   0x00020000      /* new broadcast method - no regulation */
#define SS7_POPT_TFRR   0x00040000      /* new responsive method - regulated */
#define SS7_POPT_MCSTA  0x00080000      /* multiple congestion states */

6.2.13 Default Configuration

typedef struct mtp_conf_df {
} mtp_conf_df_t;

6.3 MTP Protocol Object State Machine

Argument Format

typedef struct mtp_statem {
        ulong type;                             /* object type */
        ulong id;                               /* object id */
        ulong flags;                            /* object flags */
        ulong state;                            /* object state */
        /* followed by object-specific state structure */
} mtp_statem_t;

6.3.1 Signalling Link State

typedef struct mtp_timers_sl {
        ulong t1;                               /* timer t1 */
        ulong t2;                               /* timer t2 */
        ulong t3;                               /* timer t3 */
        ulong t4;                               /* timer t4 */
        ulong t5;                               /* timer t5 */
        ulong t12;                              /* timer t12 */
        ulong t13;                              /* timer t13 */
        ulong t14;                              /* timer t14 */
        ulong t17;                              /* timer t17 */
        ulong t19a;                             /* timer t19a */
        ulong t20a;                             /* timer t20a */
        ulong t21a;                             /* timer t21a */
        ulong t22;                              /* timer t22 */
        ulong t23;                              /* timer t23 */
        ulong t24;                              /* timer t24 */
        ulong t31a;                             /* timer t31a */
        ulong t32a;                             /* timer t32a */
        ulong t33a;                             /* timer t33a */
        ulong t34a;                             /* timer t34a */
        ulong t1t;                              /* timer t1t */
        ulong t2t;                              /* timer t2t */
        ulong t1s;                              /* timer t1s */
} mtp_timers_sl_t;
typedef struct mtp_statem_sl {
        struct mtp_timers_sl timers;
} mtp_statem_sl_t;

#define SLS_OUT_OF_SERVICE      0       /* out of service */
#define SLS_PROC_OUTG           1       /* processor outage */
#define SLS_IN_SERVICE          2       /* in service */
#define SLS_WACK_COO            3       /* waiting COA/ECA in response to COO */
#define SLS_WACK_ECO            4       /* waiting COA/ECA in response to ECO */
#define SLS_WCON_RET            5       /* waiting for retrieval confrimation */
#define SLS_WIND_CLRB           6       /* waiting for clear buffers indication */
#define SLS_WIND_BSNT           7       /* waiting for BSNT indication */
#define SLS_WIND_INSI           8       /* waiting for in service indication */
#define SLS_WACK_SLTM           9       /* waiting SLTA in response to 1st SLTM */

#define SL_RESTORED         (MTP_ALLOWED)       /* Sig link Activated/Restored/Resumed */
#define SL_DANGER           (MTP_DANGER)        /* Sig link Danger of congestion (overloaded) */
#define SL_CONGESTED        (MTP_CONGESTED)     /* Sig link Congested (link congestion) */
#define SL_UNUSABLE         (MTP_RESTRICTED)    /* Sig link Unusable (Local Processor Outage) */
#define SL_RETRIEVAL        (MTP_RESTART)       /* Sig link Retrieving */
#define SL_FAILED           (MTP_PROHIBITED)    /* Sig link Failed */
#define SL_INHIBITED        (MTP_INHIBITED)     /* Sig link Inhibited (Management inhibited) */
#define SL_BLOCKED          (MTP_BLOCKED)       /* Sig link Blocked (Processor Outage) */
#define SL_INACTIVE         (MTP_INACTIVE)      /* Sig link Inactive (Out of Service) */
#define SL_NODANGER         (MTP_NODANGER)      /* Sig link Out of Danger (transient state) */
#define SL_UNCONGESTED      (MTP_UNCONGESTED)   /* Sig link Uncongested (transient state) */
#define SL_UPDATED          (MTP_RESTARTED)     /* Sig link Buffer Update Complete (transient state) */
#define SL_UNINHIBITED      (MTP_UNINHIBITED)   /* Sig link Uninhibited (transient state) */
#define SL_UNBLOCKED        (MTP_UNBLOCKED)     /* Sig link Unblocked (transient state) */
#define SL_ACTIVE           (MTP_ACTIVE)        /* Sig link Active (Link in service) */

#define SLF_TRAFFIC         (MTPF_TRAFFIC)      /* Sig link has sent traffic */
#define SLF_COO_RECV        (MTPF_COO_RECV)     /* Sig link has received a COO */
#define SLF_ECO_RECV        (MTPF_ECO_RECV)     /* Sig link has received a ECO */
#define SLF_WACK_SLTM       (MTPF_WACK_SLTM)    /* Sig link waiting for response to 1st SLTM */
#define SLF_WACK_SLTM2      (MTPF_WACK_SLTM2)   /* Sig link waiting for response to 2nd SLTM */
#define SLF_WACK_SSLTM      (MTPF_WACK_SSLTM)   /* Sig link waiting for response to 1st SSLTM */
#define SLF_WACK_SSLTM2     (MTPF_WACK_SSLTM2)  /* Sig link waiting for response to 2nd SSLTM */

#define SLF_RESTORED        (MTPF_ALLOWED)      /* Sig link Activated/Restored */
#define SLF_DANGER          (MTPF_DANGER)       /* Sig link Danger of congestion (overloaded) */
#define SLF_CONGESTED       (MTPF_CONGESTED)    /* Sig link Congested (link congestion) */
#define SLF_UNUSABLE        (MTPF_RESTRICTED)   /* Sig link Unusable (Local Processor Outage) */
#define SLF_RETRIEVAL       (MTPF_RESTART)      /* Sig link Retrieving */
#define SLF_FAILED          (MTPF_PROHIBITED)   /* Sig link Failed */
#define SLF_INHIBITED       (MTPF_INHIBITED)    /* Sig link Inhibited (Management inhibited) */
#define SLF_BLOCKED         (MTPF_BLOCKED)      /* Sig link Blocked (Processor Outage) */
#define SLF_INACTIVE        (MTPF_INACTIVE)     /* Sig link Inactive (Out of Service) */

#define SLF_LOSC_PROC_A     (MTPF_LOSC_PROC_A)  /* Sig link uses link oscillation procedure A */
#define SLF_LOSC_PROC_B     (MTPF_LOSC_PROC_B)  /* Sig link uses link oscillation procedure B */

6.3.2 Link Set State

typedef struct mtp_timers_lk {
        ulong t7;                               /* timer t7 */
} mtp_timers_lk_t;
typedef struct mtp_statem_lk {
        struct mtp_timers_lk timers;
} mtp_statem_lk_t;

#define LK_ALLOWED          (MTP_ALLOWED)       /* Link Allowed */
#define LK_DANGER           (MTP_DANGER)        /* Link Danger of congestion (primary or secondary) */
#define LK_CONGESTED        (MTP_CONGESTED)     /* Link Congested (Link Set congestion, primary or secondary ) */
#define LK_RESTRICTED       (MTP_RESTRICTED)    /* Link Restricted (Route Failure or received TFR) */
#define LK_RESTART          (MTP_RESTART)       /* Link Restarting */
#define LK_PROHIBITED       (MTP_PROHIBITED)    /* Link Prohibited (Received TFP) */
#define LK_INHIBITED        (MTP_INHIBITED)     /* Link Inhibited (Management inhibited) */
#define LK_BLOCKED          (MTP_BLOCKED)       /* Link Blocked (Local Link Set failure) */
#define LK_INACTIVE         (MTP_INACTIVE)      /* Link Inactive (Link out of service) */
#define LK_NODANGER         (MTP_NODANGER)      /* Link Out of Danger (transient state) */
#define LK_UNCONGESTED      (MTP_UNCONGESTED)   /* Link Uncongested (transient state) */
#define LK_RESTARTED        (MTP_RESTARTED)     /* Link Restarted */
#define LK_UNINHIBITED      (MTP_UNINHIBITED)   /* Link Uninhibited (transient state) */
#define LK_UNBLOCKED        (MTP_UNBLOCKED)     /* Link Unblocked (transient state) */
#define LK_ACTIVE           (MTP_ACTIVE)        /* Link Active (Link in service) */

6.3.3 Combined Link Set State

typedef struct mtp_timers_ls {
} mtp_timers_ls_t;
typedef struct mtp_statem_ls {
        struct mtp_timers_ls timers;
} mtp_statem_ls_t;

#define LS_ALLOWED          (MTP_ALLOWED)       /* Linkset Allowed */
#define LS_DANGER           (MTP_DANGER)        /* Linkset Danger of congestion (primary or secondary) */
#define LS_CONGESTED        (MTP_CONGESTED)     /* Linkset Congested (Link Set congestion, primary or secondary ) 
                                                 */
#define LS_RESTRICTED       (MTP_RESTRICTED)    /* Linkset Restricted (Route Failure or received TFR) */
#define LS_RESTART          (MTP_RESTART)       /* Linkset Restarting */
#define LS_PROHIBITED       (MTP_PROHIBITED)    /* Linkset Prohibited (Received TFP) */
#define LS_INHIBITED        (MTP_INHIBITED)     /* Linkset Inhibited (Management inhibited) */
#define LS_BLOCKED          (MTP_BLOCKED)       /* Linkset Blocked (Local Link Set failure) */
#define LS_INACTIVE         (MTP_INACTIVE)      /* Linkset Inactive (Link out of service) */
#define LS_NODANGER         (MTP_NODANGER)      /* Linkset Out of Danger (transient state) */
#define LS_UNCONGESTED      (MTP_UNCONGESTED)   /* Linkset Uncongested (transient state) */
#define LS_RESTARTED        (MTP_RESTARTED)     /* Linkset Restarted */
#define LS_UNINHIBITED      (MTP_UNINHIBITED)   /* Linkset Uninhibited (transient state) */
#define LS_UNBLOCKED        (MTP_UNBLOCKED)     /* Linkset Unblocked (transient state) */
#define LS_ACTIVE           (MTP_ACTIVE)        /* Linkset Active (Link in service) */

6.3.4 Route State

typedef struct mtp_timers_rt {
        ulong t6;                               /* timer t6 */
        ulong t10;                              /* timer t10 */
} mtp_timers_rt_t;
typedef struct mtp_statem_rt {
        struct mtp_timers_rt timers;
} mtp_statem_rt_t;

#define RT_ALLOWED          (MTP_ALLOWED)       /* Route Allowed */
#define RT_DANGER           (MTP_DANGER)        /* Route Danger of congestion (primary or secondary) */
#define RT_CONGESTED        (MTP_CONGESTED)     /* Route Congested (Link Set congestion, primary or secondary ) */
#define RT_RESTRICTED       (MTP_RESTRICTED)    /* Route Restricted (Route Failure or received TFR) */
#define RT_RESTART          (MTP_RESTART)       /* Route Restarting */
#define RT_PROHIBITED       (MTP_PROHIBITED)    /* Route Prohibited (Received TFP) */
#define RT_INHIBITED        (MTP_INHIBITED)     /* Route Inhibited (Management inhibited) */
#define RT_BLOCKED          (MTP_BLOCKED)       /* Route Blocked (Local Link Set failure) */
#define RT_INACTIVE         (MTP_INACTIVE)      /* Route Inactive (Link out of service) */
#define RT_NODANGER         (MTP_NODANGER)      /* Route Out of Danger (transient state) */
#define RT_UNCONGESTED      (MTP_UNCONGESTED)   /* Route Uncongested (transient state) */
#define RT_RESTARTED        (MTP_RESTARTED)     /* Route Restarted */
#define RT_UNINHIBITED      (MTP_UNINHIBITED)   /* Route Uninhibited (transient state) */
#define RT_UNBLOCKED        (MTP_UNBLOCKED)     /* Route Unblocked (transient state) */
#define RT_ACTIVE           (MTP_ACTIVE)        /* Route Active (Link in service) */
//#define RT_RESTART_PHASE_1  (MTP_RESTART_PHASE_1)     /* Route Restarting Phase 1 */
//#define RT_RESTART_PHASE_2  (MTP_RESTART_PHASE_2)     /* Route Restarting Phase 2 */

#define RTF_ALLOWED         (MTPF_ALLOWED)      /* Route is allowed */
#define RTF_DANGER          (MTPF_DANGER)       /* Route is in danger of congestion */
#define RTF_CONGESTED       (MTPF_CONGESTED)    /* Route is congested */
#define RTF_RESTRICTED      (MTPF_RESTRICTED)   /* Route is restricted */
#define RTF_RESTART         (MTPF_RESTART)      /* Route is restarting */
#define RTF_PROHIBITED      (MTPF_PROHIBITED)   /* Route is prohibited */
#define RTF_INHIBITED       (MTPF_INHIBITED)    /* Route is inhibited */
#define RTF_BLOCKED         (MTPF_BLOCKED)      /* Route is blocked */
#define RTF_INACTIVE        (MTPF_INACTIVE)     /* Route is inactive */

6.3.5 Route List State

typedef struct mtp_timers_rl {
} mtp_timers_rl_t;
typedef struct mtp_statem_rl {
        struct mtp_timers_rl timers;
} mtp_statem_rl_t;

//#define RL_ALLOWED        (MTP_ALLOWED)       /* Routelist Allowed */
//#define RL_DANGER         (MTP_DANGER)        /* Routelist Danger of congestion (primary or secondary) */
//#define RL_CONGESTED      (MTP_CONGESTED)     /* Routelist Congested (Link Set cong, primary or secondary) */
#define RL_RESTRICTED       (MTP_RESTRICTED)    /* Routelist Restricted (Route Failure or received TFR) */
#define RL_RESTART          (MTP_RESTART)       /* Routelist Restarting */
//#define RL_PROHIBITED     (MTP_PROHIBITED)    /* Routelist Prohibited (Received TFP) */
//#define RL_INHIBITED      (MTP_INHIBITED)     /* Routelist Inhibited (Management inhibited) */
//#define RL_BLOCKED        (MTP_BLOCKED)       /* Routelist Blocked (Local Link Set failure) */
//#define RL_INACTIVE       (MTP_INACTIVE)      /* Routelist Inactive (Link out of service) */
//#define RL_NODANGER       (MTP_NODANGER)      /* Routelist Out of Danger (transient state) */
//#define RL_UNCONGESTED            (MTP_UNCONGESTED)   /* Routelist Uncongested (transient state) */
//#define RL_RESTARTED      (MTP_RESTARTED)     /* Routelist Restarted */
//#define RL_UNINHIBITED            (MTP_UNINHIBITED)   /* Routelist Uninhibited (transient state) */
//#define RL_UNBLOCKED      (MTP_UNBLOCKED)     /* Routelist Unblocked (transient state) */
//#define RL_ACTIVE         (MTP_ACTIVE)        /* Routelist Active (Link in service) */
//#define RL_RESTART_PHASE_1  (MTP_RESTART_PHASE_1)     /* Routelist Restarting Phase 1 */
//#define RL_RESTART_PHASE_2  (MTP_RESTART_PHASE_2)     /* Routelist Restarting Phase 2 */

6.3.6 Route Set State

typedef struct mtp_timers_rs {
        ulong t8;                               /* timer t8 */
        ulong t11;                              /* timer t11 */
        ulong t15;                              /* timer t15 */
        ulong t16;                              /* timer t16 */
        ulong t18a;                             /* timer t18a */
} mtp_timers_rs_t;
typedef struct mtp_statem_rs {
        struct mtp_timers_rs timers;
} mtp_statem_rs_t;

#define RS_ALLOWED          (MTP_ALLOWED)       /* Routeset Allowed */
#define RS_DANGER           (MTP_DANGER)        /* Routeset Danger of congestion (primary or secondary) */
#define RS_CONGESTED        (MTP_CONGESTED)     /* Routeset Congested (Link Set cong, primary or secondary) */
#define RS_RESTRICTED       (MTP_RESTRICTED)    /* Routeset Restricted (Route Failure or received TFR) */
#define RS_RESTART          (MTP_RESTART)       /* Routeset Restarting */
#define RS_PROHIBITED       (MTP_PROHIBITED)    /* Routeset Prohibited (Received TFP) */
#define RS_INHIBITED        (MTP_INHIBITED)     /* Routeset Inhibited (Management inhibited) */
#define RS_BLOCKED          (MTP_BLOCKED)       /* Routeset Blocked (Local Link Set failure) */
#define RS_INACTIVE         (MTP_INACTIVE)      /* Routeset Inactive (Link out of service) */
#define RS_NODANGER         (MTP_NODANGER)      /* Routeset Out of Danger (transient state) */
#define RS_UNCONGESTED      (MTP_UNCONGESTED)   /* Routeset Uncongested (transient state) */
#define RS_RESTARTED        (MTP_RESTARTED)     /* Routeset Restarted */
#define RS_UNINHIBITED      (MTP_UNINHIBITED)   /* Routeset Uninhibited (transient state) */
#define RS_UNBLOCKED        (MTP_UNBLOCKED)     /* Routeset Unblocked (transient state) */
#define RS_ACTIVE           (MTP_ACTIVE)        /* Routeset Active (Link in service) */
#define RS_RESTART_PHASE_1  (MTP_RESTART_PHASE_1)       /* Routeset Restarting Phase 1 */
#define RS_RESTART_PHASE_2  (MTP_RESTART_PHASE_2)       /* Routeset Restarting Phase 2 */

#define RSF_ALLOWED         (MTPF_ALLOWED)      /* Routeset is allowed */
#define RSF_DANGER          (MTPF_DANGER)       /* Routeset is in danger of congestion */
#define RSF_CONGESTED       (MTPF_CONGESTED)    /* Routeset is congested */
#define RSF_RESTRICTED      (MTPF_RESTRICTED)   /* Routeset is restricted */
#define RSF_RESTART         (MTPF_RESTART)      /* Routeset is restarting */
#define RSF_PROHIBITED      (MTPF_PROHIBITED)   /* Routeset is prohibited */
#define RSF_INHIBITED       (MTPF_INHIBITED)    /* Routeset is inhibited */
#define RSF_BLOCKED         (MTPF_BLOCKED)      /* Routeset is blocked */
#define RSF_INACTIVE        (MTPF_INACTIVE)     /* Routeset is inactive */

#define RSF_TFR_PENDING     (MTPF_TFR_PENDING)  /* Routeset has TFR pending */
#define RSF_CLUSTER         (MTPF_CLUSTER)      /* Routeset is cluster route */
#define RSF_XFER_FUNC       (MTPF_XFER_FUNC)    /* Routeset has transfer function */
#define RSF_ADJACENT        (MTPF_ADJACENT)     /* Routeset is adjacent */

6.3.7 Signalling Point State

typedef struct mtp_timers_sp {
        ulong t1r;                              /* timer t1r */
        ulong t18;                              /* timer t18 */
        ulong t19;                              /* timer t19 */
        ulong t20;                              /* timer t20 */
        ulong t21;                              /* timer t21 */
        ulong t22a;                             /* timer t22a */
        ulong t23a;                             /* timer t23a */
        ulong t24a;                             /* timer t24a */
        ulong t25a;                             /* timer t25a */
        ulong t26a;                             /* timer t26a */
        ulong t27a;                             /* timer t27a */
        ulong t28a;                             /* timer t28a */
        ulong t29a;                             /* timer t29a */
        ulong t30a;                             /* timer t30a */
} mtp_timers_sp_t;
typedef struct mtp_statem_sp {
        struct mtp_timers_sp timers;
} mtp_statem_sp_t;

#define SP_ALLOWED          (MTP_ALLOWED)       /* Sig Point Allowed */
#define SP_DANGER           (MTP_DANGER)        /* Sig Point Danger of congestion (primary or secondary) */
#define SP_CONGESTED        (MTP_CONGESTED)     /* Sig Point Congested (Link Set cong, primary or secondary ) */
#define SP_RESTRICTED       (MTP_RESTRICTED)    /* Sig Point Restricted (Route Failure or received TFR) */
#define SP_RESTART          (MTP_RESTART)       /* Sig Point Restarting */
#define SP_PROHIBITED       (MTP_PROHIBITED)    /* Sig Point Prohibited (Received TFP) */
#define SP_INHIBITED        (MTP_INHIBITED)     /* Sig Point Inhibited (Management inhibited) */
#define SP_BLOCKED          (MTP_BLOCKED)       /* Sig Point Blocked (Local Link Set failure) */
#define SP_INACTIVE         (MTP_INACTIVE)      /* Sig Point Inactive (Link out of service) */
#define SP_NODANGER         (MTP_NODANGER)      /* Sig Point Out of Danger (transient state) */
#define SP_UNCONGESTED      (MTP_UNCONGESTED)   /* Sig Point Uncongested (transient state) */
#define SP_RESTARTED        (MTP_RESTARTED)     /* Sig Point Restarted */
#define SP_UNINHIBITED      (MTP_UNINHIBITED)   /* Sig Point Uninhibited (transient state) */
#define SP_UNBLOCKED        (MTP_UNBLOCKED)     /* Sig Point Unblocked (transient state) */
#define SP_ACTIVE           (MTP_ACTIVE)        /* Sig Point Active (Link in service) */
#define SP_RESTART_PHASE_1  (MTP_RESTART_PHASE_1)       /* Sig Point Restarting Phase 1 */
#define SP_RESTART_PHASE_2  (MTP_RESTART_PHASE_2)       /* Sig Point Restarting Phase 2 */

#define SPF_RESTART         (MTPF_RESTART)      /* Sig Point restarting */
#define SPF_CLUSTER         (MTPF_CLUSTER)      /* Sig Point is cluster route */
#define SPF_XFER_FUNC       (MTPF_XFER_FUNC)    /* Sig Point has transfer function */
#define SPF_SECURITY        (MTPF_SECURITY)     /* Sig Point has additional security procedures */
#define SPF_LOSC_PROC_A     (MTPF_LOSC_PROC_A)  /* Sig Point uses link oscillation procedure A */
#define SPF_LOSC_PROC_B     (MTPF_LOSC_PROC_B)  /* Sig Point uses link oscillation procedure B */
#define SPF_RESTART_PHASE_1 (MTPF_RESTART_PHASE_1)      /* Sig Point restarting */
#define SPF_RESTART_PHASE_2 (MTPF_RESTART_PHASE_2)      /* Sig Point restarting */

6.3.8 Network Appearance State

typedef struct mtp_timers_na {
} mtp_timers_na_t;
typedef struct mtp_statem_na {
        struct mtp_timers_na timers;
} mtp_statem_na_t;

6.3.9 Default State

typedef struct mtp_timers_df {
} mtp_timers_df_t;
typedef struct mtp_statem_df {
        struct mtp_timers_df timers;
} mtp_statem_df_t;

6.3.10 Get MTP Protocol Object State Machine

MTP_IOCGSTATEM

6.3.11 Reset MTP Protocol Object State Machine

MTP_IOCCMRESET

6.4 MTP Protocol Object Statistics

Argument Format

typedef struct mtp_stats {
        ulong type;                             /* object type */
        ulong id;                               /* object id */
        ulong header;                           /* object stats header */
        /* followed by object-specific statistics structure */
} mtp_stats_t;

6.4.1 Get MTP Protocol Object Statistics Periods

MTP_IOCGSTATSP

6.4.2 Set MTP Protocol Object Statistics Periods

MTP_IOCSSTATSP

6.4.3 Get MTP Protocol Object Statistics

MTP_IOCGSTATS

6.4.4 Set MTP Protocol Object Statistics

MTP_IOCSSTATS

6.5 MTP Protoocl Object Notifications

Argument Format

typedef struct mtp_notify {
        ulong type;                             /* object type */
        ulong id;                               /* object id */
        /* followed by object-specific notification structure */
} mtp_notify_t;

6.5.1 Get MTP Protocol Object Notifications

MTP_IOCGNOTIFY

6.5.2 Set MTP Protocol Object Notifications

MTP_IOCSNOTIFY

6.5.3 Clear MTP Protocol Object Notifications

MTP_IOCCNOTIFY

6.6 MTP Protocol Object Management

Argument Format

typedef struct mtp_mgmt {
        ulong type;                             /* object type */
        ulong id;                               /* object id */
        ulong cmd;                              /* mgmt command */
} mtp_mgmt_t;

#define MTP_MGMT_ALLOW                   0
#define MTP_MGMT_RESTRICT                1
#define MTP_MGMT_PROHIBIT                2
#define MTP_MGMT_ACTIVATE                3
#define MTP_MGMT_DEACTIVATE              4
#define MTP_MGMT_BLOCK                   5
#define MTP_MGMT_UNBLOCK                 6
#define MTP_MGMT_INHIBIT                 7
#define MTP_MGMT_UNINHIBIT               8
#define MTP_MGMT_CONGEST                 9
#define MTP_MGMT_UNCONGEST              10
#define MTP_MGMT_DANGER                 11
#define MTP_MGMT_NODANGER               12
#define MTP_MGMT_RESTART                13
#define MTP_MGMT_RESTARTED              14

6.6.1 Manage MTP Protocol Object

MTP_IOCCMGMT

6.7 MTP Provider Pass-Along Control

Argument Format

typedef struct mtp_pass {
        ulong muxid;                            /* mux index of lower SL structure to pass message to */
        ulong type;                             /* type of message block */
        ulong band;                             /* band of mesage block */
        ulong ctl_length;                       /* length of cntl part */
        ulong dat_length;                       /* length of data part */
        /* followed by cntl and data part of message to pass to signalling link */
} mtp_pass_t;

MTP_IOCCPASS

7 MTPI Management Information Base

Addendum for MTP Conformance

Addendum for ITU-T Q.704 Conformance

This addendum describes the formats and rules that are specific to ETSI EN 300 008-1 V3.2.2. The addendum must be used along with the generic MTPI as defined in the main document, and the EN 300 008-1 conformance defined in Addendum 2, when implementing an MTP that will be configured with the EN 300 008-1 Message Transfer Part.

Primitives and Rules for ETSI EN 300 008-1 V3.2.2 Conformance

The following are the additional rules that apply to the MTPI primitives for ETSI EN 300 008-1 V3.2.2 compatibility.

Local Management Primitives

Parameters

Flags

Rules

Connection Mode Primitives

Parameters

Flags

Rules

Connectionless Primitives

Parameters

Flags

Rules

Addendum for ANSI T1.111.4 Conformance

Addendum for ETSI ETS 300 008-1 Conformance

Addendum for ITU-T Q.2210 Conformance

Appendix A Mapping MTPI Primitives

A.1 Mapping MTPI Primitives to Q.701

Table A-1 shows the mapping of the MTPI primitives to the MTP definition primitives listed in ITU-T Recommendation Q.704.

The mapping of MTPI primitives to Q.701 primitives is shown in Table 6. For the most part, this mapping is a one to one mapping of service primitives, with the exception of Connect Request and Disconnect Request.

In Q.701 there is no concept of an association between MTP-entities. In OpenSS7 MTPI, the MTP_CONN_REQ and MTP_DISCON_REQ primitives are used to establish and release an association between MTP-entities.

Table 6. Mapping of MTPI primitives to Q.701 Primitives

A.2 Mapping MTPI Primitives to ANSI T1.111.1

The mapping of MTPI primitives to T1.111.1 primitives is shown in Table 7. For the most part, this mapping is a one to one mapping of service primitives, with the exception of Connect Request and Disconnect Request.

In T1.111.1 there is no concept of an association between MTP-entities. In OpenSS7 MTPI, the MTP_CONN_REQ and MTP_DISCON_REQ primitives are used to establish and release an association between MTP-entities.

Table 7. Mapping of MTPI primitives to T1.111.1 Primitives

A.3 Mapping MTPI Primitives to ETSI ETS 300 008-2

The mapping of MTPI primitives to ETS 300 008-2 primitives is shown in ‘Table 8’. For the most part, this mapping is a one to one mapping of service primitives, with the exception of Connect Request and Disconnect Request.

In ETS 300 008-2 there is no concept of an association between MTP-entities. In OpenSS7 MTPI, the MTP_CONN_REQ and MTP_DISCON_REQ primitives are used to establish and release an association between MTP-entities.

Appendix B State/Event Tables

Appendix C Precedence Tables

Appendix D MTPI Header Files

#ifndef __SS7_MTPI_H__
#define __SS7_MTPI_H__

#define MTP_VERSION_1       0x10
#define MTP_CURRENT_VERSION MTP_VERSION_1

typedef int32_t mtp_long;
typedef u_int32_t mtp_ulong;
typedef u_int16_t mtp_ushort;
typedef u_int8_t mtp_uchar;

#define MTP_BIND_REQ                     1+120  /* Bind to an MTP-SAP */
#define MTP_UNBIND_REQ                   2+120  /* Unbind from an MTP-SAP */
#define MTP_CONN_REQ                     3+120  /* Connect to a remote MTP-SAP */
#define MTP_DISCON_REQ                   4+120  /* Disconnect from a remote MTP-SAP */
#define MTP_ADDR_REQ                     5+120  /* Address service */
#define MTP_INFO_REQ                     6+120  /* Information service */
#define MTP_OPTMGMT_REQ                  7+120  /* Options management service */
#define MTP_STATUS_REQ                   8+120  /* MTP status request */
#define MTP_TRANSFER_REQ                 9+120  /* MTP data transfer request */

#define MTP_OK_ACK                      10+120  /* Positive acknowledgement */
#define MTP_ERROR_ACK                   11+120  /* Negative acknowledgement */
#define MTP_BIND_ACK                    12+120  /* Bind acknowledgement */
#define MTP_ADDR_ACK                    13+120  /* Address acknowledgement */
#define MTP_INFO_ACK                    14+120  /* Information acknowledgement */
#define MTP_OPTMGMT_ACK                 15+120  /* Options management acknowledgement */
#define MTP_TRANSFER_IND                16+120  /* MTP data transfer indication */
#define MTP_PAUSE_IND                   17+120  /* MTP pause (stop) indication */
#define MTP_RESUME_IND                  18+120  /* MTP resume (start) indication */
#define MTP_STATUS_IND                  19+120  /* MTP status indication */
#define MTP_RESTART_BEGINS_IND          20+120  /* MTP restart begins (impl. dep.) */
#define MTP_RESTART_COMPLETE_IND        21+120  /* MTP restart complete (impl. dep.) */

/*
 *  Interface States
 */
#define MTPS_UNBND                       0UL
#define MTPS_WACK_BREQ                   1UL
#define MTPS_IDLE                        2UL
#define MTPS_WACK_CREQ                   3UL
#define MTPS_WCON_CREQ                   4UL
#define MTPS_CONNECTED                   5UL
#define MTPS_WACK_UREQ                   6UL
#define MTPS_WACK_DREQ6                  7UL
#define MTPS_WACK_DREQ9                  8UL
#define MTPS_WACK_OPTREQ                 9UL
#define MTPS_WREQ_ORDREL                10UL
#define MTPS_WIND_ORDREL                11UL
#define MTPS_WRES_CIND                  12UL
#define MTPS_UNUSABLE                   0xffffffffUL

#ifndef __HAVE_MTP_ADDR
#ifndef AF_MTP
#define AF_MTP 0
#endif
typedef struct mtp_addr {
        unsigned int family __attribute__ ((packed));
        unsigned short int ni __attribute__ ((packed)); /* network identifier */
        unsigned short int si __attribute__ ((packed)); /* service indicator */
        unsigned int pc __attribute__ ((packed));       /* point code */
} mtp_addr_t;

#define __HAVE_MTP_ADDR
#endif

/*
 *  MTP_INFO_REQ, M_PROTO
 */
typedef struct MTP_info_req {
        mtp_ulong mtp_primitive;        /* always MTP_INFO_REQ */
} MTP_info_req_t;

/*
 *  MTP_INFO_ACK, M_PCPROTO
 */
typedef struct MTP_info_ack {
        mtp_ulong mtp_primitive;        /* always MTP_INFO_ACK */
        mtp_ulong mtp_msu_size;         /* maximum MSU size for guaranteed delivery */
        mtp_ulong mtp_addr_size;        /* maximum address size */
        mtp_ulong mtp_addr_length;      /* address length */
        mtp_ulong mtp_addr_offset;      /* address offset */
        mtp_ulong mtp_current_state;    /* current interface state */
        mtp_ulong mtp_serv_type;        /* service type */
        mtp_ulong mtp_version;          /* version of interface */
} MTP_info_ack_t;

#define M_COMS  1               /* Connection-mode MTP service supported */
#define M_CLMS  2               /* Connection-less MTP service supported */

/*
 *  MTP_ADDR_REQ, M_PCPROTO
 */
typedef struct MTP_addr_req {
        mtp_ulong mtp_primitive;        /* always MTP_ADDR_REQ */
} MTP_addr_req_t;

/*
 *  MTP_ADDR_ACK, M_PCPROTO
 */
typedef struct MTP_addr_ack {
        mtp_ulong mtp_primitive;        /* always MTP_ADDR_ACK */
        mtp_ulong mtp_loc_length;       /* length of local MTP address */
        mtp_ulong mtp_loc_offset;       /* offset of local MTP address */
        mtp_ulong mtp_rem_length;       /* length of remote MTP address */
        mtp_ulong mtp_rem_offset;       /* offset of remote MTP address */
} MTP_addr_ack_t;

/*
 *  MTP_BIND_REQ, M_PROTO
 */
typedef struct MTP_bind_req {
        mtp_ulong mtp_primitive;        /* always MTP_BIND_REQ */
        mtp_ulong mtp_addr_length;      /* length of MTP address */
        mtp_ulong mtp_addr_offset;      /* offset of MTP address */
        mtp_ulong mtp_bind_flags;       /* bind flags */
} MTP_bind_req_t;

/*
 *  MTP_BIND_ACK, M_PCPROTO
 */
typedef struct MTP_bind_ack {
        mtp_ulong mtp_primitive;        /* always MTP_BIND_ACK */
        mtp_ulong mtp_addr_length;      /* length of bound MTP address */
        mtp_ulong mtp_addr_offset;      /* offset of bound MTP address */
} MTP_bind_ack_t;

/*
 *  MTP_UNBIND_REQ, M_PROTO
 */
typedef struct MTP_unbind_req {
        mtp_ulong mtp_primitive;        /* always MTP_UNBIND_REQ */
} MTP_unbind_req_t;

/*
 *  MTP_CONN_REQ, M_PROTO
 */
typedef struct MTP_conn_req {
        mtp_ulong mtp_primitive;        /* always MTP_CONN_REQ */
        mtp_ulong mtp_addr_length;      /* length of MTP address to connect */
        mtp_ulong mtp_addr_offset;      /* offset of MTP address to connect */
        mtp_ulong mtp_conn_flags;       /* connect flags */
} MTP_conn_req_t;

/*
 *  MTP_DISCON_REQ, M_PROTO, M_PCPROTO
 */
typedef struct MTP_discon_req {
        mtp_ulong mtp_primitive;        /* always MTP_DISCON_REQ */
} MTP_discon_req_t;

/*
 *  MTP_OPTMGMT_REQ, M_PROTO or M_PCPROTO
 */
typedef struct MTP_optmgmt_req {
        mtp_ulong mtp_primitive;        /* always MTP_OPTMGMT_REQ */
        mtp_ulong mtp_opt_length;       /* length of options */
        mtp_ulong mtp_opt_offset;       /* offset of options */
        mtp_ulong mtp_mgmt_flags;       /* management flags */
} MTP_optmgmt_req_t;

#define MTP_DEFAULT     0UL
#define MTP_CHECK       1UL
#define MTP_NEGOTIATE   2UL
#define MTP_CURRENT     3UL

/*
 *  MTP_OPTMGMT_ACK, M_PCPROTO
 */
typedef struct MTP_optmgmt_ack {
        mtp_ulong mtp_primitive;        /* always MTP_OPTMGMT_ACK */
        mtp_ulong mtp_opt_length;       /* length of options */
        mtp_ulong mtp_opt_offset;       /* offset of options */
        mtp_ulong mtp_mgmt_flags;       /* management flags */
} MTP_optmgmt_ack_t;

/*
 *  MTP_OK, MTP_ERROR, M_PCPROTO
 */
typedef struct MTP_ok_ack {
        mtp_ulong mtp_primitive;        /* always MTP_OK_ACK */
        mtp_ulong mtp_correct_prim;     /* correct primitive */
} MTP_ok_ack_t;

typedef struct MTP_error_ack {
        mtp_ulong mtp_primitive;        /* always MTP_ERROR_ACK */
        mtp_ulong mtp_error_primitive;  /* primitive in error */
        mtp_ulong mtp_mtpi_error;       /* MTP interface error */
        mtp_ulong mtp_unix_error;       /* UNIX error */
} MTP_error_ack_t;

#define MSYSERR         0UL
#define MACCESS         1UL
#define MBADADDR        2UL
#define MNOADDR         3UL
#define MBADPRIM        4UL
#define MOUTSTATE       5UL
#define MNOTSUPP        6UL
#define MBADFLAG        7UL
#define MBADOPT         8UL

/*
 *  MTP_TRANSFER_REQ, M_PROTO
 */
typedef struct MTP_transfer_req {
        mtp_ulong mtp_primitive;        /* always MTP_TRANSFER_REQ */
        mtp_ulong mtp_dest_length;      /* length of destination address */
        mtp_ulong mtp_dest_offset;      /* offset of destination address */
        mtp_ulong mtp_mp;               /* message priority */
        mtp_ulong mtp_sls;              /* signalling link selection */
} MTP_transfer_req_t;

/*
 *  MTP_TRANSFER_IND, M_PROTO (band 0)
 */
typedef struct MTP_transfer_ind {
        mtp_ulong mtp_primitive;        /* always MTP_TRANSFER_IND */
        mtp_ulong mtp_srce_length;      /* length of source address */
        mtp_ulong mtp_srce_offset;      /* offset of source address */
        mtp_ulong mtp_mp;               /* message priority */
        mtp_ulong mtp_sls;              /* signalling link selection */
} MTP_transfer_ind_t;

/*
 *  MTP_PAUSE_IND, M_PROTO (band 1)
 */
typedef struct MTP_pause_ind {
        mtp_ulong mtp_primitive;        /* always MTP_PAUSE_IND */
        mtp_ulong mtp_addr_length;      /* length of affected MTP address */
        mtp_ulong mtp_addr_offset;      /* offset of affected MTP address */
} MTP_pause_ind_t;

/*
 *  MTP_RESUME_IND, M_PROTO (band 1)
 */
typedef struct MTP_resume_ind {
        mtp_ulong mtp_primitive;        /* always MTP_RESUME_IND */
        mtp_ulong mtp_addr_length;      /* length of affected MTP address */
        mtp_ulong mtp_addr_offset;      /* offset of affected MTP address */
} MTP_resume_ind_t;

/*
 * MTP_STATUS_REQ, M_PROTO or M_PCPROTO
 */
typedef struct MTP_status_req {
        mtp_ulong mtp_primitive;        /* always MTP_STATUS_REQ */
        mtp_ulong mtp_addr_length;      /* length of affected MTP address */
        mtp_ulong mtp_addr_offset;      /* offset of affected MTP address */
        mtp_ulong mtp_type;             /* type */
        mtp_ulong mtp_status;           /* status */
} MTP_status_req_t;

/*
 *  MTP_STATUS_IND, M_PROTO (band 1)
 */
typedef struct MTP_status_ind {
        mtp_ulong mtp_primitive;        /* always MTP_STATUS_IND */
        mtp_ulong mtp_addr_length;      /* length of affected MTP address */
        mtp_ulong mtp_addr_offset;      /* offset of affected MTP address */
        mtp_ulong mtp_type;             /* type */
        mtp_ulong mtp_status;           /* status */
} MTP_status_ind_t;

/*
   Type for MTP_STATUS_IND 
 */
#define MTP_STATUS_TYPE_CONG            0x00    /* MTP-STATUS refers to congestion */
#define MTP_STATUS_TYPE_UPU             0x01    /* MTP-STATUS refers to user part
                                                   unavailability */
#define MTP_STATUS_TYPE_RSTR            0x02    /* MTP-STATUS refers to restriction */

/*
   Status for MTP_STATUS_IND, with MTP_STATUS_TYPE_UPU 
 */
#define MTP_STATUS_UPU_UNKNOWN          0x01    /* User part unavailable: unknown */
#define MTP_STATUS_UPU_UNEQUIPPED       0x02    /* User part unavailable: unequipped
                                                   remote user. */
#define MTP_STATUS_UPU_INACCESSIBLE     0x03    /* User part unavailable: inaccessible
                                                   remote user. */

/*
   Status for MTP_STATUS_IND, with MTP_STATUS_TYPE_CONG 
 */
#define MTP_STATUS_CONGESTION_LEVEL0    0x00    /* Signalling network congestion level 0 */
#define MTP_STATUS_CONGESTION_LEVEL1    0x01    /* Signalling network congestion level 1 */
#define MTP_STATUS_CONGESTION_LEVEL2    0x02    /* Signalling network congestion level 2 */
#define MTP_STATUS_CONGESTION_LEVEL3    0x03    /* Signalling network congestion level 3 */
#define MTP_STATUS_CONGESTION           0x04    /* Signalling network congestion */

/*
 *  MTP_RESTART_BEGINS_IND, M_PCPROTO
 */
typedef struct MTP_restart_begins_ind {
        mtp_ulong mtp_primitive;        /* always MTP_RESTART_BEGINS_IND */
} MTP_restart_begins_ind_t;

/*
 *  MTP_RESTART_COMPLETE_IND, M_PCPROTO
 */
typedef struct MTP_restart_complete_ind {
        mtp_ulong mtp_primitive;        /* always MTP_RESTART_COMPLETE_IND */
} MTP_restart_complete_ind_t;

union MTP_primitives {
        mtp_ulong mtp_primitive;
        MTP_info_req_t info_req;
        MTP_info_ack_t info_ack;
        MTP_addr_req_t addr_req;
        MTP_addr_ack_t addr_ack;
        MTP_bind_req_t bind_req;
        MTP_bind_ack_t bind_ack;
        MTP_unbind_req_t unbind_req;
        MTP_conn_req_t conn_req;
        MTP_discon_req_t discon_req;
        MTP_optmgmt_req_t optmgmt_req;
        MTP_optmgmt_ack_t optmgmt_ack;
        MTP_ok_ack_t ok_ack;
        MTP_error_ack_t error_ack;
        MTP_transfer_req_t transfer_req;
        MTP_transfer_ind_t transfer_ind;
        MTP_pause_ind_t pause_ind;
        MTP_resume_ind_t resume_ind;
        MTP_status_ind_t status_ind;
        MTP_restart_complete_ind_t restart_complete_ind;
        MTP_status_req_t status_req;
};

typedef struct {
        mtp_ulong mtp_affected_dpc;
} mtp_pause_ind_t;

typedef struct {
        mtp_ulong mtp_affected_dpc;
} mtp_resume_ind_t;

/*
 *  8.1 Transfer
 *
 *  The primitive "MTP-TRANSFER" is used between level 4 and level 3 (SMH) to
 *  provide the MTP message transfer service.
 */

/*
 *  8.2 Pause
 *
 *  The primitive "MTP-PAUSE" indicates to "Users" the total inability of
 *  providing the MTP service to the specified destination (see 7.2.6).
 *
 *  NOTE -  The signalling point is inacessible via the MTP.  The MTP will
 *  determine when the signalling point is again acessible and send MTP-RESUME
 *  indication.  The user should wait for such an indication and, meanwhile is
 *  not allowed to send messages on that signalling point.  If the remote peer
 *  user is thought to be unavailable, that condition may be maintained or
 *  cancelled at the local user's discretion.
 */

/*
 *  8.3 Resume
 *
 *  The primitive MTP-RESUME indications to the "User" the ability of
 *  providing the MTP service to the specified destination (See 7.2.6)
 *
 *  This primitive corresponds to the destination accessible state as defined
 *  in Recommendation Q.704.
 *
 *  NOTE -  When the MTP-RESUME indicaiton is given to each user, the MTP does
 *          not know whether the remote peer user is available.  This is the
 *          responsibility of each user.
 */

/*
 *  8.4 Status
 *
 *  The primitive "MTP-STATUS" indicates to the "Users" the partial inability
 *  of providing the MTP service to the specified destination.  The primitive
 *  is also used to indicate to a User that a remote corresponding User is
 *  unavailable and the cause for unavailability (see 11.2.7/Q.704).
 *
 *  In the case of national option with congestion priorities or multiple
 *  signalling link congestion states without prioritites as in Recommendation
 *  Q.704 are implemented, this "MTP-STATUS" primitive is also used to
 *  indicate a change of congestion level.
 *
 *  This primitive corresponds to the destination congested/User Part
 *  unavailable states as defined in Recommendation Q.704.
 *
 *  NOTE -  In the case of remote user unavailability, the user is responsible
 *          for determining the availability of this peer user.  The user is
 *          cautioned not to send normal traffic to the peer user because,
 *          while such peer is unavailable, no message will be delivered but
 *          each will result in a repeated "MTP-STATUS" indication.  The MTP
 *          will not send any further indications about the unavailability or
 *          availability of this peer user unless the local user continues to
 *          send messages to the peer user.
 */

/*
 *  8.5 Restart
 *
 *  When the MTP restart procedure is terminated, the MTP indicates the end of
 *  MTP restart to all local MTP Users showing each signalling point's
 *  accessibility or inaccessibility.  The means of doing this is
 *  implementation dependent (see 9/Q.704).
 */

/*
 *  MTP_STATUS_IND, M_PROTO or M_PCPROTO
 */
typedef struct {
        mtp_ulong mtp_affected_dpc;
        mtp_uchar mtp_cause;
        mtp_uchar mtp_level;
} mtp_status_ind_t;

typedef struct {
        mtp_ulong dpc;
        mtp_ulong opc;
        mtp_ulong sls;
} mtp_rl_t;

typedef struct {
        mtp_uchar si;
        mtp_uchar mp;
        mtp_uchar ni;
        mtp_rl_t rl;
} mtp_hdr_t;

typedef struct {
        mtp_uchar si;
        mtp_uchar mp;
        mtp_uchar ni;
        mtp_rl_t rl;
        mtp_uchar h0;
        mtp_uchar h1;
} mtp_msu_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_COO */
        mtp_msu_t mtp_msg;
        mtp_ulong mtp_slc;
        mtp_ulong mtp_fsnc;
} mtp_signal_coo_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_COA */
        mtp_msu_t mtp_msg;
} mtp_signal_coa_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_CBD */
        mtp_msu_t mtp_msg;
} mtp_signal_cbd_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_CBA */
        mtp_msu_t mtp_msg;
} mtp_signal_cba_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_ECO */
        mtp_msu_t mtp_msg;
} mtp_signal_eco_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_ECA */
        mtp_msu_t mtp_msg;
} mtp_signal_eca_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_RCT */
        mtp_msu_t mtp_msg;
} mtp_signal_rct_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_TFC */
        mtp_msu_t mtp_msg;
} mtp_signal_tfc_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_TFP */
        mtp_msu_t mtp_msg;
} mtp_signal_tfp_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_TFR */
        mtp_msu_t mtp_msg;
} mtp_signal_tfr_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_TFA */
        mtp_msu_t mtp_msg;
} mtp_signal_tfa_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_RSP */
        mtp_msu_t mtp_msg;
} mtp_signal_rsp_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_RSR */
        mtp_msu_t mtp_msg;
} mtp_signal_rsr_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_LIN */
        mtp_msu_t mtp_msg;
} mtp_signal_lin_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_LUN */
        mtp_msu_t mtp_msg;
} mtp_signal_lun_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_LIA */
        mtp_msu_t mtp_msg;
} mtp_signal_lia_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_LUA */
        mtp_msu_t mtp_msg;
} mtp_signal_lua_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_LID */
        mtp_msu_t mtp_msg;
} mtp_signal_lid_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_LFU */
        mtp_msu_t mtp_msg;
} mtp_signal_lfu_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_LLT */
        mtp_msu_t mtp_msg;
} mtp_signal_llt_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_LRT */
        mtp_msu_t mtp_msg;
} mtp_signal_lrt_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_TRA */
        mtp_msu_t mtp_msg;
} mtp_signal_tra_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_DLC */
        mtp_msu_t mtp_msg;
} mtp_signal_dlc_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_CSS */
        mtp_msu_t mtp_msg;
} mtp_signal_css_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_CNS */
        mtp_msu_t mtp_msg;
} mtp_signal_cns_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_CNP */
        mtp_msu_t mtp_msg;
} mtp_signal_cnp_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_UPU */
        mtp_msu_t mtp_msg;
} mtp_signal_upu_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_SLTM */
        mtp_msu_t mtp_msg;
} mtp_signal_sltm_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_SLTA */
        mtp_msu_t mtp_msg;
} mtp_signal_slta_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_SSLTM */
        mtp_msu_t mtp_msg;
} mtp_signal_ssltm_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_SSLTA */
        mtp_msu_t mtp_msg;
} mtp_signal_sslta_t;

typedef struct {
        mtp_long mtp_primitive;         /* MTP_MSU_REQ, MTP_MSU_IND */
        mtp_ulong mtp_signal;           /* MTP_SIGNAL_USER */
        mtp_hdr_t mtp_msg;
} mtp_signal_user_t;

typedef union {
        mtp_long mtp_primitive;
        mtp_signal_user_t msg;
        mtp_signal_coo_t coo;
        mtp_signal_coa_t coa;
        mtp_signal_cbd_t cbd;
        mtp_signal_cba_t cba;
        mtp_signal_eco_t eco;
        mtp_signal_eca_t eca;
        mtp_signal_rct_t rct;
        mtp_signal_tfc_t tfc;
        mtp_signal_tfp_t tfp;
        mtp_signal_tfr_t tfr;
        mtp_signal_tfa_t tfa;
        mtp_signal_rsp_t rsp;
        mtp_signal_rsr_t rsr;
        mtp_signal_lin_t lin;
        mtp_signal_lun_t lun;
        mtp_signal_lia_t lia;
        mtp_signal_lua_t lua;
        mtp_signal_lid_t lid;
        mtp_signal_lfu_t lfu;
        mtp_signal_llt_t llt;
        mtp_signal_lrt_t lrt;
        mtp_signal_tra_t tra;
        mtp_signal_dlc_t dlc;
        mtp_signal_css_t css;
        mtp_signal_cns_t cns;
        mtp_signal_cnp_t cnp;
        mtp_signal_upu_t upu;
        mtp_signal_sltm_t sltm;
        mtp_signal_slta_t slta;
        mtp_signal_ssltm_t ssltm;
        mtp_signal_sslta_t sslta;
        mtp_signal_user_t user;
} MTP_signals;

/*
 *  MTP_MSU_REQ , M_PROTO or M_PCPROTO (M_DATA)
 */
typedef MTP_signals mtp_msu_req_t;

/*
 *  MTP_MSU_IND , M_PROTO or M_PCPROTO (M_DATA)
 */
typedef MTP_signals mtp_msu_ind_t;

#define MTP_SIGNAL_NONE          0
#define MTP_SIGNAL_COO           1      /* STM */
#define MTP_SIGNAL_COA           2      /* STM */
#define MTP_SIGNAL_CBD           3      /* STM */
#define MTP_SIGNAL_CBA           4      /* STM */
#define MTP_SIGNAL_ECO           5      /* STM */
#define MTP_SIGNAL_ECA           6      /* STM */
#define MTP_SIGNAL_LIN          14      /* STM */
#define MTP_SIGNAL_LUN          15      /* STM */
#define MTP_SIGNAL_LIA          16      /* STM */
#define MTP_SIGNAL_LUA          17      /* STM */
#define MTP_SIGNAL_LID          18      /* STM */
#define MTP_SIGNAL_LFU          19      /* STM */
#define MTP_SIGNAL_LLT          20      /* STM */
#define MTP_SIGNAL_LRT          21      /* STM */
#define MTP_SIGNAL_TRA          22      /* STM */

#define MTP_SIGNAL_RCT           7      /* SRM */
#define MTP_SIGNAL_TFC           8      /* SRM */
#define MTP_SIGNAL_TFP           9      /* SRM */
#define MTP_SIGNAL_TFR          10      /* SRM */
#define MTP_SIGNAL_TFA          11      /* SRM */
#define MTP_SIGNAL_RSP          12      /* SRM */
#define MTP_SIGNAL_RSR          13      /* SRM */
#define MTP_SIGNAL_UPU          27      /* SRM */

#define MTP_SIGNAL_DLC          23      /* SLM */
#define MTP_SIGNAL_CSS          24      /* SLM */
#define MTP_SIGNAL_CNS          25      /* SLM */
#define MTP_SIGNAL_CNP          26      /* SLM */

#define MTP_SIGNAL_SLTM         28      /* SLTC */
#define MTP_SIGNAL_SLTA         29      /* SLTC */
#define MTP_SIGNAL_SSLTM        30      /* SLTC */
#define MTP_SIGNAL_SSLTA        31      /* SLTC */

#define MTP_SIGNAL_USER         32      /* L4 */

#endif                          /* __SS7_MTPI_H__ */

Appendix E MTPI Library

Appendix F MTPI Drivers and Modules

Appendix G MTPI Utilities

Appendix H MTPI File Formats

Appendix I MTPI Compatibility and Porting

Glossary

Signalling Data Link Service Data Unit: A grouping of SDL user data whose boundaries are preserved from one end of the signalling data link connection to the other.
Data transfer: The phase in connection and connectionless modes that supports the transfer of data between to signalling data link users.
SDL provider: The signalling data link layer protocol that provides the services of the signalling data link interface.
SDL user: The user-level application or user-level or kernel-level protocol that accesses the services of the signalling data link layer.
Local management: The phase in connection and connectionless modes in which a SDL user initializes a stream and attaches a PPA address to the stream. Primitives in this phase generate local operations only.
PPA: The point at which a system attaches itself to a physical communications medium.
PPA identifier: An identifier of a particular physical medium over which communication transpires.

Acronyms

ANSI	American National Standards Institute
CCITT	The International Telegraph and Telephone Consutative Committee, old name for ITU-T
CONS	Connection-Oriented Network Service
CUD	Call User Data
DCE	Data Circuit-terminating Equipment
DDN	Defence Data Network
DLPI	Data Link Provider Interface
DLSAP	Destination Link Service Access Point
DNIC	Data Network Identification Code
DSAP	Destination Service Access Point
DTE	Data Terminal Equipment
ENSDU	Expedited Network Service Data Unit
ETSI	European Telecommunications Standards Institute
HDLC	High-Level Data Link Control
IEEE	Institute of Electrical and Electronics Engineers
IP	Internet Protocol
ISDNI	ISDN Interface
ISDN	Integrated Services Digital Network
ISO	International Organization for Standardization
ISUPI	ISUP Interface
ISUP	ISDN User Part
ITU	International Telecommunications Union
ITU-T	ITU Telecom Sector
LAN	Local Area Network
LAPB	Link Access Procedure (Balanced), ISO/IEC 7776
LAPD	Link Access Procedure D-Channel, Q.921
LAPF	Link Access Procedure Frame Mode, Q.922
LAP	Link Access Procedure
LCI	Logical Channel Identifier
LLC1	Logical Link Control Type 1
LLC2	Logical Link Control Type 2
LLC3	Logical Link Control Type 3
LLC	Logical Link Control
LLI	Logical Link Inteface
LSAP	Link Service Access Point
MAC	Media Access Control
MTPI	Message Transfer Part Interface
MTP	Message Transfer Part
NLI	Network Layer Interface
NPDU	Network Protocol Data Unit
NPI	Network Provider Interface
NPI	Numbering Plan Indicator
NSAP	Network Service Access Point
NSDU	Network Service Data Unit
NSP	Network Service Provider
NS	Network Service
NSU	Network Service User
NUI	Network User Information
PAD	Packet Assembler/Disassembler
PDN	Public Data Network
PDU	Protocol Data Unit
PLP	Packet Layer Protocol
PPA	Physical Point of Attachment
PSDN	Public Switched Data Network
PSTN	Public Switch Telephone Network
PVC	Permanent Virtual Circuit
QOS	Quality of Service
RPOA	Recognized Private Operating Agency
SAP	Service Access Point
SCCPI	Signalling Connection Control Part Interface
SCCP	Signalling Connection Control Part
SDLI	Signalling Data Link Interface
SDL	Signalling Data Link
SDTI	Signalling Data Terminal Interface
SDT	Signalling Data Terminal
SDU	Service Data Unit
SLI	Signalling Link Interface
SLSAP	Source Link Service Access Point
SL	Signalling Link
SNPA	Subnetwork Point of Attachment
SSAP	Source Service Access Point
SVC	Switched Virtual Circuit
TCAP	Transaction Capabilities Application Part
TCI	Transaction Component Interface
TC	Component Handling Sub-Layer
TLI	Transport Layer Interface
TOA/NPI	Type of Address/Numbering Plan Indicator
TOA	Type of Address
TPI	Transport Provider Interface
TRI	Transaction Interface
TR	Transaction Handling Sub-Layer
VC	Virtual Circuit
WAN	Wide Area Network
X.121	ITU-T Recommendation X.121
X.25	ITU-T Recommendation X.25
X.28	ITU-T Recommendation X.28
X.3	ITU-T Recommendation X.3
X.75	ITU-T Recommendation X.75
XX25	X.25 Programming Inteface using XTI
XXX	X.3, X.28, X.29

References

[1]	ITU-T Recommendation Q.700, Introduction to CCITT Signalling System No. 7, March 1993, (Geneva), ITU, ITU-T Telecommunication Standardization Sector of ITU, (Previously “CCITT Recommendation”).
[2]	ITU-T Recommendation Q.701, Functional Description of the Message Transfer Part (MTP) of Signalling System No. 7, March 1993, (Geneva), ITU, ITU-T Telecommunication Standardization Sector of ITU, (Previously “CCITT Recommendation”).
[3]	ITU-T Recommendation Q.702, Signalling System No. 7—Signalling Data Link, March 1993, (Geneva), ITU, ITU-T Telecommunication Standardization Sector of ITU, (Previously “CCITT Recommendation”).
[4]	ITU-T Recommendation Q.703, Signalling System No. 7—Signalling Link, March 1993, (Geneva), ITU, ITU-T Telecommunication Standardization Sector of ITU, (Previously “CCITT Recommendation”).
[5]	ITU-T Recommendation Q.704, Message Transfer Part—Signalling Network Functions and Messages, March 1993, (Geneva), ITU, ITU-T Telecommunication Standardization Sector of ITU, (Previously “CCITT Recommendation”).
[6]	Geoffrey Gerrietts; Dave Grothe, Mikel Matthews, Dave Healy, CDI—Application Program Interface Guide, March 1999, (Savoy, IL), GCOM, Inc.
[7]	ITU-T Recommendation Q.771, Signalling System No. 7—Functional Description of Transaction Capabilities, March 1993, (Geneva), ITU, ITU-T Telecommunication Standardization Sector of ITU, (Previously “CCITT Recommendation”).

Licenses

All code presented in this manual is licensed under the GNU Affero General Public License. The text of this manual is licensed under the GNU Free Documentation License, with no invariant sections, no front-cover texts and no back-cover texts. Please note, however, that it is just plain wrong to modify statements of, or attribute statements to, the Author or OpenSS7 Corporation.

GNU Affero General Public License

The GNU Affero General Public License.

Version 3, 19 November 2007

Copyright © 2007 Free Software Foundation, Inc. http://fsf.org/

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Preamble

The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.

The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program–to make sure it remains free software for all its users.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.

Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.

A secondary benefit of defending all users’ freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.

The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.

An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.

The precise terms and conditions for copying, distribution and modification follow.

TERMS AND CONDITIONS

Definitions.
“This License” refers to version 3 of the GNU Affero General Public License.

“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.

“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.

To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.

A “covered work” means either the unmodified Program or a work based on the Program.

To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.

To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
Source Code.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.

A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.

The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.

The Corresponding Source for a work in source code form is that same work.
Basic Permissions.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
Protecting Users’ Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.

When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.
Conveying Verbatim Copies.
You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
1. The work must carry prominent notices stating that you modified it, and giving a relevant date.
2. The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
3. You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
4. If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
1. Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
2. Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
3. Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
4. Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
5. Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.

A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.

“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.

If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).

The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.

Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
Additional Terms.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
1. Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
2. Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
3. Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
4. Limiting the use for publicity purposes of names of licensors or authors of the material; or
5. Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
6. Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.

Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
Termination.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.

An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
Patents.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.

A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.

In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.

If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.

A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
No Surrender of Others’ Freedom.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.

Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License.
Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation.

If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.

Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.

one line to give the program's name and a brief idea of what it does.
Copyright (C) year name of author

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see http://www.gnu.org/licenses/.

Also add information on how to contact you by electronic and paper mail.

If your software can interact with users remotely through a network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a “Source” link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.

You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see http://www.gnu.org/licenses/.

GNU Free Documentation License

GNU FREE DOCUMENTATION LICENSE

Version 1.3, 3 November 2008

Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
http://fsf.org/

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

PREAMBLE
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

The “publisher” means any person or entity that distributes copies of the Document to the public.

A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.
COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
4. Preserve all the copyright notices of the Document.
5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
8. Include an unaltered copy of this License.
9. Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled “History” in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
13. Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
14. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
15. Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
COMBINING DOCUMENTS
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
TRANSLATION
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
RELICENSING
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.

“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.

“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.

An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.

The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.

ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

  Copyright (C)  year  your name.
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.3
  or any later version published by the Free Software Foundation;
  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
  Texts.  A copy of the license is included in the section entitled ``GNU
  Free Documentation License''.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:

    with the Invariant Sections being list their titles, with
    the Front-Cover Texts being list, and with the Back-Cover Texts
    being list.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.

Index

Jump to:	C I L M S T

	Index Entry	Section

C
	`cmd`:	MTPI Input-Output Controls

I
	`id`:	MTPI Input-Output Controls
	`id`:	MTPI Input-Output Controls

L
	license, AGPL:	GNU Affero General Public License
	license, FDL:	GNU Free Documentation License
	license, GNU Affero General Public License:	GNU Affero General Public License
	license, GNU Free Documentation License:	GNU Free Documentation License

M
	`MACCESS`:	Bind Protocol Address Request
	`MACCESS`:	Message Transfer Part Options Management Request
	`MACCESS`:	Error Acknowledgement
	`MACCESS`:	Signalling Relation Establishment Phase
	`MADDRBUSY`:	Bind Protocol Address Request
	`MADDRBUSY`:	Error Acknowledgement
	`MADDRBUSY`:	Signalling Relation Establishment Phase
	`MBADADDR`:	Bind Protocol Address Request
	`MBADADDR`:	Error Acknowledgement
	`MBADADDR`:	Signalling Relation Establishment Phase
	`MBADFLAG`:	Message Transfer Part Options Management Request
	`MBADFLAG`:	Error Acknowledgement
	`MBADFLAG`:	Signalling Relation Establishment Phase
	`MBADOPT`:	Message Transfer Part Options Management Request
	`MBADOPT`:	Error Acknowledgement
	`MBADOPTTYPE`:	Message Transfer Part Options Management Request
	`MBADOPTTYPE`:	Error Acknowledgement
	`MBADPRIM`:	Bind Protocol Address Request
	`MBADPRIM`:	Message Transfer Part Options Management Request
	`MBADPRIM`:	Error Acknowledgement
	`MBADPRIM`:	Signalling Relation Establishment Phase
	`MBOUND`:	Bind Protocol Address Request
	`MNOADDR`:	Bind Protocol Address Request
	`MNOADDR`:	Error Acknowledgement
	`MNOADDR`:	Signalling Relation Establishment Phase
	`MNOTSUPPORT`:	Error Acknowledgement
	`MNOTSUPPORT`:	Signalling Relation Establishment Phase
	`MOUTSTATE`:	Bind Protocol Address Request
	`MOUTSTATE`:	Unbind Protocol Address Request
	`MOUTSTATE`:	Message Transfer Part Options Management Request
	`MOUTSTATE`:	Error Acknowledgement
	`MOUTSTATE`:	Signalling Relation Establishment Phase
	`MSYSERR`:	Protocol Address Request
	`MSYSERR`:	Bind Protocol Address Request
	`MSYSERR`:	Unbind Protocol Address Request
	`MSYSERR`:	Message Transfer Part Options Management Request
	`MSYSERR`:	Error Acknowledgement
	`MSYSERR`:	Signalling Relation Establishment Phase
	MTPI input-output controls:	MTPI Input-Output Controls
	MTPI management information base:	MTPI Management Information Base
	MTPI primitives:	MTPI Primitives
	MTPI Services Definition:	MTPI Services Definition
	`MTP_ADD`:	MTPI Input-Output Controls
	`MTP_ADDR_ACK`:	Local Management Services
	`MTP_ADDR_ACK`:	Protocol Address Acknowledgement
	`MTP_addr_ack_t`:	Protocol Address Acknowledgement
	`mtp_addr_length`:	Message Transfer Part Information Acknowledgement
	`mtp_addr_length`:	Bind Protocol Address Request
	`mtp_addr_length`:	Bind Protocol Address Acknowledgement
	`mtp_addr_length`:	Signalling Relation Establishment Phase
	`mtp_addr_length`:	Signalling Relation Data Transfer Phase
	`mtp_addr_length`:	Signalling Relation Data Transfer Phase
	`mtp_addr_length`:	Signalling Relation Data Transfer Phase
	`mtp_addr_offset`:	Message Transfer Part Information Acknowledgement
	`mtp_addr_offset`:	Bind Protocol Address Request
	`mtp_addr_offset`:	Bind Protocol Address Acknowledgement
	`mtp_addr_offset`:	Signalling Relation Establishment Phase
	`mtp_addr_offset`:	Signalling Relation Data Transfer Phase
	`mtp_addr_offset`:	Signalling Relation Data Transfer Phase
	`mtp_addr_offset`:	Signalling Relation Data Transfer Phase
	`MTP_ADDR_REQ`:	Local Management Services
	`MTP_ADDR_REQ`:	Protocol Address Request
	`MTP_addr_req_t`:	Protocol Address Request
	`mtp_addr_size`:	Message Transfer Part Information Acknowledgement
	`MTP_ALLOW_CON`:	MTP Provider Management Primitives
	`MTP_ALLOW_IND`:	MTP Provider Management Primitives
	`MTP_ALLOW_REQ`:	MTP Provider Management Primitives
	`MTP_BIND_ACK`:	Local Management Services
	`MTP_BIND_ACK`:	Bind Protocol Address Acknowledgement
	`MTP_bind_ack_t`:	Bind Protocol Address Acknowledgement
	`mtp_bind_flags`:	Bind Protocol Address Request
	`MTP_BIND_REQ`:	Local Management Services
	`MTP_BIND_REQ`:	Bind Protocol Address Request
	`MTP_bind_req_t`:	Bind Protocol Address Request
	`MTP_CHA`:	MTPI Input-Output Controls
	`MTP_CHECK`:	Message Transfer Part Options Management Request
	`MTP_CONNECTIONLESS`:	Bind Protocol Address Request
	`MTP_CONNECTION_ORIENTED`:	Bind Protocol Address Request
	`MTP_CONN_CON`:	Connection Oriented Services
	`mtp_conn_flags`:	Signalling Relation Establishment Phase
	`MTP_CONN_REQ`:	Connection Oriented Services
	`MTP_CONN_REQ`:	Signalling Relation Establishment Phase
	`MTP_conn_req_t`:	Signalling Relation Establishment Phase
	`mtp_correct_prim`:	Successful Receipt Acknowledgements
	`MTP_CURRENT`:	Message Transfer Part Options Management Request
	`mtp_current_state`:	Message Transfer Part Information Acknowledgement
	`MTP_DEFAULT`:	Message Transfer Part Options Management Request
	`MTP_DEL`:	MTPI Input-Output Controls
	`mtp_dest_length`:	Signalling Relation Data Transfer Phase
	`mtp_dest_offset`:	Signalling Relation Data Transfer Phase
	`MTP_DISCON_REQ`:	Connection Oriented Services
	`MTP_DISCON_REQ`:	Signalling Relation Release Phase
	`MTP_discon_req_t`:	Signalling Relation Release Phase
	`MTP_ERROR_ACK`:	Local Management Services
	`MTP_ERROR_ACK`:	Error Acknowledgement
	`MTP_error_ack_t`:	Error Acknowledgement
	`mtp_error_primitive`:	Error Acknowledgement
	`MTP_EVENT_IND`:	MTP Provider Management Primitives
	`MTP_GET`:	MTPI Input-Output Controls
	`MTP_INFO_ACK`:	Local Management Services
	`MTP_INFO_ACK`:	Message Transfer Part Information Request
	`MTP_INFO_ACK`:	Message Transfer Part Information Acknowledgement
	`MTP_info_ack_t`:	Message Transfer Part Information Acknowledgement
	`MTP_INFO_REQ`:	Local Management Services
	`MTP_INFO_REQ`:	Message Transfer Part Information Request
	`MTP_INFO_REQ`:	Message Transfer Part Information Acknowledgement
	`MTP_info_req_t`:	Message Transfer Part Information Request
	`MTP_INHIBIT_CON`:	MTP Provider Management Services
	`MTP_INHIBIT_CON`:	MTP Provider Management Primitives
	`MTP_INHIBIT_IND`:	MTP Provider Management Services
	`MTP_INHIBIT_IND`:	MTP Provider Management Primitives
	`MTP_INHIBIT_REQ`:	MTP Provider Management Services
	`MTP_INHIBIT_REQ`:	MTP Provider Management Primitives
	`mtp_loc_length`:	Protocol Address Acknowledgement
	`mtp_loc_offset`:	Protocol Address Acknowledgement
	`MTP_MANAGEMENT`:	Bind Protocol Address Request
	`mtp_mgmt_flags`:	Message Transfer Part Options Management Request
	`mtp_mp`:	Signalling Relation Data Transfer Phase
	`mtp_mp`:	Signalling Relation Data Transfer Phase
	`mtp_msu_size`:	Message Transfer Part Information Acknowledgement
	`mtp_mtpi_error`:	Error Acknowledgement
	`MTP_NEGOTIATE`:	Message Transfer Part Options Management Request
	`MTP_OBJ_TYPE_DF`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_DF`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_LK`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_LK`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_LS`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_LS`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_NA`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_NA`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_RL`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_RL`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_RS`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_RS`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_RT`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_RT`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_SL`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_SL`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_SP`:	MTPI Input-Output Controls
	`MTP_OBJ_TYPE_SP`:	MTPI Input-Output Controls
	`MTP_OK_ACK`:	Local Management Services
	`MTP_OK_ACK`:	Successful Receipt Acknowledgements
	`MTP_ok_ack_t`:	Successful Receipt Acknowledgements
	`MTP_OPTMGMT_REQ`:	Local Management Services
	`MTP_OPTMGMT_REQ`:	Message Transfer Part Options Management Request
	`MTP_optmgmt_req_t`:	Message Transfer Part Options Management Request
	`mtp_opt_length`:	Message Transfer Part Options Management Request
	`mtp_opt_offset`:	Message Transfer Part Options Management Request
	`MTP_PAUSE_IND`:	Connectionless Services
	`MTP_PAUSE_IND`:	Signalling Relation Data Transfer Phase
	`MTP_pause_ind_t`:	Signalling Relation Data Transfer Phase
	`mtp_primitive`:	Message Transfer Part Information Request
	`mtp_primitive`:	Message Transfer Part Information Acknowledgement
	`mtp_primitive`:	Protocol Address Request
	`mtp_primitive`:	Protocol Address Acknowledgement
	`mtp_primitive`:	Bind Protocol Address Request
	`mtp_primitive`:	Bind Protocol Address Acknowledgement
	`mtp_primitive`:	Unbind Protocol Address Request
	`mtp_primitive`:	Message Transfer Part Options Management Request
	`mtp_primitive`:	Error Acknowledgement
	`mtp_primitive`:	Successful Receipt Acknowledgements
	`mtp_primitive`:	Signalling Relation Establishment Phase
	`mtp_primitive`:	Signalling Relation Data Transfer Phase
	`mtp_primitive`:	Signalling Relation Data Transfer Phase
	`mtp_primitive`:	Signalling Relation Data Transfer Phase
	`mtp_primitive`:	Signalling Relation Data Transfer Phase
	`mtp_primitive`:	Signalling Relation Data Transfer Phase
	`mtp_primitive`:	Signalling Relation Data Transfer Phase
	`mtp_primitive`:	Signalling Relation Release Phase
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`mtp_primitive`:	MTP Provider Management Primitives
	`MTP_PROHIBIT_CON`:	MTP Provider Management Primitives
	`MTP_PROHIBIT_IND`:	MTP Provider Management Primitives
	`MTP_PROHIBIT_REQ`:	MTP Provider Management Primitives
	`mtp_rem_length`:	Protocol Address Acknowledgement
	`mtp_rem_offset`:	Protocol Address Acknowledgement
	`MTP_RESTART_COMPLETE_IND`:	Signalling Relation Data Transfer Phase
	`MTP_restart_complete_ind_t`:	Signalling Relation Data Transfer Phase
	`MTP_RESUME_IND`:	Connectionless Services
	`MTP_RESUME_IND`:	Signalling Relation Data Transfer Phase
	`MTP_resume_ind_t`:	Signalling Relation Data Transfer Phase
	`mtp_serv_type`:	Message Transfer Part Information Acknowledgement
	`mtp_sls`:	Signalling Relation Data Transfer Phase
	`mtp_sls`:	Signalling Relation Data Transfer Phase
	`mtp_srce_length`:	Signalling Relation Data Transfer Phase
	`mtp_srce_offset`:	Signalling Relation Data Transfer Phase
	`MTP_STATS_IND`:	MTP Provider Management Primitives
	`mtp_status`:	Signalling Relation Data Transfer Phase
	`MTP_STATUS_CONGESTION`:	Signalling Relation Data Transfer Phase
	`MTP_STATUS_CONGESTION_LEVEL0`:	Signalling Relation Data Transfer Phase
	`MTP_STATUS_CONGESTION_LEVEL1`:	Signalling Relation Data Transfer Phase
	`MTP_STATUS_CONGESTION_LEVEL2`:	Signalling Relation Data Transfer Phase
	`MTP_STATUS_CONGESTION_LEVEL3`:	Signalling Relation Data Transfer Phase
	`MTP_STATUS_IND`:	Connectionless Services
	`MTP_STATUS_IND`:	Signalling Relation Data Transfer Phase
	`MTP_status_ind_t`:	Signalling Relation Data Transfer Phase
	`MTP_STATUS_TYPE_CONG`:	Signalling Relation Data Transfer Phase
	`MTP_STATUS_TYPE_UPU`:	Signalling Relation Data Transfer Phase
	`MTP_STATUS_UPU_INACCESSIBLE`:	Signalling Relation Data Transfer Phase
	`MTP_STATUS_UPU_UNEQUIPPED`:	Signalling Relation Data Transfer Phase
	`MTP_STATUS_UPU_UNKNOWN`:	Signalling Relation Data Transfer Phase
	`MTP_TRANSFER_IND`:	Connectionless Services
	`MTP_TRANSFER_IND`:	Connection Oriented Services
	`MTP_TRANSFER_IND`:	Signalling Relation Data Transfer Phase
	`MTP_transfer_ind_t`:	Signalling Relation Data Transfer Phase
	`MTP_TRANSFER_REQ`:	Connectionless Services
	`MTP_TRANSFER_REQ`:	Connection Oriented Services
	`MTP_TRANSFER_REQ`:	Signalling Relation Data Transfer Phase
	`MTP_transfer_req_t`:	Signalling Relation Data Transfer Phase
	`mtp_type`:	Signalling Relation Data Transfer Phase
	`MTP_UNBIND_REQ`:	Local Management Services
	`MTP_UNBIND_REQ`:	Unbind Protocol Address Request
	`MTP_unbind_req_t`:	Unbind Protocol Address Request
	`MTP_UNINHIBIT_CON`:	MTP Provider Management Primitives
	`MTP_UNINHIBIT_IND`:	MTP Provider Management Primitives
	`MTP_UNINHIBIT_REQ`:	MTP Provider Management Primitives
	`mtp_unix_error`:	Error Acknowledgement
	`mtp_version`:	Message Transfer Part Information Acknowledgement

S
	STREAMS:	Preface
	STREAMS:	Introduction
	`struct MTP_addr_ack`:	Protocol Address Acknowledgement
	`struct MTP_addr_req`:	Protocol Address Request
	`struct MTP_bind_ack`:	Bind Protocol Address Acknowledgement
	`struct MTP_bind_req`:	Bind Protocol Address Request
	`struct MTP_conn_req`:	Signalling Relation Establishment Phase
	`struct MTP_discon_req`:	Signalling Relation Release Phase
	`struct MTP_error_ack`:	Error Acknowledgement
	`struct MTP_info_ack`:	Message Transfer Part Information Acknowledgement
	`struct MTP_info_req`:	Message Transfer Part Information Request
	`struct MTP_ok_ack`:	Successful Receipt Acknowledgements
	`struct MTP_optmgmt_req`:	Message Transfer Part Options Management Request
	`struct MTP_pause_ind`:	Signalling Relation Data Transfer Phase
	`struct MTP_restart_complete_ind`:	Signalling Relation Data Transfer Phase
	`struct MTP_resume_ind`:	Signalling Relation Data Transfer Phase
	`struct MTP_status_ind`:	Signalling Relation Data Transfer Phase
	`struct MTP_transfer_ind`:	Signalling Relation Data Transfer Phase
	`struct MTP_transfer_req`:	Signalling Relation Data Transfer Phase
	`struct MTP_unbind_req`:	Unbind Protocol Address Request

T
	`type`:	MTPI Input-Output Controls
	`type`:	MTPI Input-Output Controls

Jump to:	C I L M S T

Short Table of Contents

Preface
- Notice
- Abstract
  - Purpose
  - Intent
  - Audience
- Revision History
  - Version Control
- ISO 9000 Compliance
  - Disclaimer
  - U.S. Government Restricted Rights
- Acknowledgements
1 Introduction
- 1.1 Related Documentation
  - 1.1.1 Role
- 1.2 Definitions, Acronyms, Abbreviations
2 The MTP Layer
- 2.1 Model of the MTPI
- 2.2 MTPI Services
- 2.3 MTP Service Primitives
3 MTPI Services Definition
- 3.1 Local Management Services
- 3.2 Connectionless Services
  - 3.2.1 Data Transfer
    - 3.2.1.1 User Primitives for Data Transfer
    - 3.2.1.2 Provider Primitives for Data Transfer
  - 3.2.2 Error Management
    - 3.2.2.1 Provider Primitives for Error Management
- 3.3 Connection Oriented Services
- 3.4 MTP Provider Management Services
4 MTPI Primitives
- 4.1 Local Management Primitives
- 4.2 Connection Mode and Connectionless Primitives
- 4.3 MTP Provider Management Primitives
5 Diagnostics Requirements
- 5.1 Non-Fatal Error Handling Facility
- 5.2 Fatal Error Handling Facility
6 MTPI Input-Output Controls
- 6.1 MTP Protocol Object Options
- 6.2 MTP Protocol Object Configuration
- 6.3 MTP Protocol Object State Machine
- 6.4 MTP Protocol Object Statistics
- 6.5 MTP Protoocl Object Notifications
- 6.6 MTP Protocol Object Management
  - 6.6.1 Manage MTP Protocol Object
- 6.7 MTP Provider Pass-Along Control
7 MTPI Management Information Base
Addendum for MTP Conformance
- Addendum for ITU-T Q.704 Conformance
- Addendum for ANSI T1.111.4 Conformance
- Addendum for ETSI ETS 300 008-1 Conformance
- Addendum for ITU-T Q.2210 Conformance
Appendix A Mapping MTPI Primitives
- A.1 Mapping MTPI Primitives to Q.701
- A.2 Mapping MTPI Primitives to ANSI T1.111.1
- A.3 Mapping MTPI Primitives to ETSI ETS 300 008-2
Appendix B State/Event Tables
Appendix C Precedence Tables
Appendix D MTPI Header Files
Appendix E MTPI Library
Appendix F MTPI Drivers and Modules
Appendix G MTPI Utilities
Appendix H MTPI File Formats
Appendix I MTPI Compatibility and Porting
Glossary
Acronyms
References
Licenses
- GNU Affero General Public License
  - Preamble
  - How to Apply These Terms to Your New Programs
- GNU Free Documentation License
Index

Footnotes

(1)

http://www.openss7.org/repos/tarballs/openss7-1.1.7.20141001.tar.bz2

(2)

‘Q.711’.

(3)

ISUP consists of signalling relations between two switches which also have digital facilities between them. In general an ISUP MTP-User can communicate with many other MTP-User peers, however, signalling between any given two enpoints only concerns the digital facilities which exist between the two endpoints. So, management of ISUP switches is best performed on a pairing of endpoints (signalling relations). Also, the COMS mode of operation is provided in support of DPC list Routing Keys for M3UA. [RFC 4666]

(4)

Conventions for the time-sequence diagrams are defined in ITU-T X.210. [X.210]

MTPI Technical Specification

Description: OpenSS7 Resources Library.

Message Transfer Part Interface (MTPI)

Message Transfer Part Interface (MTPI) Specification

About This Manual

Preface

Notice

Abstract

Purpose

Intent

Audience

Revision History

Version Control

ISO 9000 Compliance

Disclaimer

U.S. Government Restricted Rights

Acknowledgements

1 Introduction

1.1 Related Documentation

1.1.1 Role

1.2 Definitions, Acronyms, Abbreviations

2 The MTP Layer

2.1 Model of the MTPI

2.2 MTPI Services

2.2.1 CLMS

2.2.2 COMS

2.2.3 Local Management

2.2.4 Provider Management

2.3 MTP Service Primitives

3 MTPI Services Definition

3.1 Local Management Services

3.1.1 Message Transfer Part Information Reporting Service

3.1.2 MTP Address Service

3.1.3 MTP User Bind Service

3.1.4 MTP User Unbind Service

3.1.5 Receipt Acknowledgement Service

3.1.6 Options Management Service

3.1.7 Error Acknowledgement Service

3.2 Connectionless Services

3.2.1 Data Transfer

3.2.1.1 User Primitives for Data Transfer

3.2.1.2 Provider Primitives for Data Transfer

3.2.2 Error Management

3.2.2.1 Provider Primitives for Error Management

3.3 Connection Oriented Services

3.3.1 Connection Establishment Phase

3.3.1.1 User primitives for Successful MTP Association Establishment

3.3.1.2 Provider primitives for Successful MTP Association Establishment

3.3.2 Data Transfer Phase

3.3.2.1 User primitives for MTP Data Transfer

3.3.2.2 Provider primitives for MTP Data Transfer

3.3.3 Error Management Primitives

3.3.3.1 Provider Primitives for Management

3.3.4 Connection Termination Phase

3.3.4.1 User Primitives for MTP Association Termination

3.4 MTP Provider Management Services

3.4.1 Link Management

3.4.1.1 User Primitives for Link Inhibit Service

3.4.1.2 Provider Primitives for Link Inhibit Service

3.4.1.3 User Primitives for Link Uninhibit Service

3.4.1.4 Provider Primitives for Link Uninhibit Service

3.4.2 Route Management

3.4.2.1 User Primitives for Route Allow Service

3.4.2.2 Provider Primitives for Route Allow Service

3.4.2.3 User Primitives for Route Prohibit Service

3.4.2.4 Provider Primitives for Route Prohibit Service

3.4.3 Layer Management

3.4.3.1 User Primitives for Event Indications

3.4.3.2 Provider Primitives for Event Indications

3.4.3.3 User Primitives for Statistics Indications

3.4.3.4 Provider Primitives for Statistics Indications

4 MTPI Primitives

4.1 Local Management Primitives

4.1.1 Message Transfer Part Information Request

MTP_INFO_REQ

Format

Parameters

Valid States

New State

Acknowledgements