BfvLineDumpStructure, Dump History | Dialogic 6.2 specs

BfvLineDumpStructure

BfvLineDumpStructure

The BfvLineDumpStructure function (Volume 1, Bfv API Reference Manual) dumps the contents of the BTLINE structure into a file. It writes each element of the line structure individually.

Use this call to create error report logs (along with the contents of Dump History) and to track changing states of the line.

Dump History

Dump History (dh) is a stand-alone utility, which displays to the screen a log of the interactions between the driver and channels, modules, and applications. The size is specified at driver configuration time. The default is a buffer size of approximately 1MB for the entire driver.

To use the Dump History utility, you must enable the debug option during installation of the driver. See Chapter 1, Manually Configuring the Driver on Windows® in your installation and configuration guide for instructions on how to enable the debug option. Once enabled, driver operations are automatically logged with a time stamp in a circular buffer.

Using dump history, in any form, can have effect on the system. Enabling history at all, regardless of the configured size, slows the operation of the driver down to a small degree. If the history size is set to a very large value (e.g., a number of megabytes), then actually getting the history slows the system down in ways that affects any other Bfv API applications running.

This is because of several factors:

The driver requires time to copy history memory. All other standard driver operations are temporarily suspended.

The history functions require time to parse the history memory into readable form.

High disk load while writing the many megabytes of history data in a short time.

November 2009

93

Image 93

Dialogic 6.2 manual BfvLineDumpStructure, Dump History

Contents

