|
HP OpenVMS Systems Documentation |
|
VMS DECwindows Transport Manual
Chapter 7
|
| Routine | Function |
|---|---|
| XPORT_IN_NOTIFY_SET | Requests input notification. |
| XPORT_IN_NOTIFY_CLEAR | Clears a request-for-input notification. |
| XPORT_IN_NOTIFY_WAIT | Initiates a wait-for-input notification. |
| XPORT_IN_NOTIFY_SEND | Sends notice that an input operation has completed. |
| XPORT_OUT_NOTIFY_SET | Sends notice that output notification is required. |
| XPORT_OUT_NOTIFY_CLEAR | Sends notice that output notification is no longer required. |
| XPORT_OUT_NOTIFY_WAIT | Waits for output notification. |
| XPORT_OUT_NOTIFY_SEND | Sends notice that an output operation has completed. |
| XPORT_XTCB_FILLED | Returns the number of data bytes in an XTCB. |
| XPORT_XTCB_TOTAL | Determines the total number of bytes in the data area of an XTCB. |
| XPORT_XTCB_FREE | Determines the number of unused bytes in the data area of an XTCB. |
| XPORT_WRITE_WAIT | Waits for the output work queue to empty. |
| XPORT_WRITE_UNWAIT | Reenables output work queue write operations. |
| XPORT_ABORT_SEND | Declares a user-mode AST to the process indicating that the connection has died. |
| XPORT_OUT_WRITE_ENABLE | Clears the write disable flag. |
| XPORT_OUT_WRITE_DISABLE | Sets the write disable flag. |
| XPORT_OUT_STATE_SRP | Marks a switch to the use of SRPs for output and returns true (1) if an LRP was being used. |
| XPORT_OUT_STATE_LRP | Marks a switch to the use of LRPs for output and returns true (1) if an SRP was being used. |
| XPORT_IN_STATE_SRP | Marks a switch to the use of SRPs for input and returns true (1) if an LRP was being used. |
| XPORT_IN_STATE_LRP | Marks a switch to the use of LRPs for input and returns true (1) if an SRP was being used. |
| XPORT_IN_FREE_ENABLE | Clears the free disable flag for this connection type of queue and returns true (1) if it was clear or false (0) if it was set. |
| XPORT_IN_FREE_DISABLE | Sets the free disable flag for this connection and type of queue and returns true (1) if it was set or false (0) if it was clear. |
| VALIDATE_XTCC | Validates an XTCC and returns the IXTCC. |
| VALIDATE_USERW | Checks user buffer for write access. |
| VALIDATE_USER | Checks user buffer for read access. |
Requests input notification.
XPORT_IN_NOTIFY_SET xtcc
xtcc
VMS usage: record type: xtcc access: modify mechanism: value
The XTCC of the connection for which input notification is requested.
The XPORT_IN_NOTIFY_SET macro clears the waiting-for-input I/O status block (IOSB) field of the XTCC and sets the XTCC$L_IWQ_FLAG bit to indicate that the transport user wants to be notified when input is delivered to the input work queue.
Clears a request-for-input notification.
XPORT_IN_NOTIFY_CLEAR xtcc
xtcc
VMS usage: record type: xtcc access: modify mechanism: reference
The XTCC of the connection for which to cancel input notification.
The XPORT_IN_NOTIFY_CLEAR macro clears the XTCC$L_IWQ_FLAG bit to indicate that the transport user no longer wants to be notified when input is delivered to the input work queue.
Initiates a wait-for-input notification
XPORT_IN_NOTIFY_WAIT xtcc, xtpb
xtcc
VMS usage: record type: xtcc access: modify mechanism: reference
The XTCC of the connection for which to wait for input notification.xtpb
VMS usage: record type: xtpb access: modify mechanism: reference
The XTPB of the connection for which to wait for input notification.
The XPORT_IN_NOTIFY_WAIT macro calls the $SYNCH system service to suspend a process until input notification is set. The service is satisfied when the XTPB$W_IN_EFN flag is set and the lower word of the XTCC$W_IN_IOSB is made nonzero, as performed by the XPORT_IN_NOTIFY_SEND macro.
Sends notice that an input operation has completed.
XPORT_IN_NOTIFY_SEND xtcc, xtpb
xtcc
VMS usage: record type: xtcc access: modify mechanism: reference
The XTCC of the connection for which to send input notification.xtpb
VMS usage: record type: xtpb access: modify mechanism: reference
The XTPB of the connection for which to send input notification.
The XPORT_IN_NOTIFY_SEND macro conditionally performs the operations that inform a process that an input operation has completed. These operations consist of sending a user-mode AST to the process in the case where the XTPB$A_I_NOTIFY_RTNADR field points to a procedure to call for input notification, or of code that completes the $SYNCH system service call performed by the XPORT_IN_NOTIFY_WAIT macro.XPORT_IN_NOTIFY_SEND sends the AST only if the previous AST (identified by the XTCC$V_IN_AST_IN_PROG field) has been delivered, that is, the field was clear. This prevents EXQUOTA errors due to excessive use of ASTs.
Sends notice that output notification is required.
XPORT_OUT_NOTIFY_SET xtcc, type
xtcc
VMS usage: record type: xtcc access: modify mechanism: reference
The XTCC of the connection for which you want to receive output notification.type
VMS usage: longword type: longword access: read mechanism: value
The type of output free queue you are interested in. Valid types are DECW$C_XPORT_BUFFER_SRP and DECW$C_XPORT_BUFFER_LRP.
The XPORT_OUT_NOTIFY_SET macro clears the waiting-for-output I/O status block (IOSB) field of the XTCC and sets the XTCC$L_OFSQ_FLAG or XTCC$L_OFLQ_FLAG bit to indicate that you are waiting for the output free queue.
Sends notice that output notification is no longer required.
XPORT_OUT_NOTIFY_CLEAR xtcc, type
xtcc
VMS usage: record type: xtcc access: modify mechanism: reference
The XTCC of the connection for which you want to cancel output notification.type
VMS usage: longword type: longword access: read mechanism: value
The type of output free queue you are no longer interested in. Valid types are DECW$C_XPORT_BUFFER_SRP and DECW$C_XPORT_BUFFER_LRP.
The XPORT_OUT_NOTIFY_CLEAR macro clears the XTCC$L_OFSQ_FLAG or XTCC$L_OFLQ_FLAG bit to indicate that you do not want to receive output notification. The XPORT_OUT_NOTIFY_CLEAR macro reverses the effect of the XPORT_OUT_NOTIFY_SET macro.
Waits for output notification.
XPORT_OUT_NOTIFY_WAIT xtcc, xtpb
xtcc
VMS usage: record type: xtcc access: modify mechanism: reference
The XTCC of the connection for which you want to wait for output notification.xtpb
VMS usage: record type: xtpb access: modify mechanism: reference
The XTPB of the connection for which you want to wait for output notification.
The XPORT_IN_NOTIFY_WAIT macro calls the $SYNCH system service to suspend a process until output notification is set. The service is satisfied when the XTPB$W_ON_EFN flag is set and the lower word of the XTCC$W_ON_IOSB field is made nonzero, as performed by the XPORT_OUT_NOTIFY_SEND macro.
Sends notice that an output operation has completed.
XPORT_OUT_NOTIFY_SEND xtcc, xtpb, type
xtcc
VMS usage: record type: xtcc access: modify mechanism: reference
The XTCC of the connection for which you want to send output notification.xtpb
VMS usage: record type: xtpb access: modify mechanism: reference
The XTPB of the connection for which you want to send output notification.type
VMS usage: longword type: longword access: read mechanism: value
The type of output free queue you are interested in. Valid types are DECW$C_XPORT_BUFFER_SRP and DECW$C_XPORT_BUFFER_LRP.
The XPORT_OUT_NOTIFY_SEND macro conditionally performs the operations that inform a process that an output operation has completed. These operations consist of sending a user-mode AST to the process in the case where the XTPB$A_O_NOTIFY_RTNADR field points to a procedure to call for output notification, or of code that completes the $SYNCH system service call performed by the XPORT_OUT_NOTIFY_WAIT macro.
Returns the number of data bytes in an XTCB.
XPORT_XTCB_FILLED xtcb
xtcb
VMS usage: record type: xtcb access: modify mechanism: reference
The XTCB for which you want to return the number of data bytes in an XTCB.
The XPORT_XTCB_FILLED macro returns the number of data bytes in an XTCB.
Determines the total number of bytes in the data area of an XTCB.
XPORT_XTCB_TOTAL xtcb
xtcb
VMS usage: record type: xtcb access: modify mechanism: reference
The XTCB for which you want to determine the total number of bytes in the data area of an XTCB.
The XPORT_XTCB_TOTAL macro determines the total number of bytes in the data area of an XTCB.
Determines the number of unused bytes in the data area of an XTCB.
XPORT_XTCB_FREE xtcb
xtcb
VMS usage: record type: xtcb access: modify mechanism: reference
The XTCB for which you want to determine the number of unused bytes in the data area of an XTCB.
The XPORT_XTCB_FREE macro determines the number of unused bytes in the data area of an XTCB.
Waits for the output work queue to empty.
XPORT_WRITE_WAIT xtcc, xtpb
xtcc
VMS usage: record type: xtcc access: modify mechanism: reference
The XTCC for the connection on which you want to wait.xtpb
VMS usage: record type: xtpb access: modify mechanism: reference
The XTPB for the connection on which you want to wait.
The XPORT_WRITE_WAIT macro performs a $SYNCH system service to wait for the output work queue to empty. XPORT_WRITE_WAIT is similar to XPORT_OUT_NOTIFY_WAIT, but uses the XTCC$W_OW_IOSB field. Also, because there are no equivalents to the XPORT_OUT_NOTIFY_SET and XPORT_OUT_NOTIFY_CLEAR macros, you must manually clear the XTCC$W_OW_IOSB field, or set or clear the XTCC$V_WAIT_ON_WRITE bit.
Reenables output work queue write operations.
XPORT_WRITE_UNWAIT xtcc, xtpb
xtcc
VMS usage: record type: xtcc access: modify mechanism: reference
The XTCC for which you no longer want to wait.xtpb
VMS usage: record type: xtpb access: modify mechanism: reference
The XTPB for which you no longer want to wait.
The XPORT_WRITE_UNWAIT macro cancels the wait on the output work queue initiated by XPORT_WRITE_WAIT.
Declares a user-mode AST to the process indicating that the connection has aborted.
XPORT_ABORT_SEND xtdb, xtcc
xtdb
VMS usage: record type: xtdb access: modify mechanism: reference
The XTDB for which you want to abort the connection.xtcc
VMS usage: record type: xtcc access: modify mechanism: reference
The XTCC for which you want to abort the connection.
The XPORT_ABORT_SEND macro declares a user-mode AST to the user-provided connection-abort notification routine, identified by the XTDB$A_CONNECT_ABORT field, indicating that the connection has aborted.If the XTCC$V_MARK_FOR_CLOSE flag is set, XPORT_ABORT_SEND does not declare an AST but calls the routine identified by the XTDB$A_CONNECT_ABORT field.
XPORT_ABORT_SEND is called as part of the abort notification.
Clears the write disable flag.
XPORT_OUT_WRITE_ENABLE xtcc
VMS usage: longword type: longword access: write mechanism: value Returns true (1) if the XTCC$L_OWQ_FLAG field was clear, that is, if write operations were already enabled, or false (0) if it was set.
xtcc
VMS usage: record type: xtcc access: modify mechanism: reference
The XTCC for which you want to enable write operations.
The XPORT_OUT_WRITE_ENABLE macro clears the write disable flag for this connection and returns true (1) if it was clear or false (0) if it was set.
| Previous | Next | Contents | Index |