Public methods

allocate

void allocate(AllocateOpt option = queue)
option
An enumeration, defined in this class, that indicates what action CICS® is to take if a communication channel is unavailable when this method is called.

Establishes a session (communication channel) to the remote system.

Conditions

INVREQ, SYSIDERR, CBIDERR, NETNAMEIDERR, PARTNERIDERR, SYSBUSY

connectProcess (1)

void connectProcess (SyncLevel level,
                     const IccBuf* PIP = 0)

level
An enumeration, defined in this class, that indicates what sync level is to be used for this conversation
PIP
An optional pointer to an IccBuf object that contains the PIP data to be sent to the remote system

This method can only be used if an IccPartnerId object was used to construct this session object.

connectProcess (2)

void connectProcess (SyncLevel level,
                     const IccTransId& transId,
                     const IccBuf* PIP = 0)

level
An enumeration, defined in this class, that indicates what sync level is to be used for this conversation
transId
A reference to an IccTransId object that holds the name of the transaction to be started on the remote system
PIP
An optional pointer to an IccBuf object that contains the PIP data to be sent to the remote system

connectProcess (3)

void connectProcess (SyncLevel level,
                     const IccTPNameId& TPName,
                     const IccBuf* PIP = 0)

level
An enumeration, defined in this class, that indicates what sync level is to be used for this conversation
TPName
A reference to an IccTPNameId object that contains the 1-64 character TP name.
PIP
An optional pointer to an IccBuf object that contains the PIP data to be sent to the remote system

Starts a partner process on the remote system in preparation for sending and receiving information.

Conditions

INVREQ, LENGERR, NOTALLOC, PARTNERIDERR, NOTAUTH, TERMERR, SYSBUSY

converse

const IccBuf& converse(const IccBuf& send)
send
A reference to an IccBuf object that contains the data that is to be sent.

converse sends the contents of send and returns a reference to an IccBuf object that holds the reply from the remote APPC partner.

Conditions

EOC, INVREQ, LENGERR, NOTALLOC, SIGNAL, TERMERR

convId

const IccConvId& convId()

Returns a reference to an IccConvId object that contains the 4-byte conversation identifier.

errorCode

const char* errorCode() const

Returns the 4-byte error code received when isErrorSet returns true. See the relevant DTP Guide for more information.

extractProcess

void extractProcess()

Retrieves information from an APPC conversation attach header and holds it inside the object. See PIPList, process, and syncLevel methods to retrieve the information from the object. This method should be used by the back end task if it wants access to the PIP data, the process name, or the synclevel under which it is running.

Conditions

INVREQ, NOTALLOC, LENGERR

flush

void flush()

Ensure that accumulated data and control information are transmitted on an APPC mapped conversation.

Conditions

INVREQ, NOTALLOC

free

void free()

Return the APPC session to CICS so that it may be used by other tasks.

Conditions

INVREQ, NOTALLOC

get

virtual const IccBuf& get()

A synonym for receive. See Polymorphic Behavior for information on polymorphism.

isErrorSet

Icc::Bool isErrorSet() const

Returns a boolean variable, defined in Icc structure, that indicates whether an error has been set.

isNoDataSet

Icc::Bool isNoDataSet() const

Returns a boolean variable, defined in Icc structure, that indicates if no data was returned on a send--just control information.

isSignalSet

Icc::Bool isSignalSet() const

Returns a boolean variable, defined in Icc structure, that indicates whether a signal has been received from the remote process.

issueAbend

void issueAbend()

Abnormally ends the conversation. The partner transaction sees the TERMERR condition.

Conditions

INVREQ, NOTALLOC, TERMERR

issueConfirmation

void issueConfirmation()

Sends positive response to a partner's send request that specified the confirmation option.

Conditions

INVREQ, NOTALLOC, TERMERR, SIGNAL

issueError

void issueError()

Signals an error to the partner process.

Conditions

