(Page 1 of 1 in this chapter)


Chapter 2

Function Summary


2.1 Common Management API Summary
2.1.1 Initializing the TX API Environment
2.1.2 Initializing and Configuring TX API Packets
2.1.3 Transmitting TX API Packets and Waiting for Responses
2.1.4 Converting Function Arguments to LSB-first Format
2.2 TPX API Summary
2.2.1 Configuring, Controlling and Monitoring TPX Interfaces
2.2.2 Configuring, Controlling and Monitoring TPX Routes
2.3 Ds0 Over IP API Summary
2.4 X.25 API Summary
2.4.1 Configuring, Controlling, and Monitoring X.25 Links
2.4.2 Configuring, Controlling, and Monitoring X.25 Files
2.4.3 Configuring, Controlling, and Monitoring X.25 Routes

2.1 Common Management API Summary

The following sections provide brief descriptions of Common Management API functions.

2.1.1 Initializing the TX API Environment

The following functions initialize and deactivate the TX API environment:
Function

Description

TxApiOpen

Initializes the CPI Library and registers to receive dual port RAM packets (IO responses) from the NETMGR task on indicated communications processor.

TxApiPktInit

Initializes a block of memory as a TX Common Management API packet (to be used as a request or response in future TX API calls).

TxApiClose

Deactivates registration to receive dual port RAM responses from NETMGR on the associated communications processor.

2.1.2 Initializing and Configuring TX API Packets

The following functions initialize and configure the IO portion of TX packets:

Function

Description

TxApiIoInit

Initializes the IO packet portion of a TX Common Management API packet.

TxApiIoDest

Set the destination of the IO packet portion of a TX Common Management API packet.

TxApiMount

Initializes the IO packet portion of a TX Common Management API packet as an IO/MOUNT of the specified task name.

2.1.3 Transmitting TX API Packets and Waiting for Responses

The following functions control transmitting and waiting for responses to TX API packets:

Function

Description

TxApiSendReq

Transmits the TX Common Management API request packet to the indicated communications processor.

TxApiReqRsp

Transmits the TX Common Management API request and polls (up to 3 seconds) for response.

TxApiGetRsp

Enters a polling loop waiting (for up to 3 seconds) for a response to the indicated TX Common Management API request packet.

TxApiShNext

Locates the next summary record in response buffer.

2.1.4 Converting Function Arguments to LSB-first Format

The following functions converting long and short arguments from MSB-first format to LSB-first format:

Function

Description

TxApiSwabLong

Converts a long or unsigned long from MSB first representation to LSB first (or LSB to MSB).

TxApiSwabShort

Converts a short or unsigned short from MSB first representation to LSB first (or LSB to MSB).

2.2 TPX API Summary

The following sections provide brief descriptions of TPX API functions.

2.2.1 Configuring, Controlling and Monitoring TPX Interfaces

The following functions assist in configuring, controlling, and monitoring TPX interfaces:
Function

Description

TxTpxIfDefault

Sets up a TX Common Management API packet as a DEFINE INTERFACE packet with all default values.

TxTpxIfEth

Sets up a TX Common Management API packet as an Ethernet interface definition packet.

TxTpxIfX25

Sets up a TX Common Management API packet as an X.25 interface definition packet.

TxTpxIfSlp

Sets up a TX Common Management API packet as a SLIP interface definition packet.

TxTpxIfPpp

Sets up a TX Common Management API packet as a PPP interface definition packet.

TxTpxIfSnc

Sets up a TX Common Management API packet as a Sync interface definition packet.

TxTpxIfSlx

Sets up a TX Common Management API packet as a SLIP over X.25 interface definition packet.

TxTpxIfDelete

Sets up a TX Common Management API packet as an interface delete packet for the specified interface.

TxTpxIfEnable

Sets up a TX Common Management API packet as an interface enable packet for the specified interface.

TxTpxIfDisable

Sets up a TX Common Management API packet as an interface disable packet for the specified interface.

TxTpxIfAbort

Sets up a TX Common Management API packet as an interface abort packet for the specified interface.

TxTpxIfClrStats

Sets up a TX Common Management API packet as an interface clear statistics packet for the specified interface.

TxTpxIfShFull

Sets up a TX Common Management API packet as an interface show full packet for the specified interface.

TxTpxIfShSumm

Sets up a TX Common Management API packet as an interface show summary packet for the specified interface.

TxTpxIfShNext

Assists in handling response packets to interface show summary requests.

TxTpxSlxShProt

Sets up a TX Common Management API packet as a Slip over X.25 interface show protocol packet for the specified interface.

Setting Up interface Definition Packets

The following functions set up interface definition packets:

Function

Description

TxTpxIfBufCtl

Sets up the buffer control portion of an interface definition packet.

TxTpxIfSQCtl

Sets up the source quench control portion of an interface definition packet (source quench control is common to all TPX interfaces).

TxTpxIfOptCtl

Sets up the options control portion of an interface definition packet.

2.2.2 Configuring, Controlling and Monitoring TPX Routes

The following functions assist in the configuring, controlling, and monitoring TPX routes:
Function

