dt_xmitwink( )

Description | Cautions | Example | Errors | See Also

Name:	int dt_xmitwink(devh, tmo)
Inputs:	int devh	Digital Network Interface logical time slot device handle
	unsigned int tmo	timeout value
Returns:	0 on success -1 on failure
Includes:	srllib.h dtilib.h
Category:	Time Slot Signaling
Mode:	synchronous/asynchronous

Description

The dt_xmitwink( ) function transmits wink signaling to the T-1 or E-1 network span on any of the available signaling bits. The bit to be used and the polarity or beginning state of the wink are configurable through the download parameter file (see the Installation Reference (for Linux or Windows for details). A wink starts by transmitting signaling state 0, then transmits signaling state 1, and returns to signaling state 0. The signaling bit selected must be in the proper state (state 0) when the dt_xmitwink( ) function is called. Also, the time slot must be in signaling insertion mode to transmit a wink.

Board parameters may be set through dt_setparm( ) to control pre-wink delay and transmit wink duration for all time slots simultaneously.

NOTE:

Separate board parameters are provided for setting minimum and maximum receive wink duration. These have no effect on wink transmission.

Parameter	Description
devh:	Specifies the valid Digital Network Interface logical time slot device handle returned by a call to dt_open( )
tmo:	Specifies the maximum amount of time in seconds that the function will block while awaiting a response from the Digital Network Interface

Asynchronous Mode

To operate this function in asynchronous (non-blocking) mode, specify 0 for tmo. This allows the application to continue processing while awaiting a completion event from the device. If event handling is set up properly for your application, DTEV_WINKCPLT is returned by the SRL sr_getevttype( ) function when the wink is successfully completed. See Appendix A - Standard Runtime Library for information on event handling.

Synchronous Mode

To run this function in synchronous (blocking) mode, set tmo to the length of time, in seconds, to await a return. If a response is not returned within tmo seconds, an error is returned. A suggested tmo setting for this function is 2.

Cautions

1. This function will fail under the following conditions:
   • The specified Digital Network Interface logical time slot device handle is invalid
   • The specified time slot is not in the correct signaling state (must begin in state 0)
   • Signaling insertion is not enabled for the specified time slot device
   • A T-1 system (e.g., D/240SC-T1 board) is configured for wink transmission using the C bit or D bit
   • An application attempts to change signaling mode or signaling bits while wink transmission is in progress
2. To use this function in asynchronous mode, you must use the SRL sr_enbhdlr( ) function to enable trapping of events and create an event handler to process the completion event returned by the device. The event can be detected by using the SRL event management functions. See Appendix A - Standard Runtime Library for more information on Digital Network Interface event management.

Example

#include <windows.h>      /* For Windows applications only */  
#include <srllib.h>  
#include <dtilib.h>  
#include <errno.h>  
main()  
{  
   int devh;              /* Time slot device handle */  
   /*  
    * Open time slot 1 on board 1  
    */  
   if ( ( devh = dt_open( "dtiB1T1", 0 ) ) == -1 ) {  
      printf( "Failed to open device dtiB1T1.  errno = %d\n", errno );  
      exit( 1 );  
   }  
   /*  
    * Set signaling bits to a known state  
    */  
   if ( dt_settsig ( devh, DTB_ABIT | DTB_BBIT, DTA_SUBMSK ) == -1 ) {  
      printf( "Error message = %s \n", ATDV_ERRMSGP( devh ) );  
      exit( 1 );  
   }  
   /*  
    * Set signaling mode to signaling insertion  
    */  
   if ( dt_setsigmod( devh, DTM_SIGINS ) == -1 ) {  
      printf( "Error message = %s.",ATDV_ERRMSGP( devh ) );  
      exit( 1 );  
   }  
    *  
    * Disable silence transmission  
    */  
   if ( dt_setidle( devh, DTIS_DISABLE) == -1 ) {  
      printf( "Error message = %s.",ATDV_ERRMSGP( devh ) );  
      exit( 1 );  
   }  
   /*  
    * Go offhook assuming that wink set to negative polarity on A bit  
    */  
   if ( dt_settssig( devh, DTB_ABIT, DTA_SETMSK ) == -1 ) {  
      printf( "Error message = %s.",ATDV_ERRMSGP( devh ) );  
      exit( 1 );  
   }  
   /*  
    * Transmit wink with 2 second timeout.  Note that this is the blocking  
    * (synchronous) mode  
    */  
   
if ( dt_xmitwink( devh, 2 ) == -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). 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_INVTS - invalid Digital Network Interface logical time slot device handle
• EDT_NOMEMERR - cannot map or allocate memory in driver
• EDT_PARAMERR - invalid parameter
• EDT_PDOFFHK - wink bit not in correct initial state
• EDT_RANGEERR - bad/overlapping physical memory range
• EDT_SIGINS - signaling insertion not enabled
• 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
• EDT_WKACT - already transmitting wink
• EDT_WKSIG - cannot disable insertion when transmitting wink

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

See Also

• dt_setparm( )
• dt_setsigmod( )
• dt_settssig( )

Click here to contact Dialogic Customer Engineering