INVREQ, NOTALLOC, TERMERR, SIGNAL

issuePrepare

void issuePrepare()

This only applies to DTP over APPC links. It enables a syncpoint initiator to prepare a syncpoint slave for syncpointing by sending only the first flow ('prepare to commit') of the syncpoint exchange.

Conditions

INVREQ, NOTALLOC, TERMERR

issueSignal

void issueSignal()

Signals that a mode change is needed.

Conditions

INVREQ, NOTALLOC, TERMERR

PIPList

IccBuf& PIPList()

Returns a reference to an IccBuf object that contains the PIP data sent from the front end process. A call to this method should be preceded by a call to extractProcess on back end DTP processes.

process

const IccBuf& process() const

Returns a reference to an IccBuf object that contains the process data sent from the front end process. A call to this method should be preceded by a call to extractProcess on back end DTP processes.

put

virtual void put(const IccBuf& data)

data
A reference to an IccBuf object that holds the data to be sent to the remote process.

A synonym for send. See Polymorphic Behavior for information on polymorphism.

receive

const IccBuf& receive()

Returns a reference to an IccBuf object that contains the data received from the remote system.

Conditions

EOC, INVREQ, LENGERR, NOTALLOC, SIGNAL, TERMERR

send (1)

void send (const IccBuf& send,
           SendOpt option =
normal)
send
A reference to an IccBuf object that contains the data that is to be sent.
option
An enumeration, defined in this class, that affects the behavior of the send method. The default is normal.

send (2)

void send(SendOpt option = normal)
option
An enumeration, defined in this class, that affects the behavior of the send method. The default is normal.

Sends data to the remote partner.

Conditions

INVREQ, LENGERR, NOTALLOC, SIGNAL, TERMERR

sendInvite (1)

void sendInvite (const IccBuf& send,
                      SendOpt option =
normal)
send
A reference to an IccBuf object that contains the data that is to be sent.
option
An enumeration, defined in this class, that affects the behavior of the sendInvite method. The default is normal.

sendInvite (2)

void sendInvite(SendOpt option = normal)
option
An enumeration, defined in this class, that afffects the behavior of the sendInvite method. The default is normal.

Sends data to the remote partner and indicates a change of direction, that is, the next method on this object will be receive.

Conditions

INVREQ, LENGERR, NOTALLOC, SIGNAL, TERMERR

sendLast (1)

void sendLast (const IccBuf& send,
               SendOpt option =
normal)
send
A reference to an IccBuf object that contains the data that is to be sent.
option
An enumeration, defined in this class, that affects the behavior of the sendLast method. The default is normal.

sendLast (2)

void sendLast(SendOpt option = normal)
option
An enumeration, defined in this class, that affects the behavior of the sendLast method. The default is normal.

Sends data to the remote partner and indicates that this is the final transmission. The free method must be invoked next, unless the sync level is 2, when you must commit resource updates before the free. (See commitUOW on page commitUOW in IccTaskClass).

Conditions

INVREQ, LENGERR, NOTALLOC, SIGNAL, TERMERR

state

IccValue::CVDA state(StateOpt option = lastCommand)
option
An enumeration, defined in this class, that indicates how to report the state of the conversation

Returns a CVDA, defined in IccValue structure, that indicates the current state of the APPC conversation. Possible values are:

IccValue::NOTAPPLIC is returned if there is no APPC conversation state.

Conditions

INVREQ, NOTALLOC

stateText

const char* stateText(StateOpt option = lastCommand)
option
An enumeration, defined in this class, that indicates how to report the state of the conversation

Returns the symbolic name of the state that state method would return. For example, if state returns IccValue::ALLOCATED, stateText would return "ALLOCATED".

syncLevel

SyncLevel syncLevel() const

Returns an enumeration, defined in this class, that indicates the synchronization level that is being used in this session. A call to this method should be preceded by a call to extractProcess on back end DTP processes.

[[ Contents Previous Page | Next Page Index ]]