dt_xmitalrm( )

Description | Cautions | Example | Errors | See Also

Name:	int dt_xmitalrm(devh, alrmtype, state)
Inputs:	int devh	Digital Network Interface logical board device handle
	unsigned char alrmtype	T-1 or E-1 alarm type
	unsigned int state	enable or disable sending the alarm
Returns:	0 on success -1 on failure
Includes:	srllib.h dtilib.h
Category:	Alarm
Mode:	synchronous

Description

The dt_xmitalrm( ) function starts and stops transmission of an alarm to a network span. For a detailed description of T-1 and E-1 alarm handling, refer to Chapter 3. Digital Telephony Overview.

Parameter	Description
devh:	Specifies the valid Digital Network Interface logical board device handle returned by a call to dt_open( )
alrmtype:	Specifies the T-1 or E-1 alarm type to be transmitted
	YELLOW - T-1 only
	BLUE - T-1 only
	DEA_REMOTE - E-1 only
	DEA_UNFRAMED1 (unframed all 1s) - E-1 only
	DEA_SIGNALALL1 (signaling all 1s) - E-1 only
	DEA_DISTANTMF (distant multiframe alarm) - E-1 only
state:	Specifies whether to enable or disable transmission of the specified alarm:
	DTIS_DISABLE - disable transmission of alarm
	DTIS_ENABLE - enable transmission of alarm

Cautions

1. This function will fail under the following conditions:
   • The specified Digital Network Interface device is invalid
   • The specified alrmtype parameter is invalid
   • The specified state parameter is invalid
2. Transmission of alarms requires that the proper alarm mode is set by the dt_setalrm( ) function.
3. The alarm type transmitted must correspond to the type of network circuit you are using (either T-1 or E-1).

Example

#include <windows.h>      /* For Windows applications only */  
#include <srllib.h>  
#include <dtilib.h>  
#include <errno.h>  
main()  
{  
   int devh;              /* Board device handle */  
   /*  
    * Open board 1 device  
    */  
   if ( ( devh = dt_open( "dtiB1", 0 ) ) == -1 ) {  
      printf( "Cannot open board dtiB1.  errno = %d", errno );  
      exit( 1 );  
   }  
   /*  
    * Transmit a BLUE alarm  
    */  
   if ( dt_xmitalrm( devh, BLUE, DTIS_ENABLE ) == -1 ) {  
      printf( "Error message = %s.",ATDV_ERRMSGP( devh ) );  
      exit( 1 );  
   }  
              .  
              .  
              .  
}

Errors

If the function returns -1, use the SRL Standard Attribute function ATDV_LASTERR( ) to obtain the error code or use ATDV_ERRMSGP( ) to obtain a descriptive error message. See Appendix A - Standard Runtime Library for more information on SRL functions. The error codes returned by ATDV_LASTERR( ) are:

• EDT_BADBRDERR - Digital Network Interface missing or defective
• EDT_BADCMDERR - invalid or undefined command to driver
• EDT_DATTO - data reception timed out
• EDT_FWERR - firmware returned an error
• EDT_INVBD - invalid Digital Network Interface logical board device handle
• EDT_NOMEMERR - cannot map or allocate memory in driver
• EDT_PARAMERR - invalid parameter
• EDT_RANGEERR - bad/overlapping physical memory range
• EDT_SIZERR - message too big or too small
• EDT_SKIPRPLYERR - a required reply was skipped
• EDT_SYSTEM - system error. Check the global variable errno for more information about the error.
• EDT_TMOERR - timed out waiting for reply from firmware

Error defines can be found in the file dtilib.h.

See Also

• dt_setalrm( )

Click here to contact Dialogic Customer Engineering