Description

TxTpxRteDefault

Sets up the TX API Management packet as a Define route packet with all default values.

TxTpxRteDefine

Sets up the packet as a route definition packet.

TxTpxRteDelete

Sets up the packet as a route delete packet for the specified IP address.

TxTpxRteShFull

Sets up the packet as a route show full packet for the specified route.

TxTpxRteShSumm

Sets up the packet as a route show summary packet for the specified interface.

TxTpxRteShNext

Assist in handling a response packet to a route show summary request.

2.3 Ds0 Over IP API Summary

The following sections provide brief descriptions of Ds0 Over IP functions.
Function

Description

TxDIConfig

Configure the behavior of the Ds0 over IP API.

TxDIOpen

Opens the communications channel between the Host Application and a specified TX board on the system.

TxDIClose

Closes the communication channel between the TX board and the application.

TxDIConnect

Makes a connection between a particular voice stream and a remote IP address.

TxDI2Connect

Makes a connection between a particular voice stream and a remote IP address.

TxDIDisConnect

Terminates a previously set connection between a particular DS0 and a host computer on an IP network.

2.4 X.25 API Summary

The following sections provide brief descriptions of X.25 functions.

2.4.1 Configuring, Controlling, and Monitoring X.25 Links

The following functions assist in configuring, controlling, and monitoring X.25 Links:
Function

Description

TxX25LinkDefault

Sets up the TX API Management packet as a Define Link packet with all default values.

TxX25LinkDefine

Sets up the packet as an X.25 Link definition packet, with required parameters.

TxX25LinkParms

Sets up optional numeric parameters in an X.25 Link definition packet.

TxX25LinkL3Lcn

Sets up optional Level 3 LCN Ranges in an X.25 Link definition packet.

TxX25LinkL3Opts

Sets up optional Level 3 numeric parameters in an X.25 Link definition packet.

TxX25LinkL3Timers

Sets up optional Level 3 timing parameters in an X.25 Link definition packet.

TxX25LinkDelete

Sets up the packet as an Link Delete (I/O Destroy) packet for a specified link.

TxX25LinkEnable

Sets up the packet as an Link Enable (I/O Mode) packet for a specified link

TxX25LinkDisable

Sets up the packet as an Link Disable (I/O Mode) packet for a specified link.

TxX25LinkLock

Sets up the packet as an Link Lock (I/O Mode) packet for a specified link.

TxX25LinkUnlock

Sets up the packet as an Link Unlock (I/O Mode) packet for a specified link.

TxX25LinkAbort

Sets up the packet as an Link Abort (I/O Mode: clear all calls) packet for a specified link.

TxX25LinkClrStats

Sets up the packet as a Link Reset Statistics (I/O Mode) packet for a specified link.

TxX25LinkShFull

Sets up the packet as an Link Show Full (I/O Info) packet for a specified link.

TxX25LinkShSumm

Sets up the packet as an Link Show Summary (I/O Info) packet for a specified link.

TxX25LinkShNext

Assists in handling response packets to a Link Show summary request.

TxX25LinkShStats

Sets up the packet as an X.25 Link Show level 2 statistics (I/O Info) packet for a specified link.

TxX25LCNShow

Sets up the packet as an LCN Show Full packet for a specified link.

TxX25LCNShSumm

Sets up the packet as an LCN Show Summary packet for a specified link.

TxX25LCNShNext

Assist in handling response packets to a Link LCN Show Summary request.

2.4.2 Configuring, Controlling, and Monitoring X.25 Files

The following functions assist in configuring, controlling, and monitoring X.25 files:
Function

Description

TxX25FileDefault

Sets up the TX API Management packet as a Define File (I/O Create) packet with all default values.

TxX25FileDefine

Sets up required parameters in an X.25 file definition packet.

TxX25FileFacility

Sets up certain optional Facilities parameters of a File definition packet.

TxX25FileParms

Sets up certain optional numeric parameters of a File definition packet.

TxX25FileDelete

Sets up the packet as an File Delete packet for a specified file.

TxX25FileShFull

Sets up the packet as an File Show full packet for a specified file.

TxX25FileShSumm

Sets up the packet as an File Show summary packet for a specified File.

TxX25FileShNext

Assist in handling response packets to a File Show summary request for a specified file.

2.4.3 Configuring, Controlling, and Monitoring X.25 Routes

The following functions assist in configuring, controlling, and monitoring X.25 routes:
Function

Description

TxX25RteDefault

Sets up the TX API Management packet as a Define Route packet with all default values.

TxX25RteDefine

Sets up the packet as a route definition packet.

TxX25RteDelete

Sets up the packet as a Route Delete packet for a specified IP address.

TxX25RteShFull

Sets up the packet as a Route Show full packet for a specified route.

TxX25RteShSumm

Sets up the packet as a Route Show summary packet for a specified file.

TxX25RteShNext

Assists in handling a response packet to a route show summary request.



(Page 1 of 1 in this chapter)


tech_support@nmss.com
Copyright © 1998, Natural MicroSystems, Inc. All rights reserved.