(Page 1 of 42 in this chapter)

Chapter 8

Message Primitives

8.1 Introduction

8.2 ACU Primitives

: 8.2.1 ACU Message Reference

8.3 Data Types and Constants In Primitives

: 8.3.1 User Rate Values
: 8.3.2 Service Values
: 8.3.3 Number Type Values
: 8.3.4 Plan Values
: 8.3.5 Screening Indicator Values
: 8.3.6 Redirecting Reason Values
: 8.3.7 Location Values
: 8.3.8 UUI Protocol Discriminator Values
: 8.3.9 pcs_user Protocol Discriminator Values
: 8.3.10 Signal Values
: 8.3.11 Network-Provided Clearing Cause Values
: 8.3.12 Clear Code Values
: 8.3.13 Facility Code Values
: 8.3.14 Action Code Values
: 8.3.15 Mode Code Values
: 8.3.16 Error Cause Values
: 8.3.17 Progress Description Values
: 8.3.18 Charging Type Values
: 8.3.19 Endpoint ID Values

8.4 LAPD Primitives

8.1 Introduction

This chapter describes the types and contents of the messages interchanged between the AG ISDN protocol stack and the application program.
To send a message to the stack, the application specifies the message primitive in the ISDN_MESSAGE structure passed to isdnSendMessage, as described in Section 2.4. Events received from the stack contain message primitives, as described in Section 3.5.1.
Messages with the prefix "ACU_" are valid only when the AG ISDN software is in its ACU configuration, and the protocol stack is in ACU stack mode. Messages with the prefix "DL_" are valid only when the AG ISDN software is in its LAPD configuration, and the protocol stack is in LAPD stack mode.

8.2 ACU Primitives

The following is a summary of supported ACU message primitives: Message Type Description ACU_ALERT_IN Alert indication. ACU_ALERT_RQ Send an Alert message. ACU_CALL_PROC_IN Incoming call proceeding information. ACU_CALL_PROC_RQ Request events indicating the progression of a call. ACU_CLEAR_CO Release confirmation. ACU_CLEAR_IN Release indication. ACU_CLEAR_RQ Release request. ACU_CLEAR_RS Response to the release. ACU_CONN_CO Call connection confirmation. ACU_CONN_IN Signals an incoming call. ACU_CONN_RQ Request establishment of an outgoing call. ACU_CONN_RS Answering an incoming call. ACU_D_CHANNEL_ STATUS_IN Indicates status of D channel. ACU_D_CHANNEL_ STATUS_RQ Requests status of the D channel. ACU_DIGIT_CO Confirm that all of the called digits were sent, in overlap sending mode. Not supported. ACU_DIGIT_IN Receive called number digits in overlap receiving mode. ACU_DIGIT_RQ Receive called number digits in overlap receiving mode. ACU_ERR_IN Error indication. ACU_FACILITY_IN Indicate a specific facility. ACU_FACILITY_RQ Request a specific facility. ACU_INFORMATION_IN Indicate information. ACU_INFORMATION_RQ Request information. ACU_INIT_CO Initialization confirmation. Not supported. ACU_INIT_RQ Initialization request. Not supported. ACU_NOTIFY_IN Indicate notify. ACU_NOTIFY_RQ Request notify. ACU_PROGRESS_IN Outgoing call progression information (receipt of Call-Proceeding or Progress message). ACU_PROGRESS_RQ Progress request. ACU_RESUME_CO Confirm resume. ACU_RESUME_RQ Request resume. ACU_SET_MODE_CO Confirm setting of a particular mode. ACU_SET_MODE_RQ Request setting of a particular mode. ACU_SETPARM_RQ Request to set parameters. Not supported. ACU_SETUP_REPORT_IN Signals an incoming call that has been rejected or ignored by the ACU because it was not compatible (address or service filtering). The application must not answer to this incoming call indication. This message is only for information purposes. ACU_SUSPEND_CO Confirm suspension. ACU_SUSPEND_RQ Request suspension. ACU_TEST_CO Confirm test. Not supported. ACU_TEST_RQ Request test. Not supported. ACU_USER_INFO_IN Indicate user-to-user information. ACU_USER_INFO_RQ Request user-to-user information. SM_CHANNEL_MAINT_RQ Use this structure to send a SERVICE message (from NS to MNS). Note: Not all macros or macro combinations are supported for every variant.

