DITS Library routines
- DitsActIndexByName
- Returns the action index of an
action of a specified name.
Note, we only match the last entry of the name and ignore
spawned actions.
- DitsActionTransIdWait
- Blocks the current action and
waits for a message to be received.
- DitsActionWait
- Blocks the current action and waits for a message to be received.
- DitsAltInAdd
-
Add an Alternative Input Source
- DitsAltInClear
- Clear an variable of type DitsAltInType
- DitsAltInDelete
- Delete an Alternative Input Source
- DitsAltInLoop
- Implements a Dits Main loop with alternative sources of message events.
- DitsAppInit
- Initialise
Dits.
- DitsAppParamSys
- Get or put parameter system details.
- DitsArgIsBulk
- Indicate if the argument to an action entry is bulk data.
- DitsBulkArgInfo
- Returns details about a bulk data
shared memory argument
- DitsBulkArgRelease
- Notify DRAMA you are
finished with bulk data.
- DitsBulkArgReport
- Notify DRAMA of the number
of bulk data bytes used.
- DitsCheckTransactions
- Checks if there are outstanding
transactions for the current action.
- DitsDefault
- Set/Return
the default directory.
- DitsDefineSdsShared
- Defined a shared memory segment
and export an SDS structure into it.
- DitsDefineShared
- Defines and optionally creates a
shared memory section.
- DitsDeleteTask
- Delete a task that is registered with the system.
- DitsDeltaTime
- Converts a time in secs and microsecs into a form usable by DitsPutDelay.
- DitsDumpAction
- Dump action details.
- DitsDumpAllActions
- Dump details of all actions or all
active actions.
- DitsDumpAllPaths
- Dump all path details.
- DitsDumpAllTransIds
- Dump all transaction id details.
- DitsDumpImp
- Starts
dumping imp messages to a log file.
- DitsDumpImpClose
- Stops dumping imp messages to a log
file.
- DitsDumpPath
-
Dump path details.
- DitsDumpTransId
- Dump transaction id details.
- DitsEnableTask
- Enable Dits calls within an interrupt handler.
- DitsErrorText
- Converts a error string to text and returns the address of the string.
- DitsFindTaskByType
- Return the name of the first task
with the given type.
- DitsFmtReason
- Converts a reason code and status into a string and outputs an
appropriate message into a buffer.
- DitsForEachTransaction
- Iterate through the
transactions for an action.
- DitsForget
- Forget
about the specified transaction.
- DitsGetActData
- Get the value stored by DitsPutActData.
- DitsGetActIndex
- Return the index of the current action
- DitsGetActNameFromIndex
- Given a DITS Action
index, return the name.
- DitsGetArgument
- Fetch the argument supplied to this
action.
- DitsGetCode
- Get
the action code of the current action.
- DitsGetContext
- Get the action context of the current action.
- DitsGetDebug
-
Returns the value of the internal debugging flag.
- DitsGetEntBulkInfo
- Allows you to retrieve bulk data
transfer progress information.
- DitsGetEntComplete
- Indicates if a subsidary
transaction is complete.
- DitsGetEntInfo
- Get the details of the current entry of the current action.
- DitsGetEntName
- Get the name associated with the current entry of the current action.
- DitsGetEntPath
- Get the path associated with the current entry of the current action.
- DitsGetEntReason
- Get the reason for the current entry
of the current action.
- DitsGetEntStatus
- Get the status associated with the
reason for the current entry
of the current action.
- DitsGetEntTransId
- Get the transaction id associated
with the current
entry of the current action.
- DitsGetFixFlags
- Gets the value of the flags used to
commuicate with the fixed part.
- DitsGetMsgLength
- Return the buffer length required to
send a given message.
- DitsGetName
- Fetch
the name of the current action.
- DitsGetParId
-
Get the parameter system id supplied in the parid argument
to DitsAppParSys.
- DitsGetParam
-
Send a ``Get Parameter'' message to a task
- DitsGetParentPath
- Return the path to the task which
invoked this action.
- DitsGetPath
- Initiates
the getting of or returns a path to a task, Obsolete,
See DitsPathGet.
- DitsGetPathData
- Retrun an item previously associated
with a path.
- DitsGetPathSize
- Return message buffer allocation for
the specified path.
- DitsGetReason
- Get the reason for the current entry of the current action, Obsolete, see
DitsGetEntReason(3) and DitsGetEntStatus(3).
- DitsGetSelfPath
- Return the path to this task.
- DitsGetSeq
- Get
the sequence count of the current action.
- DitsGetSigArg
- Fetch the argument supplied to this action by a DitsSignal...Ptr call.
- DitsGetSymbol
- Returns the value of an external symbol
- DitsGetTaskDescr
- Return the description of a task of
a given name.
- DitsGetTaskId
- Get the current Dits Task Id
- DitsGetTaskName
- Fetch the name of the task.
- DitsGetTaskType
- Return the type of a task of a given
name.
- DitsGetTransData
- Retrun an item previously associated
with a transaction.
- DitsGetUserData
- Get the user data put by the
DitsPutUserData routines.
- DitsGetVerDate
- Returns the DITS version date
- DitsGetVersion
- Returns the DITS version.
- DitsGetXInfo
-
Returns information needed by X-windows to coexist with IMP.
- DitsImpRedirect
- Redirects the ImpNetLocate and
ImpConnect calls
DitsInit
Initialise
Dits, Depreciated, See DitsAppInit(3).
DitsInitMessBulk
Send a message to another task,
sending a bulk data argument.
DitsInitiateMessage
Send a message to another task
given a path to that task.
DitsInterested
Indicates the current action is interested in certain messages.
DitsIsActionActive
Indicates if the specified action
is active.
DitsIsOrphan
Indicate if a transaction is an orphan.
DitsKick
Send a
KICK message to a task
DitsKillByIndex
Kill a currently active action.
DitsKillByName
Kill a currently active action.
DitsLoad
Loads
and runs a task.
DitsLoadErrorStat
Returns the system status code
associated with a load error.
DitsLoadErrorText
Returns the system status code text
associated with a load error.
DitsLogFlush
Flush the log file.
DitsLogMsg
Write
a message to the log file.
DitsLosePath
Lose a path.
DitsMainLoop
Dits main loop
DitsMonitor
Called
by a parameter system to notify of a parameter value change
DitsMonitorDisconnect
A task with which this task was
communicating has disconnected.
DitsMonitorMsg
Handle incomming monitor messages
DitsMonitorReport
Report on all the parameters being
monitored in a task
DitsMonitorTidy
Tidy up the monitor code at task
shutdown
DitsMsgAvail
Returns the count of available messages.
DitsMsgReceive
Process a message
DitsMsgWait
Wait
until a message arrives and return before processing it.
DitsNotInterested
Indicates the current action is not
interested in certain messages.
DitsNumber
Return
the size of an array.
DitsObey
Send an
OBEY message to a task
DitsPathGet
Initiates
the getting of or returns a path to a task.
DitsPathToNode
Given a DITS Path, return the node name.
DitsPeek
Peek at
queue messages for any of interest.
DitsPrintReason
Converts a reason code and status
into a string and outputs an
appropriate message
DitsPutActData
Stores an item of data assocaited with the current action.
DitsPutActEndRoutine
Put a routine to be invoked when
the action completes.
DitsPutActionHandlers
Register action handlers,
Obsolete, See DitsPutActions(3).
DitsPutActions
Register action handlers.
DitsPutArgument
Set the argument to return if the
action completes.
DitsPutCode
Change
the value return by DitsGetCode.
DitsPutConnectHandler
Put a routine to be invoked
when another task attempts to connect.
DitsPutDefCode
Sets a new code to be associated with a named action.
DitsPutDefKickHandler
Sets a new kick handler routine
for an action.
DitsPutDefObeyHandler
Sets a new obey handler routine
for an action.
DitsPutDefaultHandler
Sets a new handler for
DEFAULT control messages.
DitsPutDelay
Set Action delay or timeout.
DitsPutDisConnectHandler
Put a routine to be invoked
when another task disconnects from
us.
DitsPutEventWaitHandler
Put a routine to be invoked
when waiting for events.
DitsPutForwardMonSetupHandler
Put a routine to be
invoked when another a forward monitor path is being
setup.
DitsPutKickHandler
Sets a new handler routine for the
next kick.
DitsPutObeyHandler
Sets a new handler routine for the
next reschedule.
DitsPutOrphanHandler
Set the routine to be invoked
for orphan routines.
DitsPutParSys
Enable, Disable or change the parameter system used by Dits, Obsolete, See
DitsAppParamSys(3).
DitsPutParamMon
Enable the parameter monitoring
system Obsolete, See DitsAppParamSys(3).
DitsPutPathData
Associate an item with a path
DitsPutRegistrationHandler
Put a routine to be
invoked when another task registers with IMP.
DitsPutRequest
Request
to the fixed part for when the Action returns.
DitsPutTransData
Associate an item with a transaction.
DitsPutUserData
Put a user defined value in the task
common block.
DitsReleaseShared
Frees a shared memory section.
DitsRequestNotify
Request a message when the buffers
to a task empty.
DitsRestoreTask
Restore the interrupted Task Id
DitsScanTasks
Scan the tasks known to DRAMA on current machine.
DitsSdsList
Use
MsgOut to output the contents of an Sds structure.
DitsSetDebug
Enable/Disable Dits internal debugging.
DitsSetDetails
Set the details of this task.
DitsSetFixFlags
Sets the value of the flags used to
commuicate with the fixed part.
DitsSetLogSys
Set the logging system to be used by DITS.
DitsSetParam
Send a `Set parameter' message to a task
DitsSetParamSetup
Set up a DitsGsokMessageType
variable for a set message.
DitsSetParamTidy
Tidy up after a call to
DitsSetParamSetup.
DitsSignalByIndex
Trigger the rescheduling of an
action.
DitsSignalByIndexPtr
Trigger the rescheduling of an
action.
DitsSignalByName
Trigger the rescheduling of an action.
DitsSignalByNamePtr
Trigger the rescheduling of an
action.
DitsSpawnKickArg
Create an argument structure used
when kick actions which spawn.
DitsSpawnKickArgUpdate
Update an argument structure
used when kick actions which spawn.
DitsStop
Shutdown
Dits.
DitsTakeOrphans
Take over orphans.
DitsTaskFromPath
Return the name of a task given a
path to it.
DitsTaskIsLocal
Indicates if a task on a given path
is local
DitsTrigger
Trigger
the parent action
DitsTriggerBulk
Trigger parent action, sending a bulk
data argument.
DitsUfaceCtxEnable
Enable user interface context for
the current task.
DitsUfaceErsRep
Given a Ers message structure, report
it using ErsRep.
DitsUfacePutErsOut
Put the routine used to output
error message during Uface context.
DitsUfacePutMsgOut
Put the routine used for MsgOut
output during Uface context.
DitsUfaceRespond
General Uface context response
routine.
DitsUfaceTimer
Set up Uface Context timer message.
DitsUfaceTimerCancel
Cancel a timer messsage
requested by DitsUfaceTimer.
DitsUfaceTransIdWait
Blocks the current
UFACE context and waits for a message to be received.
DitsUfaceWait
Blocks the current UFACE context and waits for a message to be
received.
DitsUfaceWaitComp
Tidy up after calls to DitsUfaceWait.
DitsUfaceWaitInit
Setup for a call to DitsUfaceWait.
MsgOut
Sends a
message to the user interface.
Click here for the DRAMA home page and
here for the AAO home page.
For more information, contact tjf@aaoepp.aao.gov.au