This section provides an alphabetical reference to the SCCP management functions. A prototype of each function is shown with the function description and details of all arguments and return values. A typical function includes:
|
Prototype |
The prototype is followed by a listing of the function arguments. NMS data types include:
If a function argument is a data structure, the complete data structure is shown. |
|
Return values |
The return value for a function is either SCCP_SUCCESS or an error code. For asynchronous functions, a return value of SCCP_SUCCESS (zero) indicates the function was initiated; subsequent events indicate the status of the operation. |
Unlike the SCCP service functions that send and receive messages asynchronously, each SCCP management function generates a request followed immediately by a response from the TX board. SCCP management functions block the calling application waiting for this response for a maximum of five seconds, but typically a few hundred milliseconds and return an indication as to whether or not an action was completed successfully. For this reason, the SCCP management functions are typically used by one or more management applications, separate from the applications that use the SCCP service. SCCP management is packaged as a separate library with its own interface header files.