Public methods

The opt parameter

Many methods have the same parameter, opt, which is described under the abendCode method inabendCode.

abend

void abend (const char* abendCode = 0,
            AbendHandlerOpt opt1 =
respectAbendHandler,
            AbendDumpOpt opt2 =
createDump)
abendCode
The 4-character abend code
opt1
An enumeration, defined in this class, that indicates whether to respect or ignore any abend handling program specified by setAbendHandler method in IccControl class
opt2
An enumeration, defined in this class, that indicates whether a dump is to be created.

Requests CICS® to abend this task.

abendData

IccAbendData* abendData()

Returns a pointer to an IccAbendData object that contains information about the program abends, if any, that relate to this task.

commitUOW

void commitUOW()

Commit the resource updates within the current UOW for this task. This also causes a new UOW to start for subsequent resource update activity.

Conditions

INVREQ, ROLLEDBACK

delay

void delay (const IccTime& time,
            const IccRequestId* reqId = 0)

time
A reference to an object that contains information about the delay time. The object can be one of these types:
IccAbsTime
Expresses time as the number of milliseconds since the beginning of the year 1900.
IccTimeInterval
Expresses an interval of time, such as 3 hours, 2 minutes, and 1 second.
IccTimeOfDay
Expresses a time of day, such as 13 hours, 30 minutes (1-30 pm).
reqId
An optional pointer to an IccRequestId object that can be used to cancel an unexpired delay request.

Requests that this task be delayed for an interval of time, or until a specific time.

Conditions

EXPIRED, INVREQ

dump

const char* dump (const char* dumpCode,
                   const IccBuf* buf = 0)

dumpCode
A 4-character label that identifies this dump
buf
A pointer to the IccBuf object that contains additional data to be included in the dump.

Requests CICS to take a dump for this task. (See also setDumpOpts.) Returns the character identifier of the dump.

Conditions

INVREQ, IOERR, NOSPACE, NOSTG, NOTOPEN, OPENERR, SUPPRESSED

enterTrace

void enterTrace (unsigned short traceNum,
                 const char* resource = 0,
                 IccBuf* data = 0,
                 TraceOpt opt =
normal)
traceNum
The trace identifier for a user trace table entry; a value in the range 0 through 199.
resource
An 8-character name to be entered in the resource field of the trace table entry.
data
A pointer to the IccBuf object containing data to be included in the trace record.
opt
An enumeration, defined in this class, that indicates whether tracing should be normal or whether only exceptions should be traced.

Writes a user trace entry in the CICS trace table.

Conditions

INVREQ, LENGERR

facilityType

FacilityType facilityType()

Returns an enumeration, defined in this class, that indicates what type of principal facility this task has. This is usually a terminal, such as when the task was started by someone keying a transaction name on a CICS terminal. It is a session if the task is the back end of a mapped APPC conversation.

Conditions

INVREQ

freeStorage

void freeStorage(void* pStorage)

Releases the storage obtained by the IccTask getStorage method.

Conditions

INVREQ

getStorage

void* getStorage (unsigned long size,
                  char initByte = -1,
                  unsigned short storageOpts = 0)

size
The amount of storage being requested, in bytes
initByte
The initial setting of all bytes in the allocated storage
storageOpts
An enumeration, defined in this class, that affects the way that CICS allocates storage.

Obtains a block of storage of the requested size. The storage is released automatically at the end of task, or when the freeStorage operation is performed. See also getStorage on page getStorage in IccSystemclass.

Conditions

LENGERR, NOSTG

instance

static IccTask* instance();

Returns a pointer to the singleton IccTask object. The object is created if it does not already exist.

isCommandSecurityOn

Icc::Bool isCommandSecurityOn()

Returns a boolean, defined in Icc structure, that indicates whether this task is subject to command security checking.

Conditions

INVREQ

isCommitSupported

Icc::Bool isCommitSupported()

Returns a boolean, defined in Icc structure that indicates whether this task can support the commit method. This method returns true in most environments; the exception to this is in a DPL environment (see link on page link in IccProgram).