Dialogic Brooktrout Fax Products SDK Copyright and Legal Notice Hardware Limited Warranty Page Bfv API Reference Manual Volume Media Processing Bfv API Reference Manual Volumes 1 Contents Contents Developing Applications Using the Bfv API Debugging Contents 176 214 Robbed Bit Signaling Isdn Call Processing and Management Packaging Your Application for Windows Glossary Index Introduction About this Publication Related Documents Operating System SupportManual Conventions Cd /Brooktrout/boston/bfv.api Terminology Updated Terminology Dialogic Brooktrout TR1034 Fax Board Terminology Getting Technical Support Introduction to the Dialogic Brooktrout Bfv API Bfv API and Associated Libraries Bfv API and Associated Libraries Bfv Application Configuration Bfv API and Associated Libraries Bfv API Functions Bfv API Functions Administration and Initialization Functions Macros Administration, Management, and Configuration Btline Structure Function Line State Channel Numbering Firmware Functions and Macros Configuration Functions Configuration Files Debugging, Error Handling, and Return Values Module Status and Monitoring FunctionsFunctions Callres Structures and Return Values Miscellaneous Functions and Macros Call Control Bfv Call ControlBSMI-Level Call Control Bfv API Functions Media Processing Signal Generation and Tone Detection Voice Record and Play Fax Functions Type/Level Function Names Fax Functions by Type Infopkts File Format Manipulation Functions Bfv API Functions Tag Infopkts Indirect Infopkts Data Infopkts INFOPKTUSER0USER1....USER9 Infopkt Stream Creating an Infopkt StreamMkinfopk -o outputfname infopkttype arg Embedded speech file Simple Speech File Mkinfopk Indexed Prompt File MkpromptIndex to prompt file Smp rate, coding fmt, bits Smp, afe rate, data fmt Mkinfopk -o fax.ips doc 1 ascii fax.c BOP Optional/conditional Speech Infopkt Parameters Infopkt Structure Fax Infopkt Parameters Strip parameters infopkts Conversion of a Partial Infopkt Stream to a Fax Document This two-page document contains a G3 fax document as a cover API Developing a Voice Application Recording and Playing VoiceDeveloping a Voice Application Arguments Recording Voice Using Prompt Files Using Prompt FilesPlaying Back the Voice Message Creating a New Prompt File Using the mkprompt Utility Updating an Existing Prompt File Developing a Fax ApplicationSending and Receiving a Fax Developing a Fax Application Fax -u 0 -s wphonenum fax.ips Sending a Fax from One Channel to Another Sending a Fax to a Channel from an External Fax Machine Using High- and Low-Level Functions Using Bfv API Fax Functions Transmits documents based on an infopkt stream Opens the infopkt-formatted file called name for writing Enables the call progress function Finishes up when the infopkt stream is exhausted Waits for the detection of an incoming call Attaches to a free channel and gets a line pointer Sets the G3 strip parameters for the G3 strip ltrhd.g3 Sets the G3 strip parameters for the G3 strip sig.G3 Attaches to a free channel and gets a Btline pointer Call this function when there are no more pages to receive Opens the TIFF-F file name for reading and transmission Sending a Fax Using Calls for TIFF-F Files Opens the TIFF-F file name to store the received fax Receiving a Fax Using Calls for TIFF-F Files Closes the Tiff file after the file is received Receiving and Storing a Fax in MMR or MR Format Argsfax.fmt = Fmtmmralignmsb BfvFaxSetReceiveFmtlp,&argsfax Waits for the remote end to send its ID and capabilities Sending a Noninfopkt-Formatted Fax Stored in MMR Format BTZEROargsstrip BTZEROargsinfopkt Accessing an Infopkt Stream from an Application Sending a TIFF-F Fax File Within an Infopkt Stream Combining Data on a Single Page Using TIFF-F Fax Files Developing a Fax Application Set up call prior */ BTZEROargstiff Unsigned char buf1024 int n Accessing a TIFF-F File from an Application If n = BfvTiffReadImage&argstiff = 0 break Processimagebuf,n Determining Fax Status Information from an Application Developing a Fax Application Debugging Bfv API Debug Mode Bfv API Debug ModeBfvDataFSK BfvLineDumpStructure Dump HistoryBfvLineDumpStructure Dump History Invoking Dump History Most recent application corresponding Interpreting the Output L1A 01 Admin 08 Event 06 Flowcontrolstatus Status Header Line Event Logging LinesEvent Logging Line Format Parsed Command Information Parsed Command InformationTiming Information Event Descriptions Parsed Command Information Utility Programs for Debugging Bsmi Debugging Command SyntaxBsmi Message Tracing Running a Layer 2 Trace November 102 Level 2 Trace Example Trace Report Values Value MeaningNovember 103 Understanding Trace Hexadecimal Strings Interpreting the I Frame HeaderNovember 104 Bits Byte Interpreting the Message HeaderBits General I Frame November 106 Hex Interpreting Information Elements Hex MessageNovember 107 IE Formats 931 Information Element Identifiers Hex Information ElementNovember 108 November 109 November 110 Vtty Tracing Feature Vtty Commands Vtty Console CommandsCommand Meaning November 111 Vtty Tracer GUI Setting Output Options¾ To start the Vtty Tracer, enter November 112 Connecting to a Module ¾ Use the File menu to connect to a moduleNovember 113 November 114 Using the Trace Menu November 115 Using the Memory Menu Using the Show Menu Show Menu Information About OptionsNovember 116 November 117 Vtty Trace Results Call Tracer Call TracerNovember 118 Arguments Command SyntaxBrktcctrace -x 10 -n 5 -oc\Brooktrout\brktlogxxx.txt November 119 November 120 Configuration File Format November 121 November 122 November 123 # OFF November 124 November 125 Page November 127 Boardmon Boardmon -m mod -s span -d -v -h BoardmonNovember 128 Sample boardmon Output BtverBtver November 129 Btver -m mod ConnlistConnlist -m mod Connlist Csend CsendNovember 131 Deact DeactNovember 132 November 133 Debugcontrol DebugcontrolNovember 134 Example DecodeDecode -f filename Decode filename.ips Divert DfaxDfax November 136 Dlfax DlfaxNovember 137 Dlfax -l Dlfax options infopkt file DstripDstrip -o outputbasedcxfilename Dstrip Eccllvoice EccllvoiceNovember 139 Eccllvoice options infopktfile FaxFax November 140 Fax options infopktfile FaxhlFaxhl options infopktfile Faxhl Faxll FaxllNovember 142 November 143 F1 f2 -a f3 -b -g f4 FaxmlFaxml November 144 Faxpml FaxpFaxp options Faxp Feature -m mod action FeatureFaxpml options Actions November 147 Firm -m mod -c confspec -t type firmwarefile FirmFirm November 148 Firmload -c confspec -d -b 01-q -e firmwaredir modulenum FirmloadFirmload November 149 Firmware Type Filename FontFirmload Brooktrout/boston/fw Font -m mod -q -d Ipstrip -h -o outputbase filename IpstripIpstrip November 151 Mkdcx IvrIvr options Mkdcx -o dcxfile pcxfilename Mkinfopk -o outputfname -i inputfname Infopkttype arg MkinfopkMkinfopk November 153 November 154 Tag type Mktiff MkpromptMktiff -o tifffile g3filename Mkprompt Modinfo -p -c -s -h -H -a mod ModinfoArgument Modinfo Rtp PlaypPlayp -u unit promptfile phrasenum Rtp -u unitno -v or Rtp -a Telreset ShoparamArguments Telsave Telreset -m modTelsave -m mod -v -s Telsave Tiffdump TfaxTiffdump -d tifffilename Tfax Transfer TonesTones options Tones Transfer options phonenum TransferNovember 162 Examples TransferllTransfer.exe -u 0 -m 1 -t bstdialcomplete w110 Transfer.exe -u 0 -m 1 -t bstalerting w110 November 164 Transfer Transferll Trombone TromboneNovember 165 Root@RedHat9 bapp.src$ make others TstripTrombone options Tstrip Tstrip -h -o outputbase -r tifffilename VoiceVoice November 167 November 168 Voice options infopktfile Voiceraw VoicerawNovember 169 Wave WaveNovember 170 November 171 Name November 172 Using Brooktrout Files File Naming ConventionsNovember 173 Compiling Sample Applications Using Makefiles Compiling Sample Applications Using Makefiles¾ To compile the sample applications November 174 Combining the Sample Applications Compatibility for CompilingNovember 175 November 176 Transferring Calls Making Call Transfers Using Bfv Making Call Transfers Using BfvNovember 177 November 178 High-level Call Transfer using Bfv November 179 Low-level Call Transfer using Bfv Making Hookflash Transfers Using Bfv ApplicationsMaking Hookflash Transfers November 180 November 181 Using Bsmi Applications Making Two B-Channel Transfers Making Two B-Channel TransfersNovember 182 November 183 Supplementary Services Support Making Call Transfers Using QsigMaking Call Transfers Using Qsig November 184 BFfvCallWaitForDivert, and BfvLineDivert. Once the call Enablecalldiversion flagBfvCallReject followed by BfvCallWaitForRelease BfvLineTransferCapabilityQuery. However you must connect November 186 Bfv APIs Associated with Qsig Making Call Transfers Using Active Redirection Japan Making Call Transfers Using Active Redirection JapanNovember 187 Making Explicit Call Transfers ECT With E1 Isdn and BRI Making Explicit Call Transfers ECT With E1 Isdn and BRINovember 188 November 189 Making Two-Channel Call Transfers Tromboning Making Two-Channel Call Transfers TromboningNovember 190 Setting up the Two-Channel Call Transfer Connecting ResourcesNovember 191 November 192 Making Two-Channel Call Transfers Tromboning Out TSlot November 193 Connections for a Two-Channel Call Transfer Performing Echo Cancellation Actions During a Two-Channel Call TransferNovember 194 November 195 November 196 Required Connections for Echo Cancellation Playing Back Voice Recordings Person BNovember 197 November 198 Channel InOut Silence TSlot November 199 Terminating the Two-Channel Call Transfer November 200 Disconnecting Resources November 201 Transferring Calls Using Release Link Trunk Transfer Transferring Calls Using Release Link Trunk TransferNovember 202 November 203 L4L3CALLREQUEST Non-RLT Call Transfer Call Control Sequence DiagramsNetwork Host November 204 November 205 RLT Call Transfer November 206 November 207 Sample Application November 208 L4L3cntlp L4toL3struct Msg L4L3cntlp = &msg November 209 Placing Calls on Hold Using Bsmi Placing Calls on Hold Using BsmiCall Hold Values for L4L3mUNIVERSAL messages November 210 November 211 = Mtdlretrieverej Placing Calls on Hold Using Bsmi November 212 Page November 214 Managing Fax and Voice over IP Sessions Managing Calls Using IP Telephony Managing Calls Using IP TelephonyNovember 215 November 216 Adding IP Call Control using the Bfv API November 217 Outgoing IP Calls November 218 Incoming IP Calls Understanding SIP Functionality Using a SIP Proxy ServerVerifying Dialed Strings November 219 November 220 November 221 ¾ initiates the following sequence of events November 222 Sample Invite Request November 223 SIP Invite November 224 Mapping of SIP responses to Bfv FCP values Call Progress ValuesBfv final call Progress code Response Code November 225 November 226 Understanding H.323 Functionality November 227 Using H.323 Address Forms November 228 Phone Number November 229 Overview Failover Based on Telephony Cause CodesCommon Failures Failover Based on Telephony Cause Codes November 231 Failover Scenarios Failover Cause Codes DescriptionNovember 232 SIP Known Failures From Various GatewaysKnown Failover Cause Code Data November 233 November 234 SIP November 235 SIP to Q.931 Conversion SIP to Q.931 Conversion SIP Cause DescriptionNovember 236 November 237 SIP Cause Description Processing Media Using the T.38 Protocol Processing Media Using the T.38 ProtocolNovember 238 November 239 November 240 November 241 Sending and Receiving Faxes Configuring T.38, RTP and IP Call Control Activities Configuring T.38, RTP and IP Call Control ActivitiesNovember 242 Troubleshooting TroubleshootingNovember 243 Introduction to the SIP Protocol Understanding the SIP ProtocolUnderstanding the SIP Protocol November 244 November 245 Overview of SIP Functionality November 246 November 247 Overview of Operation November 248 SIP Session Setup Example With Sip Trapezoid November 249 Via November 250 Contact November 251 November 252 November 253 November 254 November 255 Using Third Party IP Stacks Using Third Party IP StacksNovember 256 November 257 Integrating Bfv IP Fax November 258 Components Disable ECC Component ConfigurationSR140 Software-Based Integration Linux November 259 November 260 TR1034 Board-Based Integration Linux Call Negotiation Inbound CallNovember 261 November 262 Inbound SIP Sequence November 263 Outbound Call November 264 General Information November 265 General Information November 266 November 267 November 268 Timer Definitions Timer Robbed Bit Signaling TimersDefinition Default Value November 269 November 270 November 271 November 272 Granularity Definition Default Value November 273 November 274 November 275 Timing Diagrams Wink Start & Delay Dial Signaling Wink Start & Delay Dial SignalingNovember 276 November 277 Incoming Call Processing November 278 Wink Start and Delay Dial Incoming Call Timing Outgoing Call Processing Call Teardown ProcessingNovember 279 November 280 Wink Start and Delay Dial Outgoing Call Timing Wink Start with Feature Group B & D Wink Start with Feature Group B & DNovember 281 Iisdn SMI Messages November 282 November 283 Revised 20-Oct-03 Rev1.4 November 284 Immediate Start/Fixed Pause Signaling Immediate Start/Fixed Pause SignalingIncoming Call Processing Immediate Start November 285 Timing Diagram Start/Fixed Pause SignalingImmediate 286 November 287 Outgoing Call Processing Fixed Pause Mode November 288 Fixed Pause Outgoing Call Timing Diagram Ground Start Signaling Ground Start SignalingFXO Ground Start Incoming Call Processing November 290 November 291 FXO Ground Start Incoming Call Timing Diagram Outgoing Call Processing Call Teardown ProcessingNovember 292 November 293 FXO Ground Start Outgoing Call Timing Diagram November 294 FXO Ground Start Incoming Clear Timing Diagram November 295 FXO Ground Start Outgoing Clear Timing Diagram November 296 FXS Ground Start November 297 FXS Ground Start Incoming Call Timing Diagram November 298 November 299 FXS Ground Start Outgoing Call Timing Diagram November 300 FXS Ground Start Incoming Clear Timing Diagram November 301 FXS Ground Start Outgoing Clear Timing Diagram Loop Start Signaling Loop Start SignalingNovember 302 November 303 FXO Loop Start November 304 November 305 FXO Loop Start Incoming Call Timing Diagram November 306 FXO Loop Start Outgoing Call Timing Diagram November 307 FXO Loop Start Outgoing Clear Timing Diagram November 308 FXO Loop Start Incoming Clear Timing Diagram November 309 FXS Loop Start November 310 November 311 FXS Loop Start Incoming Call Timing Diagram November 312 FXS Loop Start Outgoing Call Timing Diagram November 313 FXS Loop Start Outgoing Clear Timing Diagram November 314 Non-FXO/FXS RBS Protocols Incoming Clear Timing Diagram November 315 Non-FXO/FXS RBS Protocols Outgoing Clear Timing Diagram November 316 Isdn Call Processing and Management November 317 Making an Isdn Incoming Call Isdn Call Processing OverviewIsdn Call Processing Overview November 318 November 319 L43.data.enable November 320 Isdn Incoming Call November 321 Making an Isdn Outgoing Call November 322 Isdn Outgoing Call Isdn Call Clearing Initiated by Module Isdn Overlapped DialingNovember 323 November 324 Isdn Call Clearing Initiated by Module November 325 Isdn Call Clearing Initiated by Network November 326 Isdn Call Clearing Initiated by Network Translating Q.931 to Simple Message Interface Translating Q.931 to Simple Message InterfaceNovember 327 What is Overlap Receive? Using the overlaprcv feature L4L3mENABLEPROTOCOLUsing the overlaprcv feature of L4L3mENABLEPROTOCOL November 328 November 329 Bsmi Reference Notes November 330 Network Brooktrout Controller Host 921 Timers Level 2 Parameters Data Type Mnemonic Definition 921/Q.931 Timers921/Q.931 Timers November 332 931 Timers Level 3 Parameters 921 Timers Level 2 ParametersData Type Mnemonic Definition November 333 November 334 Page November 336 Using the Bsmi R2 Signaling Capability CPE Signaling Model CPE Signaling ModelNovember 337 November 338 Line Signaling Model State CAS Bits Outbound AB Inbound AB November 339 November 340 November 341 Inter-register Signaling Enabling the R2 Protocol Enabling the R2 ProtocolNovember 342 November 343 R2 Digital Line Signaling Parameters November 344 November 345 Protocol Control November 346 Dnis November 347 IISDNR2MFCPGROUPB Calledlineconditions IISDNR2MFSIGNALCODES Enumeration Protocol Parameter MechanicsNovember 348 Forward Channel IISDNR2MFCFORWARDACTIONSNovember 349 November 350 Backward Channel November 351 IISDNR2MFCPGROUPBCALLEDLINE Conditions Enumeration November 352 IISDNR2MFCPBACKWARDACTIONS Name Description Valid State November 353 Iisdncpgenmfparams November 354 November 355 R2 Call Control November 356 Outbound Call Setup November 357 L4L3mCALLREQUEST L3L4mALERTING Host L3L4mCONNECT November 358 L4L3mCALLREQUEST Host L3L4mCLEARREQUEST November 359 Inbound Call Setup L4L3mCONNECTREQUEST L3L4mCONNACKIND L3L4mPRESEIZE L3L4mSETUPINDL4L3mCLEARREQUEST L3L4mCLEARREQUEST November 360 Call Tear Down L3L4mDISCONNECT L4L3mCLEARREQUEST Host L3L4mCLEARREQUESTNovember 361 November 362 L4L3mCLEARREQUEST Host L3L4mCLEARREQUEST Channel Blocking L4L3mCASCHANBLOCK L3L4mCASCHANBLOCKEDNovember 363 November 364 Packaging Your Application for Windows November 365 Windows Server 64 bit Package Options Package OptionsNovember 366 Installing Modules InstallationInstalling Virtual Modules SR140 Installation Installing the Brooktrout SDK Installing SoftwareOptions for Spawning MSI November 368 November 369 Brooktrout Fax Software System Files November 370 November 371 Install Location File Name Purpose November 372 Registry Entries Name ValueNovember 373 Shortcuts Reboot OptionsName Location November 374 November 375 Installation Configurable Brooktrout SDK Installation Options About the Merge Module FeatureDynamically Linked DLLs dynamicdlls.msm November 376 Dynamically Linked 64-bit DLLs Dynamicdllsx64.msmNovember 377 Configuration and Protocol Files configdata.msm File NamesNovember 378 November 379 Firmware firmware.msm Shortcut Name Target Configuration Tool configtool.msm¾ Depends on the following modules November 380 November 381 TECUpdate TECUpdate.msm November 382 License Manager softwarelicense.msm November 383 Utility Programs utilities.msm File File Name Default Location Number Boston Host Service bostsrv.msmService Name Default Start Mode November 384 Installing the Merge Module Feature Integrating the ModulesNovember 385 November 386 „ dynamicdllsx64.msm independent modules November 387 Case November 388 Merging Modules into a Single Feature November 389 Merging Modules into Multiple Features About Plug and Play Components About Plug and Play ComponentsNovember 390 November 391 Brooktrout Plug and Play Components Plug and Play Installation ScenariosReference Brooktrout Component November 392 User places November 393 November 394 Structure of the Brooktrout PnP Folder About the INF FileNovember 395 About the Dialogic Brooktrout Plug and Play Co-Installer Class = Computer Telephony Class GuidNovember 396 When Should You Launch the Configuration Tool Should You Launch the Configuration ToolDisplaying the Found New Hardware November 397 November 398 About the Device Property November 399 Modifying Configuration Files Modifying Configuration FilesNovember 400 User-Defined Configuration File btcall.cfg Parameter DescriptionNovember 401 Call Control callctrl.cfg Configuration File Including the Brooktrout Configuration ToolIncluding the Brooktrout Configuration Tool November 402 Downloading Firmware Files Downloading Firmware FilesNovember 403 Removing Software Removing SoftwareNovember 404 For Earlier Versions Prior to Removing the Plug and Play Driver¾ To remove an earlier version of the Plug and Play driver Expand the Brooktrout Hardware node For Version ¾ To remove the Plug and Play driverNovember 406 November 407 For 64-bit operating system November 408 Appendix a November 409 Utility Cut and Paste Utilities Asctog3 argument-list Where Ascii to Fax Conversion Utility asctog3Asctog3 -imemo.txt -fibmpcps.fnt Ascii to Fax Conversion Utility asctog3 Cut Utility g3chop Cut and Paste UtilitiesG3chop -sx -cy -ifile1.301 -ofile2.301 Where G3chop -s5 -c20 -isalute.301 -oadvert.301 G3combin file1.301 file2.301 file3.301 -l -s -pad Paste Utility g3combinG3combin -1 lethd.301 sign.301 busrpt.301 November 412 Epstog3 argument-list Where Epson to Fax Conversion Utility epstog3Epson to Fax Conversion Utility epstog3 November 413 November 414 Epstog3 -icap001.epc Ss-rhceveava-xs#-ys#-x#-y#-w#-m# -ifilename Fax Display and Edit Utility Supershow ssFax Display and Edit Utility Supershow ss November 415 November 416 Ss -rv -iletsig.301 G3cvt ifmt ifile ofmt ofile options G3 Conversion Utility g3cvtG3 Conversion Utility g3cvt November 417 November 418 G3cvt MMR fax.mmr MH fax.mh Print Utility p Print Utility pNovember 419 November 420 Phsd -xs10 -ys10 -idemo.301Page November 422 Appendix B November 423 Make -f makefile.kerndep November 424 For Red Hat Linux releases ES/AS 4.0 and laterPage External-Telephony ChannelMode Facility Line LapdidLogical channel number Millennium Address T1/E1 span StreamTime slot Unit numberPage 430 Index November 431 Bsmi API November 432 November 433 November 434 L4L3CALLREQUEST November 435 November 436 Call Proceeding 318, 321 Connect November 437 SIP November 438 November 439 November 440