L3P PSTN (0x0091) Atomic Functions

You are here: PPL Developer’s Guide > 7 ISDN Atomic Functions > L3P PSTN (0x0091) Atomic Functions

This section describes the atomic functions for the L3P PSTN PPL component.

L3P PSTN Atomic Functions

The following atomic functions are specific to the ISDN L3P PSTN PPL component.

AF Number	51
Name	Send L3 ESTABLISH Request using L3 Outgoing Buffer
Description	This function sends an Establish Request to Layer 3
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	52
Name	Send L3 ESTABLISH Acknowledge Request using L3 Outgoing Buffer
Description	This function sends an Establish Acknowledge Request to Layer 3
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	53
Name	Send L3 SIGNAL Request using L3 Outgoing Buffer
Description	This function sends a Signal message to Layer 3
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	54
Name	Send L3 STATUS Request using L3 Outgoing Buffer
Description	This function sends a Status message to Layer 3
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	56
Name	Send L3 DISCONNECT Request using L3 Outgoing Buffer
Description	This function sends a Disconnect message to Layer 3
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	57
Name	Send L3 DISCONNECT COMPLETE Request using L3 Outgoing Buffer
Description	This function sends a Disconnect Complete Request to Layer 3
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	58
Name	Send L3 PROTOCOL PARAMETER Request using L3 Outgoing Buffer
Description	This function sends a Protocol Parameter Request to Layer 3
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	59
Name	Send L3 signal messages with stored called party digits from L4
Description	Sends signal messages to L3, each with a digit signal IE from called party digits from L4
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	60
Name	Send L4 SETUP Indication (Formatted IEs ICB) using L4 Outgoing Buffer
Description	This function sends a SETUP Indication to L4
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	61
Name	Send L4 ALERTING Indication using L4 Outgoing Buffer
Description	This function sends a ALERTING Indication to L4
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	62
Name	Send L4 CONNECT Indication using L4 Outgoing Buffer
Description	This function sends a CONNECT Indication to L4
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	63
Name	Send L4 CUT Through Indication using L4 Outgoing Buffer
Description	This function sends a Cut Through Indication to L4
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	64
Name	Send L4 PROGRESS Indication using L4 Outgoing Buffer
Description	This function sends a Progress Indication to L4
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	65
Name	Send L4 DISCONNECT Indication using L4 Outgoing Buffer
Description	This function sends a Disconnect Indication to L4
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	66
Name	Send L4 CLEAR Request using L4 Outgoing Buffer
Description	This function sends a Clear Request message to L4
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	67
Name	Send Access Denied message with call control flag
Description	Outseize Nack and Clear indication will be sent from L4
Arg1	Mentions Status
Arg2	Mentions More Status in the event Arg1 value is 0x51
Returns	Success or Failure

AF Number	69
Name	Send L4 PURGE Indication using L4 Outgoing Buffer
Description	This function sends a Purge Indication to L4
Arg1	Purge Reason
Arg2	<Not Used>
Returns	Success or Failure

AF Number	70
Name	Send L4 Outseize Acknowledge Indication using L4 Outgoing Buffer
Description	This function sends an L4 Outseize Acknowledge Indication to L4
Arg1	Status
Arg2	<Not Used>
Returns	Success or Failure

AF Number	71
Name	Send L4 Channel Status message
Description	Sends a Channel Status message to L4
Arg1	Status (0 = Out of Service/1 = In Service)
Arg2	<Not Used>
Returns	Success or Failure

AF Number	73
Name	Send L4 RTR Route Control Acknowledge <status>
Description	Sends a Route Control Acknowledge to L4 Router Status given in Arg1
Arg1	Status
Arg2	<Not Used>
Returns	Success or Failure

AF Number	74
Name	Send L4 RTR Route Control Reject <status>
Description	Sends a Route Control Reject to L4 Router
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	75
Name	Send BCC Channel Request
Description	This function sends a Channel (timeslot) Request message to L3P BCC
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	76
Name	Send BCC Channel Remove
Description	This function sends a Channel (timeslot) Remove message to L3P BCC
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	77
Name	Send BCC Channel Indication
Description	This function sends a Channel (timeslot) Indication message to L3P BCC
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	78
Name	Send BCC Channel Error Indication
Description	This function sends an Channel Error Indication message to L3P BCC
Arg1	Error Code
Arg2	<Not Used>
Returns	Success or Failure

