DitsSetDebug - Enable/Disable Dits internal debugging.

Function

Enable/Disable Dits internal debugging.

Description

When enabled, Dits will output information at appropriate times to assist in debugging. See the flag argument for the logging modes available.

The argument is an integer which will be considered a mask of these flags.

You can also set debugging externally using the ditscmd -c option, with the name DEBUG or by setting the environment variable DITS_DEBUG to an appropriate value before starting the task.

Note that if a logging system is enabled (see DitsSetLogSys(3)) then logging is done by calling the logging system's logLogMsg routine with the level set to DITS_LOG_INTERNAL

Language

C

Call

(Void) = DitsSetDebug (flag,status)

Parameters

(">" input, "!" modified, "W" workspace, "<" output)

>flagIntMask of values. To turn logging off, specify DITS_LOG_OFF - zero, only. Otherwise, specify a mask of the flags listed below
!statusStatusType *Modified status.

Log flags

DITS_LOG_BASIC Basic logging of important events (Integer value 1)
DITS_LOG_IMPSYS Dump details of IMP System message. (Integer value 2)
DITS_LOG_IMPINIT Output details of calls to IMP (Integer value 4)
DITS_LOG_MON Output monitor message details (Integer value 8)
DITS_LOG_ACT Output action scheduling events. (Integer value 16)
DITS_LOG_DETAILS Log details of such things as message sizes. (Integer value 32)
DITS_LOG_BULK Log details of bulk data messages (Integer vaue 64)
DITS_LOG_LIBS Usable by DRAMA libraries to log their own details, such as DCPP transaction details. (Integer value 128)
DITS_LOG_IMPEVENTS Turn on IMP event logging (see IMP tasklog command for more info. When turned off or if this is on at task shutdown then the imp events log will be written to a file named after the task name and the file type .imp_log, otherwise you can use the IMP tasklog command to dump the log. (Integer value 256)
DITS_LOG_RXLPEXIT Log exit from DitsMsgReceive, including time tags. (Integer value 4096)
DITS_LOG_ALL Log everything available. (Integer value 65535)

Include files

DitsSys.h

External functions used

None

External values used

DitsTask

See Also

DitsLogMsg(3), DitsSetLogSys(3).

Prior requirements

DitsAppInit should have been called.

Support

Tony Farrell, AAO

Click here for the DRAMA home page and here for the AAO home page.

 For more information, contact tony.farrell@mq.edu.au