Conditions

INVREQ

isResourceSecurityOn

Icc::Bool isResourceSecurityOn()

Returns a boolean, defined in Icc structure, that indicates whether this task is subject to resource security checking.

Conditions

INVREQ

isRestarted

Icc::Bool isRestarted()

Returns a boolean, defined in Icc structure, that indicates whether this task has been automatically restarted by CICS.

Conditions

INVREQ

isStartDataAvailable

Icc::Bool isStartDataAvailable()

Returns a boolean, defined in Icc structure, that indicates whether start data is available for this task. See the retrieveData method in IccStartRequestQ class if start data is available.

Conditions

INVREQ

number

unsigned long number() const

Returns the number of this task, unique within the CICS system.

principalSysId

IccSysId& principalSysId(Icc::GetOpt opt = Icc::object)

Returns a reference to an IccSysId object that identifies the principal system identifier for this task.

Conditions

INVREQ

priority

unsigned short priority(Icc::GetOpt opt = Icc::object)

Returns the priority for this task.

Conditions

INVREQ

rollBackUOW

void rollBackUOW()

Roll back (backout) the resource updates associated with the current UOW within this task.

Conditions

INVREQ, ROLLEDBACK

setDumpOpts

void setDumpOpts(unsigned long opts = dDefault)
opts
An integer, made by adding or logically ORing values from the DumpOpts enumeration, defined in this class.

Set the dump options for this task. This method affects the behavior of the dump method defined in this class.

setPriority

void setPriority(unsigned short pri)

pri
The new priority.

Changes the dispatch priority of this task.

Conditions

INVREQ

setWaitText

void setWaitText(const char* name)
name
The 8-character string label that indicates why this task is waiting.

Sets the text that will appear when someone inquires on this task while it is suspended as a result of a waitExternal or waitOnAlarm method call.

startType

StartType startType()

Returns an enumeration, defined in this class, that indicates how this task was started.

Conditions

INVREQ

suspend

void suspend()

Suspend this task, allowing other tasks to be dispatched.

transId

const IccTransId& transId()

Returns the IccTransId object representing the transaction name of this CICS task.

triggerDataQueueId

const IccDataQueueId& triggerDataQueueId()

Returns a reference to the IccDataQueueId representing the trigger queue, if this task was started as a result of data arriving on an IccDataQueue. See startType method.

Conditions

INVREQ

userId

const IccUserId& userId(Icc::GetOpt opt = Icc::object)
opt
An enumeration, defined in Icc structure, that indicates whether the information already existing in the object is to be used or whether it is to be refreshed from CICS.

Returns the ID of the user associated with this task.

Conditions

INVREQ

waitExternal

void waitExternal (long** ECBList,
                   unsigned long numEvents,
                   WaitPurgeability opt =
purgeable,
                   WaitPostType type =
MVSPost)
ECBList
A pointer to a list of ECBs that represent events.
numEvents
The number of events in ECBList.
opt
An enumeration, defined in this class, that indicates whether the wait is purgeable.
type
An enumeration, defined in this class, that indicates whether the post type is a standard MVS™ POST.

Waits for events that post ECBs - Event Control Blocks. The call causes the issuing task to be suspended until one of the ECBs has been posted--that is, one of the events has occurred. The task can wait on more than one ECB and can be dispatched as soon as any of them are posted.

See waitExternal in the CICS Application Programming Reference for more information about ECBs.

Conditions

INVREQ

waitOnAlarm

void waitOnAlarm(const IccAlarmRequestId& id)
id
A reference to the IccAlarmRequestId object that identifies a particular alarm request.

Suspends the task until the alarm goes off (expires). See also setAlarm on page setAlarm in IccClock.

Conditions

INVREQ

workArea

IccBuf& workArea()

Returns a reference to the IccBuf object that holds the work area for this task.

Conditions

INVREQ

[[ Contents Previous Page | Next Page Index ]]