AF Number	79
Name	Send BCC Deferred Blocking Complete
Description	This function sends a Deferred Blocking Complete message to L3P BCC
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	80
Name	Send PPL Event Indication to L5 <Event>
Description	Sends a PPL Event to L5
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	81
Name	Send PPL Event Request Acknowledge to L5 <Status>
Description	Sends a PPL Event Request Acknowledge to L5 Status given in Arg1
Arg1	Status
Arg2	<Not Used>
Returns	Success or Failure

AF Number	85
Name	Send BCC Channel Request to already active Cb
Description	Sends a Channel Request for already active Cb to BCC
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	86
Name	Send BCC Channel Remove Forced
Description	Sends a Channel Remove to BCC not expecting ACK
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	90
Name	Clear L3 outgoing buffer
Description	This function will clean up the L3 outgoing buffer
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	97
Name	Store Called Party IE Digits
Description	Stores digits in the called party IE from L4 in the digit array for this Cb
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	98
Name	Store the Call Control Flag from L4
Description	Stores the call control flag from L4 for this Cb. This flag determines the type of Acknowledge to send, and where to send it (L4/L5)
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	99
Name	Mark as Outgoing Call
Description	Set the Outgoing Call Flag for this call to TRUE
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	100
Name	Transfer Data from L3 incoming to L4 outgoing buffer
Description	This function will move/copy the L3 incoming buffer to the L4 outgoing buffer
Arg1	Move (0) or Copy (1)
Arg2	<Not Used>
Returns	Success or Failure

AF Number	101
Name	Transfer Data from L4 incoming to L3 outgoing buffer
Description	This function will move/copy the L4 incoming buffer to the L3 outgoing buffer
Arg1	Move (0) or Copy (1)
Arg2	<Not Used>
Returns	Success or Failure

AF Number	102
Name	Store L4 outgoing buffer
Description	This function stores the L4 outgoing buffer in temporary buffer to make outgoing buffer available
Arg1	Move (0) or Copy (1)
Arg2	<Not Used>
Returns	Success or Failure

AF Number	103
AF Name	Restore the saved L4 outgoing buffer
AF Description	This function restores the L4 outgoing buffer that was stored in temporary buffer.
Arg1	Move (0) or Copy (1)
Arg2	<Not Used>
Returns	Success or Failure

AF Number	113
Name	Load Pulse -Signal IE in L3 outgoing buffer
Description	Load the pulse-signal IE in the L3 outgoing buffer The Pulse Type is stored in the configuration byte given in Arg1 The number of pulses are given in Arg2
Arg1	Configuration byte storing the Pulse Type
Arg2	Number of Pulses
Returns	Success or Failure

AF Number	114
Name	Load Steady Signal IE in L3 outgoing <steady signal type>
Description	This function will load the Steady signal IE with the specified steady signal type in the L3 outgoing buffer
Arg1	Pulse Type
Arg2	Number of Pulses
Returns	Success or Failure

AF Number	115
Name	Load Pulsed Signal IE in L3 outgoing
Description	This function will load the Steady signal IE with the specified steady signal type in the L3 outgoing buffer
Arg1	Pulse Type
Arg2	Number of Pulses
Returns	Success or Failure

AF Number	116
Name	Test if Pulse Type in Pulse-Signal IE in L3 incoming buffer matches value of configuration byte
Description	Test to see if the Pulse Type in Pulse-Signal IE in L3 incoming buffer matches value of configuration byte
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	119
Name	Test Steady-Signal Type in Steady Signal IE in L4 incoming buffer
Description	Tests steady-signal type in the steady signal IE in L4 incoming message
Arg1	Steady Signal Type
Arg2	<Not Used>
Outputs	PPL Event INT Event 1 if the Steady-Signal Type matches, PPL Event INT Event 0 if the Steady-Signal Type does not match
Returns	Success or Failure

AF Number	120
Name	Validate L4 message <msg event>
Description	Validates the message from L4 to L3P PSTN
Arg1	PPL Event Number that corresponds to the message from L4
Arg2	<Not Used>
Outputs	PPL Event INT Event 1 if the message is valid, PPL Event INT Event 0 if the message is invalid
Returns	Success or Failure

