NMS Logo

NMS ISDN Messaging API
Developer's Reference Manual

P/N 6272-22
Version

Table of Contents Index NMS Glossary Previous Page Next Page Version

Table of Contents

1 Introduction

1.1 Introduction
1.2 Integrated Services Digital Network (ISDN)
1.2.1 ISDN Protocols and Protocol Layering
1.2.2 Information Exchange Between Layers
1.2.3 ISDN Carriers
1.2.4 ISDN Functional Devices and Reference Points
1.3 NMS ISDN Software
1.3.1 NMS ISDN Product Configurations
1.3.2 NMS ISDN ACU Configuration
1.3.3 NMS ISDN LAPD Configuration
1.3.4 Reference Points Supported by NMS ISDN
1.4 NMS ISDN Software Components
1.4.1 Readme File
1.4.2 NMS ISDN Function Libraries
1.4.3 ISDN Protocol Stack Downloadable Object Modules
1.4.4 Configuration File
1.4.5 Demonstration Programs and Utilities
1.5 Other Components
1.5.1 Natural Access
1.6 Developing an NMS ISDN Application

2 Messaging API Programming Model

2.1 Introduction
2.2 Natural Access Environment
2.2.1 Natural Access Components
2.2.2 Natural Access Programming Model
2.3 NMS ISDN Messaging API Application Overview
2.3.1 Initializing Your Boards
2.4 Sending ISDN Messages to the Stack
2.4.1 Building ACU Message Structures
2.4.2 Sending LAPD Messages
2.5 Receiving Events and ISDN Protocol Stack Messages
2.5.1 Receiving Messages From the NMS ISDN Protocol Stack

3 Initializing a Messaging API Application

3.1 Introduction
3.2 Overview
3.3 Making Switch Connections for NMS ISDN
3.4 Initializing Natural Access
3.4.1 Specifying B Channel Contexts
3.4.2 Specifying D Channel Contexts
3.5 Accessing D Channels
3.5.1 Network Access Identifiers (NAIs)
3.5.2 Initializing ISDN Protocol Stack Instances
3.6 Starting the NOCC TCP
3.6.1 Setting mediamask (AG Quad T/E only)
3.7 Stopping an ISDN Protocol Stack Instance

4 Call Control (ACU Configuration)

4.1 Introduction
4.1.1 Connection IDs
4.2 The ISDN Call Control State Machine
4.3 Receiving Inbound Calls
4.3.1 Accepting the Call
4.3.2 Rejecting the Call
4.3.3 Incoming Calls With Overlap Receiving Mode Enabled
4.4 Placing Outbound Calls
4.5 Call Collision
4.6 Call Clearing
4.6.1 Clear Collision

5 Data Link Operations (LAPD)

5.1 Introduction
5.2 NMS ISDN State Machine (LAPD Configuration)
5.3 Initiating a Data Link
5.4 Responding to a Data Link Establishment Request
5.5 Sending Messages Across an Established Link

6 Messaging API Data Structures

6.1 Introduction
6.2 Messaging Structures
6.2.1 ISDN_MESSAGE Structure
6.2.2 ISDN_PACKET Structure
6.3 Protocol Parameter Structures
6.3.1 ISDN_PROTOCOL_PARMS_Q931CC Structure
6.3.2 ISDN_PROTOCOL_PARMS_LAPD Structure
6.3.3 ISDN_PROTOCOL_PARMS_CHANNELIZED

7 Alphabetical Function Reference

7.1 Introduction
7.2 NMS ISDN Messaging API Function Summary
7.3 Alphabetical Function Reference
isdnReleaseBuffer
isdnSendMessage
isdnSetMsgCapture
isdnStartProtocol
isdnStopProtocol

8 Message Primitives

