NMS GR303 library function summary

This topic summarizes NMS GR303 library functions according to task. All functions except NMS_GR303PhSendData are synchronous.

Initializing and exiting the NMS GR303 library functions

Use the following functions to initialize and exit the NMS GR303 library and to set trace levels for the library:

Function

Description

NMS_GR303Initialize

Loads and initializes the NMS GR303 library.

NMS_GR303SetTrace

Configures tracing for the NMS GR303 library.

NMS_GR303Exit

Performs an internal NMS GR303 library clean-up procedure and exits the library.


Creating, modifying, and destroying interfaces functions

Use the following functions to create and destroy physical layer interfaces with the NMS GR303 library:

Function

Description

NMS_GR303ProvisionInterface

Configures (provisions) the HDLC channels for the specified interface.

NMS_GR303ModifyChannelLocation

Moves a provisioned HDLC channel to a new location or adds a new HDLC channel to a specified interface without re-provisioning the entire interface.

NMS_GR303DestroyInterface

Destroys all connections for HDLC instances associated with a specified interface.


Controlling interfaces functions

Use the following functions to control physical layer interfaces with the NMS GR303 library:

Function

Description

NMS_GR303StartInterface

Starts the physical layer (HDLC channels) on a provisioned interface.

NMS_GR303StopInterface

Stops the physical layer (HDLC channels) of the provisioned interface.

NMS_GR303PhSendData

Sends a LAPD frame to a specified HDLC channel.


Retrieving and resetting DS1 link and channel information functions

Use the following functions to retrieve and reset link status information and channel statistics:

Function

Description

NMS_GR303GetDS1Status

Retrieves DS1 link status information for a specified DS1 link.

NMS_GR303ResetDS1Status

Resets DS1 link status information for a specified DS1 link.

NMS_GR303GetChannelStatistics

Retrieves HDLC channel statistics for a specified HDLC channel on an active provisioned interface.

NMS_GR303ResetChannelStatistics

Resets the HDLC channel statistics collected for a specified HDLC channel provisioned on the active interface variant.