AF Number	121
Name	Test if IE exists in L3 incoming message < IE type>
Description	This function checks whether the IE specified with IE type is present in L3 incoming message
Arg1	<Not Used>
Arg2	<Not Used>
Outputs	PPL Event INT Event 1 if the IE exists, PPL Event INT Event 0 if the IE does not exist
Returns	Success or Failure

AF Number	122
Name	Test if IE exists in L4 incoming message < IE type>
Description	This function checks whether the IE specified with IE type is present in L4 incoming message
Arg1	<Not Used>
Arg2	<Not Used>
Outputs	PPL Event INT Event 1 if the IE exists, PPL Event INT Event 0 if the IE does not exist
Returns	Success or Failure

AF Number	123
Name	Test Steady-Signal Type in Steady Signal IE in L3 incoming buffer
Description	This function tests the steady-signal type in the steady signal IE in L3 incoming message
Arg1	Steady Signal Type
Arg2	<Not Used>
Outputs	PPL Event INT Event 1 if the Steady-Signal Type matches, PPL Event INT Event 0 if the Steady-Signal Type does not match
Returns	Success or Failure

AF Number	124
Name	Test if timeslot value is received from BCC
Description	This function tests the flag in V5 PSTN SP RW that indicates whether the Channel Request Acknowledge message has been received from BCC
Arg1	<Not Used>
Arg2	<Not Used>
Outputs	PPL Event INT Event 0 + value of Timeslot received from BCC in V5 PSTN SP RW
Returns	Success or Failure

AF Number	125
Name	Test the Error code TLV from BCC
Description	This function tests the error code value in the Error Code TLV in the message from BCC
Arg1	<Not Used>
Arg2	<Not Used>
Outputs	PPL Event INT Event 0 + Value of error code
Returns	Success or Failure

AF Number	126
Name	Test for termination character in L3 Digit Info
Description	This function tests if a termination character is present in the L3 Digit Info in the message from L3
Arg1	<Not Used>
Arg2	<Not Used>
Outputs	PPL Event INT Event 1 if termination character exists, PPL Event INT Event 0 if it does not exist
Returns	Success or Failure

AF Number	127
Name	Test the Status Event in the Status Indication message from L3
Description	This function tests value of the status event in the Status Indication message from L3
Arg1	<Not Used>
Arg2	<Not Used>
Outputs	PPL Event INT Event 0 + Value of status event
Returns	Success or Failure

AF Number	128
Name	Test if waiting for deferred blocking
Description	This function tests the flag in V5 PSTN SP RW that indicates whether the user port should be blocked after the call on this user port is released.
Arg1	<Not Used>
Arg2	<Not Used>
Outputs	PPL Event INT Event 1 if Deferred Blocking in flag set
Returns	Success or Failure

AF Number	129
Name	Test if Outgoing Call
Description	Outputs PPL Event INT Event 1 if Outgoing Call; Outputs PPL Event INT Event 0 if Incoming Call
Arg1	<Not Used>
Arg2	<Not Used>
Outputs	PPL Event INT Event 1 if Deferred Blocking in flag set
Returns	Success or Failure

AF Number	130
Name	Load stored digit info into L4 outgoing buffer
Description	Loads the stored digit information into the L4 outgoing buffer
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	131
Name	Set the deferred blocking enable flag
Description	Sets the deferred blocking enable flag for this PSTN Cb
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	132
Name	Update timeslot value from BCC
Description	This function updates the timeslot value in the PSTN CB from the value given in the BCC incoming message
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	133
Name	Set flag indicating timeslot is received from BCC
Description	This function sets the flag that indicates whether a valid timeslot value has been received from BCC
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	134
Name	Store the Digit Info from L3 incoming buffer
Description	This function stores the digit info (digits etc.) that were received in the L3 incoming buffer
Arg1	<Event #>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	135
Name	Check if LE side
Description	Tests config for this V5 ID to determine if LE side
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure

AF Number	147
Name	Test the reject Cause in incoming message from BCC
Description	To test the reject cause sent in channel request reject and the channel indication reject mesages from incoming from the BCC protocol; the function will return appropriate status code to the host
Arg1	<Not Used>
Arg2	<Not Used>
Returns	Success or Failure