APPC Verb Summary

This section briefly describes each APPC verb, grouped by function.

Verbs for Starting Conversations

ALLOCATE_ or
MC_ALLOCATE
Issued by the local TP. This verb allocates a session between the local logical unit (LU) and a partner LU, and establishes a conversation between the local TP and the partner TP.

ALLOCATE can establish either a basic or a mapped conversation. MC_ALLOCATE can start only a mapped conversation. After the conversation is allocated, APPC uses this verb to return a conversation identifier (conv_id).

RECEIVE_ALLOCATE
Issued by the partner TP. This verb confirms that the partner TP is ready to begin a conversation with the local TP that issued ALLOCATE or MC_ALLOCATE. Upon successful execution, this verb returns a TP identifier (tp_id) for the partner TP and the conv_id.
TP_STARTED
Issued by the local TP. This verb notifies APPC that the local TP is starting. Upon successful execution, this verb returns a tp_id for the local TP.

Verbs for Sending Data

CONFIRM or MC_CONFIRM
Sends the contents of the local LU's send buffer and a confirmation request to the partner TP.
FLUSH or MC_FLUSH
Flushes the local LU's send buffer, sending the contents of the buffer to the partner LU and TP. If the send buffer is empty, no action takes place.
PREPARE_TO_RECEIVE or MC_PREPARE_TO_RECEIVE
Changes the state of the conversation from SEND to RECEIVE. Before changing the conversation state, this verb performs the equivalent of FLUSH, MC_FLUSH, CONFIRM, or MC_CONFIRM. After this verb has successfully executed, the local TP can receive data.
REQUEST_TO_SEND or MC_REQUEST_TO_SEND
Informs the partner TP that the local TP wants to send data. The local TP must wait until the partner TP issues PREPARE_TO_RECEIVE, MC_PREPARE_TO_RECEIVE, RECEIVE_AND_WAIT, or MC_RECEIVE_AND_WAIT, and the conversation state changes to RECEIVE for the partner TP, before the local TP begins sending data.
SEND_DATA or MC_SEND_DATA
Puts data in the local LU's send buffer for transmission to the partner TP.

The data collected in the local LU's send buffer is transmitted to the partner LU and partner TP when one of the following occurs:

Verbs for Receiving Data

POST_ON_RECEIPT or MC_POST_ON_RECEIPT (Microsoft® Windows NT® and Windows® 95 operating systems)
Issuing this verb allows the application to register to receive a notification when data or status arrives at the local LU without actually receiving it at the same time. This verb can only be issued while in RECEIVE state and it never causes a change in conversation state. This verb is only supported on Windows NT and Windows 95 with Service Pack 1 or later applied to SNA Server version 3.0.

When the TP issues this verb, APPC returns control to the TP immediately. When the specified conditions are satisfied, the Win32® event specified as a parameter is signalled and the verb completes. Then the TP looks at the return code in the verb control block to determine whether or not any data or status notification has arrived at the local LU and issues a RECEIVE_IMMEDIATE or RECEIVE_AND_WAIT verb to actually receive the data or status notification.

RECEIVE_AND_POST or MC_RECEIVE_AND_POST (Windows NT, Windows 95, and OS/2 operating systems)
Issuing this verb while the conversation is in RECEIVE state changes the conversation state to PENDING_POST and causes the local TP to receive data asynchronously. This allows the local TP to proceed with processing while data is still arriving at the local LU.

Issuing this verb while the conversation is in SEND state flushes the LU's send buffer and changes the conversation state to PENDING_POST. The local TP then begins to receive data asynchronously.

RECEIVE_AND_WAIT or MC_RECEIVE_AND_WAIT
Issuing this verb while the conversation is in RECEIVE state causes the local TP to receive any data that is currently available from the partner TP. If no data is available, the local TP waits for data to arrive.

Issuing this verb while the conversation is in SEND state flushes the LU's send buffer and changes the conversation state to RECEIVE. The local TP then begins to receive data.

RECEIVE_IMMEDIATE or MC_RECEIVE_IMMEDIATE
Receives any data that is currently available from the partner TP. If no data is available, the local TP does not wait.
TEST_RTS or MC_TEST_RTS
Determines whether a REQUEST_TO_SEND or MC_REQUEST_TO_SEND or notification has been received.

Verbs for Confirming Data or Reporting Errors

CONFIRMED or MC_CONFIRMED
Replies to a confirmation request from the partner TP. It informs the partner TP that the local TP has received and processed the data without error.
RECEIVE_LOG_DATA or MC_RECEIVE_LOG_DATA
Issuing this verb allows the user to register to receive the log data associated with an inbound Function Management Header 7 (FMH7) error report. The verb passes a buffer to APPC, and any log data received is placed in that buffer. APPC continues to use this buffer as successive FMH7s arrive until it is provided with another buffer (that is, until the TP issues another RECEIVE_LOG_DATA or MC_RECEIVE_LOG_DATA specifying a different buffer or no buffer at all). This verb is only supported on Windows NT and Windows 95 with Service Pack 1 or later applied to SNA Server version 3.0.
SEND_CONVERSATION or MC_SEND_CONVERSATION
Issued by the invoking TP, this verb allocates a session between the local LU and partner LU, sends data on the session, and then deallocates the session.
SEND_ERROR or MC_SEND_ERROR
Notifies the partner TP that the local TP has encountered an application-level error.

Verbs for Getting and Setting Information

GET_ATTRIBUTES or MC_GET_ATTRIBUTES
Used by a TP to get the attributes of the conversation.
GET_LU_STATUS
Used to report the status of a particular remote LU.
GET_STATE
Used by a TP to interrogate the state of a particular conversation.
GET_TP_PROPERTIES
Returns attributes of the TP and the current transaction.
GET_TYPE
Used by a TP to determine the conversation type (basic or mapped) of a particular conversation. With this information, the TP can decide whether to issue basic or mapped conversation verbs.
SET_TP_PROPERTIES
Used to set the attributes of the TP and the current transaction.

Verbs that Provide Management Functions

CNOS (Change Number of Sessions)
Establishes APPC LU 6.2 session limits.
DISPLAY
Returns configuration information and current operating values for the SNA node.

Verbs for Ending Conversations

DEALLOCATE or MC_DEALLOCATE
Deallocates a conversation between two TPs. Before deallocating the conversation, this verb performs the equivalent of FLUSH, MC_FLUSH, CONFIRM, or MC_CONFIRM.
TP_ENDED
Issued by both the local and partner TPs. It notifies APPC that the TP is ending. Issuing this verb also terminates any active conversations.