cc_RetrieveRej( )

Description | Cautions | Example | Errors | See Also

Name:	int cc_RetrieveRej(crn, cause)
Inputs:	CRN crn	call reference number
	int cause	standard ISDN Network cause/error code
Returns:	0 on success <0 on failure
Includes:	cclib.h
Category:	Hold and Retrieve
Mode:	synchronous
Technology:	BRI/2; BRI/SC; PRI (Q.SIG only)

Description

The cc_RetrieveRej( ) function allows the application to reject a request to retrieve a held call from remote equipment. The call must be in Hold state and the CCEV_RETRIEVECALL event must be received before this function is called.

Parameter	Description
crn:	The call reference number. Each call needs a CRN.
cause:	A standard ISDN Network cause/error code is returned indicating the reason the hold request was rejected. Possible causes include TEMPORARY_FAILURE (Cause 41), NETWORK_OUT_OF_ORDER (Cause 38), and NETWORK_CONGESTION (Cause 42). For a complete list of ISDN Network cause/error codes, see Section 7.2.2. Cause/Error Codes from the ISDN Network.

Cautions

• The cc_RetrieveRej( ) function can only be used after the call is in Hold state and after the CCEV_RETRIEVECALL event is received.
• The BRI protocols and the PRI Q.SIG protocol are the only protocols that allow the rejection of the retrieval of a call in the Hold state. The cc_RetrieveRej( ) function cannot be used in the PRI DPNSS protocol. If used in unsupported protocols, the cc_RetrieveRej( ) function call will pass but the retrieve from Hold request will not be rejected and the call will no longer be in the Hold state.
• Not all ISDN Network cause/error codes are universally supported across switch types. Before using a particular cause code, compare its validity with the appropriate switch vendor specifications.

Example

#include <windows.h>   /* For Windows applications only */  
#include <stdio.h>  
#include <errno.h>  
#include <srllib.h>  
#include <dtilib.h>  
#include <cclib.h>  
main()  
{  
     
   char *devname = "dtiB1T1";  
   LINEDEV ldev;  
   .  
   .  
   .  
   .  
     
   if ( cc_Open( &ldev, devname, 0 ) < 0 )   
   {  
      printf("Error opening device: errno = %d\n", errno);  
      exit(1);  
   }  
   if ( sr_enbhdlr( ldev,CCEV_HOLDCALL,HoldCallHdlr ) < 0 )  
   {  
           printf( "dtiEnable for HoldCallHdlr failed:  %s\n",  
                                ATDV_ERRMSGP( SRL_DEVICE ) );  
           return( 1 );  
   }  
   if ( sr_enbhdlr( ldev,CCEV_RETRIEVECALL,RetrieveCallHdlr ) < 0 )  
   {  
           printf( "dtiEnable for RetrieveCallHdlr failed:  %s\n",  
                                ATDV_ERRMSGP( SRL_DEVICE ) );  
           return( 1 );  
   }  
   .  
   .  
   .  
   .  
   while (1)  
   {  
      /* wait for network event */  
        sr_waitevt(-1);   
   }  
   cc_Close(ldev);  
          
}  
/***************************************************/  
/* HoldCallHdlr - accept the hold call request     */  
/***************************************************/  
int HoldCallHdlr( )  
{  
    CRN crn_buf;  
    LINEDEV ldev = sr_getevtdev();  
    int len = sr_getevtlen();  
    void *ev_datap = sr_getevtdatap();  
    cc_GetCRN(&crn_buf, ev_datap);   
          
    if ( cc_HoldAck( crn_buf ) < 0 )  
 procdevfail(ldev);  
                                     
    return( 0 );  
}  
/***********************************************************/  
/* RetrieveCallHdlr - Reject the retrieve call request     */  
/***********************************************************/  
int RetrieveCallHdlr( )  
{  
    CRN crn_buf;  
    LINEDEV ldev = sr_getevtdev();  
    int len = sr_getevtlen();  
    void *ev_datap = sr_getevtdatap();  
    cc_GetCRN(&crn_buf, ev_datap);   
          
    if ( cc_RetrieveRej( crn_buf, TEMPORARY_FAILURE ) < 0 )  
 procdevfail(ldev);  
                                     
    return( 0 );  
}  
int procdevfail(LINEDEV ldev)  
{  
        int reason;  
        char *msg;  
        reason = cc_CauseValue(ldev);  
        cc_ResultMsg(ldev,reason,&msg);  
        printf("reason = %x - %s\n",reason,msg);  
}

Errors

If the function returns a value < 0 to indicate failure, use the cc_CauseValue( ) function to retrieve the reason code for the failure. The cc_ResultMsg( ) function can be used to interpret the reason code. Error codes are defined in the files ccerr.h, isdnerr.h, and isdncmd.h.

Possible error codes from the cc_RetrieveRej( ) function include the following:

Error Code	Description
ERR_ISDN_FW | ISDN_BADSTATE	Cannot accept event in current state.
ERR_ISDN_LIB | E_ISNULL_PTR	Null pointer error

See Also

• cc_HoldCall( )
• cc_RetrieveAck( )
• cc_RetrieveCall( )

Click here to contact Dialogic Customer Engineering