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.

Yhe 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 appropiate 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

Call

(Void) = DitsSetDebug (flag,status)

Parameters

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

flag

Int

>	flag	Int	Mask of values. To turn logging off, specify `DITS_LOG_OFF` - zero, only. Otherwise, specify a mask of the following flags. `DITS_LOG_BASIC` (1) => Basic logging of important events `DITS_LOG_IMPSYS` (2) => Dump details of `IMP` System message. `DITS_LOG_IMPINIT` (4) => Output details of calls to `IMP` `DITS_LOG_MON` (8) => Output monitor message details `DITS_LOG_ACT` (16) => Output action scheduling events. `DITS_LOG_DETAILS` (32) => Log detlails of such things as message sizes. `DITS_LOG_BULK` (64) => Log details of bulk data messages `DITS_LOG_LIBS` (128) => Usable by `DRAMA` libraries to log their own details, such as `DCPP` transation details. `DITS_LOG_IMPEVENTS` (256) -> 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. `DITS_LOG_RXLPEXIT` (4096) => Log exit from DitsMsgReceive, including time tags. `DITS_LOG_ALL` (65535) => Log everything available.
`!`	status	StatusType `*`	Modified status.

Mask of values. To turn logging off, specify DITS_LOG_OFF - zero, only. Otherwise, specify a mask of the following flags.

DITS_LOG_BASIC (1) => Basic logging of important events DITS_LOG_IMPSYS (2) => Dump details of IMP System message. DITS_LOG_IMPINIT (4) => Output details of calls to IMP DITS_LOG_MON (8) => Output monitor message details DITS_LOG_ACT (16) => Output action scheduling events. DITS_LOG_DETAILS (32) => Log detlails of such things as message sizes. DITS_LOG_BULK (64) => Log details of bulk data messages DITS_LOG_LIBS (128) => Usable by DRAMA libraries to log their own details, such as DCPP transation details. DITS_LOG_IMPEVENTS (256) -> 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. DITS_LOG_RXLPEXIT (4096) => Log exit from DitsMsgReceive, including time tags. DITS_LOG_ALL (65535) => Log everything available.

!

status

StatusType *

Modified status.

Include files

DitsSys.h

External functions used

None

External values used

DitsTask

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 tjf@aao.gov.au