Message Type	Description
`ACU_ALERT_IN`	Alert indication.
`ACU_ALERT_RQ`	Send an Alert message.
`ACU_CALL_PROC_IN`	Incoming call proceeding information.
`ACU_CALL_PROC_RQ`	Request events indicating the progression of a call.
`ACU_CLEAR_CO`	Release confirmation.
`ACU_CLEAR_IN`	Release indication.
`ACU_CLEAR_RQ`	Release request.
`ACU_CLEAR_RS`	Response to the release.
`ACU_CONN_CO`	Call connection confirmation.
`ACU_CONN_IN`	Signals an incoming call.
`ACU_CONN_RQ`	Request establishment of an outgoing call.
`ACU_CONN_RS`	Answering an incoming call.
`ACU_D_CHANNEL_` `STATUS_IN`	Indicates status of D channel.
`ACU_D_CHANNEL_` `STATUS_RQ`	Requests status of the D channel.
`ACU_DIGIT_CO`	Confirm that all of the called digits were sent, in overlap sending mode. Not supported.
`ACU_DIGIT_IN`	Receive called number digits in overlap receiving mode.
`ACU_DIGIT_RQ`	Receive called number digits in overlap receiving mode.
`ACU_ERR_IN`	Error indication.
`ACU_FACILITY_IN`	Indicate a specific facility.
`ACU_FACILITY_RQ`	Request a specific facility.
`ACU_INFORMATION_IN`	Indicate information.
`ACU_INFORMATION_RQ`	Request information.
`ACU_INIT_CO`	Initialization confirmation. Not supported.
`ACU_INIT_RQ`	Initialization request. Not supported.
`ACU_NOTIFY_IN`	Indicate notify.
`ACU_NOTIFY_RQ`	Request notify.
`ACU_PROGRESS_IN`	Outgoing call progression information (receipt of Call-Proceeding or Progress message).
`ACU_PROGRESS_RQ`	Progress request.
`ACU_RESUME_CO`	Confirm resume.
`ACU_RESUME_RQ`	Request resume.
`ACU_SET_MODE_CO`	Confirm setting of a particular mode.
`ACU_SET_MODE_RQ`	Request setting of a particular mode.
`ACU_SETPARM_RQ`	Request to set parameters. Not supported.
`ACU_SETUP_REPORT_IN`	Signals an incoming call that has been rejected or ignored by the ACU because it was not compatible (address or service filtering). The application must not answer to this incoming call indication. This message is only for information purposes.
`ACU_SUSPEND_CO`	Confirm suspension.
`ACU_SUSPEND_RQ`	Request suspension.
`ACU_TEST_CO`	Confirm test. Not supported.
`ACU_TEST_RQ`	Request test. Not supported.
`ACU_USER_INFO_IN`	Indicate user-to-user information.
`ACU_USER_INFO_RQ`	Request user-to-user information.
`SM_CHANNEL_MAINT_RQ`	Use this structure to send a SERVICE message (from NS to MNS).

8.2.1 ACU Message Reference

The following sections list each supported ACU message. With each message is listed the following:

This Column...

Contains the following...

Macro

· The macros you can use to specify values for the information elements (IEs) in outgoing Q.931 messages. When the structure (and its substructures) containing this data reaches the ISDN protocol stack, the stack rearranges the data into several IEs, builds a complete Q.931 message with the IEs, and sends it to the network.
· A filling order, if necessary. Certain pointer and size macros must be assigned values in sequence, so that the IEs in outgoing messages are ordered correctly. If macros must be filled out in order, they are marked with a "Filling Order" number in the reference table. For example, when creating an ACU_ALERT_RQ message (described on page 110), the application must call the acu_alert_rq_a_uui and acu_alert_rq_uui_size macros before calling the acu_alert_rq_a_ display and acu_alert_rq_display_size macros. For this reason, "Filling Order: 1" appears in the first column with the UUI macros in the reference table. "Filling Order: 2" appears with the display macros.

Description

· A short description of the purpose of each macro.
· If a certain set of values can be assigned, the complete set appears either in the second column with the description, or in one of the tables in Section 8.3 of this chapter.
· If a default value is assigned to the macro if the macro is not set, this value also appears in this column.

Q.931 IE

The Q.931 information element in which the assigned value will appear.
Note: Some macros do not map directly to any information element. Also, several macros are not currently used at all. They are included in the reference table for informational purposes only.

4ESS, E10, NI2, DMS100, ETSI, VN6, HKG, AUSTEL1, NTT, KOR, QSIG

The variants under which each macro is supported. Note that several macros are not officially supported under any listed variant.
Macros supported under "E10" are also supported under AT&T 5E9.

This Column...	Contains the following...
Macro	· The macros you can use to specify values for the information elements (IEs) in outgoing Q.931 messages. When the structure (and its substructures) containing this data reaches the ISDN protocol stack, the stack rearranges the data into several IEs, builds a complete Q.931 message with the IEs, and sends it to the network. · A filling order, if necessary. Certain pointer and size macros must be assigned values in sequence, so that the IEs in outgoing messages are ordered correctly. If macros must be filled out in order, they are marked with a "Filling Order" number in the reference table. For example, when creating an `ACU_ALERT_RQ` message (described on page 110), the application must call the `acu_alert_rq_a_uui` and `acu_alert_rq_uui_size` macros before calling the `acu_alert_rq_a_ display` and `acu_alert_rq_display_size` macros. For this reason, "Filling Order: 1" appears in the first column with the UUI macros in the reference table. "Filling Order: 2" appears with the display macros.
Description	· A short description of the purpose of each macro. · If a certain set of values can be assigned, the complete set appears either in the second column with the description, or in one of the tables in Section 8.3 of this chapter. · If a default value is assigned to the macro if the macro is not set, this value also appears in this column.
Q.931 IE	The Q.931 information element in which the assigned value will appear. Note: Some macros do not map directly to any information element. Also, several macros are not currently used at all. They are included in the reference table for informational purposes only.
4ESS, E10, NI2, DMS100, ETSI, VN6, HKG, AUSTEL1, NTT, KOR, QSIG	The variants under which each macro is supported. Note that several macros are not officially supported under any listed variant. Macros supported under "E10" are also supported under AT&T 5E9.

(Page 1 of 42 in this chapter)

tech_support@nmss.com