8.1 Introduction
8.2 ACU Primitives
8.2.1 ACU Message Reference
ACU_ALERT_IN
ACU_ALERT_RQ
ACU_CALL_PROC_IN
ACU_CALL_PROC_RQ
ACU_CLEAR_CO
ACU_CLEAR_IN
ACU_CLEAR_RQ
ACU_CLEAR_RS
ACU_CONN_CO
ACU_CONN_IN
ACU_CONN_RQ
ACU_CONN_RS
ACU_D_CHANNEL_STATUS_IN
ACU_D_CHANNEL_STATUS_RQ
ACU_DIGIT_CO
ACU_DIGIT_IN
ACU_DIGIT_RQ
ACU_ERR_IN
ACU_FACILITY_IN
ACU_FACILITY_RQ
ACU_INFORMATION_IN
ACU_INFORMATION_RQ
ACU_INIT_CO
ACU_INIT_RQ
ACU_NOTIFY_IN
ACU_NOTIFY_RQ
ACU_PROGRESS_IN
ACU_PROGRESS_RQ
ACU_RESTART_IN
ACU_RESUME_CO
ACU_RESUME_RQ
ACU_SERVICE_CO
ACU_SERVICE_IN
ACU_SERVICE_RQ
ACU_SET_MODE_CO
ACU_SET_MODE_RQ
ACU_SETPARM_RQ
ACU_SETUP_ACK_IN
ACU_SETUP_REPORT_IN
ACU_SUSPEND_CO
ACU_SUSPEND_RQ
ACU_TEST_CO
ACU_TEST_RQ
ACU_USER_INFO_IN
ACU_USER_INFO_RQ
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 Signal Values
8.3.10 Network-Provided Clearing Cause Values
8.3.11 Clear Code Values
8.3.12 Facility Code Values
8.3.13 Action Code Values
8.3.14 Mode Code Values
8.3.15 Error Cause Values
8.3.16 Progress Description Values
8.3.17 Charging Type Values
8.3.18 Endpoint ID Values
8.4 LAPD Primitives

9 Demonstration Programs and Utilities

9.1 Introduction
9.2 Demonstration Programs and Utilities
9.3 Layer 3 Call Control Demonstration: isdndemo
9.3.1 Using NFAS With isdndemo
9.3.2 Structure and Coding (Single-Threaded Version)
9.3.3 Structure and Coding (Multi-Threaded Version)
9.3.4 ISDN Call Control
9.3.5 Identifying Trunks
9.4 LAPD Demonstration Program: lapddemo
9.4.1 lapddemo Configuration File
9.4.2 lapddemo Structure and Coding Features
9.5 Stack Traffic Analysis Tool: dectrace
9.5.1 Creating a Log File for dectrace
9.5.2 Messages Decoded by dectrace
9.5.3 Sample dectrace Output
9.6 Stack Traffic Filtering Tool: itrace

Appendix A Events, Reasons, and Errors

Introduction
NMS ISDN Events
NMS ISDN Reasons
NMS ISDN Errors

Appendix B Parameters

Introduction
ISDN_PROTOCOL_PARMS_Q931CC
services_list Field
in_calls_behaviour Field
out_calls_behaviour Field
acu_behaviour Field
ns_behaviour Field
qsig_source_party_nb_type Field
qsig_source_type_of_nb Field
ISDN_PROTOCOL_PARMS_LAPD

Appendix C Sending and Receiving Raw Q.931 Data

Introduction
Creating Transparent IEs
Transparent IE Formatting Rules
Accessing and Reading a Q.931 Buffer

Appendix D Sending and Receiving PCS-User Information

Introduction
Structure of User-PCS IEs
Sending and Receiving PCS Information Elements
Example Code

Appendix E Timer Values

Introduction
Timer Functions
Timer Values
France VN6 Layer 3 Timer Defaults
EuroISDN Layer 3 Timer Defaults
AT&T E10 Layer 3 Timer Defaults
Nortel DMS 100 Layer 3 Timer Defaults
USA National ISDN-2 Layer 3 Timer Defaults
Australian Telecom 1 Layer 3 Timer Defaults
Hong Kong Telephone Layer 3 Timer Defaults
INS-1500 NTT Layer 3 Timer Defaults
AT&T 4ESS Layer 3 Timer Defaults
Korean (and Taiwan) Layer 3 Timer Defaults
QSIG Layer 3 Timer Defaults

Appendix F NFAS and D Channel Backup

Introduction
Non-Facility Associated Signaling (NFAS)
Setting Up NFAS
Using NFAS
D Channel Backup
Setting up D Channel Backup
Handling D Channel Failure

Appendix G Modifying the NSF IE

Introduction
NSF IE Fields
net_id_type
action
serv_feature
Facility Coding
param_fld
Example

Table of Contents Index NMS Glossary Previous Page Next Page Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights reserved.