(Page 1 of 27 in this chapter) Version

Chapter 5

Alphabetical Management Function Reference

5.1 Introduction

: isupBlockCircuit 113
: isupCircCfg 114
: isupCircuitStats 115
: isupCircuitStatus 116
: isupDeleteCircuit 117
: isupGenCfg 118
: isupGetCircCfg 119
: isupGetGenCfg 120
: isupGetNSapCfg 121
: isupGetRouteCfg 122
: isupGetUSapCfg 123
: isupInitCircCfg 124
: isupInitGenCfg 126
: isupInitMgmtAPI 128
: isupInitNSapCfg 129
: isupInitRouteCfg 130
: isupInitUSapCfg 131
: isupNSapCfg 135
: isupNSapStats 136
: isupResetCircuit 137
: isupRouteCfg 138
: isupTermMgmtAPI 139
: isupTraceControl 140
: isupUnblockCircuit 141
: isupUSapCfg 142
: isupValidateCircuit 143

5.1 Introduction

This chapter provides a comprehensive, alphabetically-ordered reference to the ISUP management API functions. A prototype of each function is shown with the function description, details of all arguments, and return values. Some of the fields in the function definition include: Prototype The prototype is shown followed by a listing of the function's arguments. Natural MicroSystems data types include: · U8 · S16 · U16 · U32 · Bool 8-bit unsigned 16-bit signed 16-bit unsigned 32-bit unsigned 8-bit unsigned If a function argument is a data structure, the complete data structure is defined. Return Values The return value for a function is either SUCCESS or an error code. For asynchronous functions, a return value of SUCCESS (zero) indicates the function was initiated; subsequent events indicate the status of the operation.
Unlike the ISUP data API, which sends and receives messages asynchronously, each management API call generates a request followed immediately by a response from the TX board. This API blocks the calling application waiting for this response (for maximum of 5 seconds, but typically a few hundred milliseconds) and will return an indication as to whether or not an action was completed successfully. For this reason, it is expected that the management API will typically be employed by one or more management applications, separate from the applications utilizing the transaction API. The management API is packaged as a separate library with its own interface header files.

Prototype	The prototype is shown followed by a listing of the function's arguments. Natural MicroSystems data types include:
	· `U8` · `S16` · `U16` · `U32` · `Bool`	8-bit unsigned 16-bit signed 16-bit unsigned 32-bit unsigned 8-bit unsigned
	If a function argument is a data structure, the complete data structure is defined.
Return Values	The return value for a function is either `SUCCESS` or an error code. For asynchronous functions, a return value of `SUCCESS` (zero) indicates the function was initiated; subsequent events indicate the status of the operation.

(Page 1 of 27 in this chapter) Version

tech_support@nmss.com

Chapter 5

Alphabetical Management Function Reference

5.1 Introduction

Prototype

Return Values