Public methods

cancel

void cancel (const IccRequestId& reqId,
             const IccTransId* transId = 0)

reqId
A reference to an IccRequestId object that represents the request to be cancelled
transId
An optional pointer to an IccTransId object that represents the transaction that is to be cancelled.

Cancels a previously issued start request that has not yet expired.

Conditions

ISCINVREQ, NOTAUTH, NOTFND, SYSIDERR

clearData

void clearData()

clearData clears the current data that is to be passed to the started transaction. The data was set using setData or registerData.

If the data was set using registerData, only the pointer to the data is removed, the data in the buffer is left unchanged.

If the data was set using setData, then clearData releases the memory used by the buffer.

data

const IccBuf&  data() const

Returns a reference to an IccBuf object that contains data passed on a start request. A call to this method should be preceded by a call to retrieveData method.

instance

static IccStartRequestQ* instance()

Returns a pointer to the single IccStartRequestQ object. If the object does not exist it is created. See also startRequestQ method on page startRequestQ of IccControl.

queueName

const char* queueName() const

Returns the name of the queue that was passed by the start requester. A call to this method should be preceded by a call to retrieveData method.

registerData

void registerData(const IccBuf* buffer)

buffer
A pointer to the IccBuf object that holds data to be passed on a start request.

Registers an IccBuf object to be interrogated for start data on each subsequent start method invocation.

This just stores the address of the IccBuf object within the IccStartRequestQ so that the IccBuf object can be found when using the start method. This differs from the setData method, which takes a copy of the data held in the IccBuf object during the time that it is invoked.

reset

void reset()

Clears any associations previously made by set... methods in this class.

retrieveData

void retrieveData(RetrieveOpt option = noWait)

option
An enumeration, defined in this class, that indicates what happens if there is no start data available.

Used by a task that was started, via an async start request, to gain access to the information passed by the start requester. The information is returned by the data, queueName, returnTermId, and returnTransId methods.

Conditions

ENDDATA, ENVDEFERR, IOERR, LENGERR, NOTFND, INVREQ

Note:
The ENVDEFERR condition will be raised if all the possible options (setData, setQueueName, setReturnTermId, and setReturnTransId) are not used before issuing the start method. This condition is therefore not necessarily an error condition and your program should handle it accordingly.

returnTermId

const IccTermId& returnTermId() const

Returns a reference to an IccTermId object that identifies which terminal is involved in the session. A call to this method should be preceded by a call to retrieveData method.

returnTransId

const IccTransId& returnTransId() const

Returns a reference to an IccTransId object passed on a start request. A call to this method should be preceded by a call to retrieveData method.

setData

void setData(const IccBuf& buf)

Copies the data in buf into the IccStartRequestQ, which passes it to the started transaction when the start method is called. See also registerData on page registerData for an alternative way to pass data to started transactions.

setQueueName

void setQueueName(const char* queueName)

queueName
An 8-character queue name.

Requests that this queue name be passed to the started transaction when the start method is called.

setReturnTermId (1)

void setReturnTermId(const IccTermId& termId)
termId
A reference to an IccTermId object that identifies which terminal is involved in the session.

setReturnTermId (2)

void setReturnTermId(const char* termName)
termName
The 4-character name of the terminal that is involved in the session.

Requests that this return terminal ID be passed to the started transaction when the start method is called.

setReturnTransId (1)

void setReturnTransId(const IccTransId& transId)
transId
A reference to an IccTransId object.

setReturnTransId (2)

void setReturnTransId(const char* transName)
transName
The 4-character name of the return transaction.

Requests that this return transaction ID be passed to the started transaction when the start method is called.

setStartOpts

void setStartOpts (ProtectOpt popt = none,
                   CheckOpt copt =
check)

popt
An enumeration, defined in this class, that indicates whether start requests are to be protected
copt
An enumeration, defined in this class, that indicates whether start requests are to be checked.

Sets whether the started transaction is to have protection and whether it is to be checked.

start

const IccRequestId& start (const IccTransId& transId,
                          const IccTermId* termId,
                          const IccTime* time = 0,
                          const IccRequestId* reqId = 0)

or

const IccRequestId& start (const IccTransId& transId,
                          const IccUserId* userId,
                          const IccTime* time = 0,
                          const IccRequestId* reqId = 0)

or

const IccRequestId& start (const IccTransId& transId,
                          const IccTime* time = 0,
                          const IccRequestId* reqId = 0)

transId
A reference to an IccTransId object that represents the transaction to be started
termId
A reference to an IccTermId object that identifies which terminal is involved in the session.
userId
A reference to an IccUserId object that represents the user ID.
time
An (optional) pointer to an IccTime object that specifies when the task is to be started. The default is for the task to be started immediately.
reqId
An (optional) pointer to an IccRequestId object that is used to identify this start request so that the cancel can cancel the request.

Asynchronously starts the named CICS® transaction. The returned reference to an IccRequestId object identifies the start request and can be used subsequently to cancel the start request.

Conditions

INVREQ, IOERR, ISCINVREQ, LENGERR, NOTAUTH, SYSIDERR, TERMIDERR, TRANSIDERR, USERIDERR

[[ Contents Previous Page | Next Page Index ]]