HP OpenVMS Systems Documentation

Reports that the transport layer cannot continue attempting to reattach a transport.

Format

DECW$XPORT_REATTACH_FAILED tdb, status

RETURNS

VMS usage:	cond_value
type:	longword (unsigned)
access:	write
mechanism:	value

Returns a longword condition value in R0. Condition values returned by this routine are listed under Condition Values Returned.

Arguments

tdb

VMS usage:	record
type:	xtdb
access:	modify
mechanism:	reference

The XTDB of the transport to which the transport layer cannot continue attempting to reattach.

status

VMS usage:	longword
type:	longword (unsigned)
access:	read
mechanism:	value

The condition value of the failed reattach attempt.

Description

DECW$XPORT_REATTACH_FAILED builds a message vector that describes the failed reattach attempt. The first element in the message vector is DECW$_REATTACH_FAILED; the second element is the status argument.

When a transport shuts down, a specific transport can attempt to reattach that transport. If the specific transport is then unable to complete the reattach attempt, DECW$XPORT_REATTACH_FAILED is called.

The $PUTMSG system service is called in user mode regardless of the caller's mode:

• If DECW$XPORT_REATTACH_FAILED was called in user mode, it calls $PUTMSG to write the error message.
• If DECW$XPORT_REATTACH_FAILED was not called in user mode, it declares a user-mode AST to do the $PUTMSG.

Condition Values Returned

SS$_NORMAL	Routine successfully completed.
SS$_INSFMEM	There is insufficient memory to perform the operation.

Reports that the server rejected a connection request.

Format

DECW$XPORT_REFUSED_BY_SERVER status

RETURNS

VMS usage:	cond_value
type:	longword (unsigned)
access:	write
mechanism:	value

Returns a longword condition value in R0. Condition values returned by this routine are listed under Condition Values Returned.

Argument

status

VMS usage:	longword
type:	longword (unsigned)
access:	read
mechanism:	value

The condition value of the server's rejection.

Description

DECW$XPORT_REFUSED_BY_SERVER builds a message vector that describes the server's rejection of a connection request. The first element in the message vector is DECW$_REFUSED_BY_SERVER; the second element is the status argument.

The $PUTMSG system service is called in user mode regardless of the caller's mode:

• If DECW$XPORT_REFUSED_BY_SERVER was called in user mode, it calls $PUTMSG to write the error message.
• If DECW$XPORT_REFUSED_BY_SERVER was not called in user mode, it declares a user-mode AST to do the $PUTMSG.

Condition Values Returned

SS$_NORMAL	Routine successfully completed.
SS$_INSFMEM	There is insufficient memory to perform the operation.

Reports that an unexpected message was received from the underlying transport.

Format

DECW$XPORT_UNEXPECTED_MESSAG type

RETURNS

VMS usage:	cond_value
type:	longword (unsigned)
access:	write
mechanism:	value

Returns a longword condition value in R0. Condition values returned by this routine are listed under Condition Values Returned.

Argument

type

VMS usage:	longword
type:	longword (unsigned)
access:	read
mechanism:	value

The type of the unexpected message.

Description

DECW$XPORT_UNEXPECTED_MESSAG builds a message vector that describes an unexpected message. The only element in the message vector is DECW$_UNEXPECTED_MESSAGE.

The $PUTMSG system service is called in user mode regardless of the caller's mode:

• If DECW$XPORT_UNEXPECTED_MESSAG was called in user mode, it calls $PUTMSG to write the error message.
• If DECW$XPORT_UNEXPECTED_MESSAG was not called in user mode, it declares an AST to do the $PUTMSG.

DECW$XPORT_UNEXPECTED_MESSAG is currently used only by the DECnet transport.

Condition Values Returned

SS$_NORMAL	Routine successfully completed.
SS$_INSFMEM	There is insufficient memory to perform the operation.

Reports a message about an unknown connection from the underlying transport.

Format

DECW$XPORT_UNKNOWN_LINK unit

RETURNS

VMS usage:	cond_value
type:	longword (unsigned)
access:	write
mechanism:	value

Returns a longword condition value in R0. Condition values returned by this routine are listed under Condition Values Returned.

Argument

unit

VMS usage:	longword
type:	longword (unsigned)
access:	read
mechanism:	value

The unknown link's unit number.

Description

DECW$XPORT_UNKNOWN_LINK builds a message vector that describes an unknown connection. The only element of the vector is DECW$_UNKNOWN_LINK.

The $PUTMSG system service is called in user mode regardless of the caller's mode:

• If DECW$XPORT_UNKNOWN_LINK was called in user mode, it calls $PUTMSG to write the error message.
• If DECW$XPORT_UNKNOWN_LINK was not called in user mode, it declares a user-mode AST to do the $PUTMSG.

DECW$XPORT_UNKNOWN_LINK is currently used only by the DECnet transport.

Condition Values Returned

SS$_NORMAL	Routine successfully completed.
SS$_INSFMEM	There is insufficient memory to perform the operation.

Returns the address of the user write-protected IXTCC structure.

Format

DECW$XPORT_VALIDATE_STRUCT id, struct

RETURNS

VMS usage:	cond_value
type:	longword (unsigned)
access:	write
mechanism:	value

Returns a longword condition value in R0. Condition values returned by this routine are listed under Condition Values Returned.

Arguments

id

VMS usage:	longword
type:	longword (unsigned)
access:	read
mechanism:	value

A previously registered IXTCC structure ID (XTCC$L_ICI).

struct

VMS usage:	address
type:	ixtcc
access:	write
mechanism:	reference

Returns the address of the user write-protected IXTCC structure.

Description

DECW$XPORT_VALIDATE_STRUCT checks the user write-protected IXTCC structure ID and, if valid, returns its corresponding address. DECW$XPORT_VALIDATE_STRUCT invokes the DECW$XPORT_VALIDATE_STRUCT_JSB routine for callers using CALLS.

DECW$XPORT_VALIDATE_STRUCT is called in both user and executive modes.

Condition Values Returned

SS$_NORMAL	Routine successfully completed.
DECW$_NOT_INITIALIZED	The common transport is not initialized.
DECW$_INV_STRUCT_ID	The structure ID is not valid.

JSB routine that returns the address of the user write-protected IXTCC structure.

Format

DECW$XPORT_VALIDATE_STRUCT id, struct

RETURNS

VMS usage:	cond_value
type:	longword (unsigned)
access:	write
mechanism:	value

Returns a longword condition value in R0. Condition values returned by this routine are listed under Condition Values Returned.

Arguments

id

VMS usage:	longword
type:	longword (unsigned)
access:	read
mechanism:	value

A previously registered IXTCC structure ID (XTCC$L_ICI).

struct

VMS usage:	address
type:	ixtcc
access:	write
mechanism:	reference

Returns the address of the user write-protected IXTCC structure.

Description

DECW$XPORT_VALIDATE_STRUCT_JSB checks the ID of the user write-protected IXTCC structure. If a structure exists with that ID, DECW$XPORT_VALIDATE_STRUCT_JSB returns its corresponding address in the struct argument.

The VALIDATE_XTCC macro calls the DECW$XPORT_VALIDATE_STRUCT_JSB routine to validate an XTCC.

DECW$XPORT_VALIDATE_STRUCT_JSB is called in both user and executive modes.

Condition Values Returned

SS$_NORMAL	Routine successfully completed.
DECW$_NOT_INITIALIZED	The common transport is not initialized.
DECW$_INV_STRUCT_ID	The structure ID is not valid.

Validates that an XTCB is contained within the allocated storage for the connection and that it is correctly formed.

Format

DECW$XPORT_VALIDATE_XTCB itcc, tcb

RETURNS

VMS usage:	cond_value
type:	longword(unsigned)
access:	write
mechanism:	value

Returns a longword condition value to R0. Possible condition values are listed under Condition Values Returned.

Arguments

itcc

VMS usage:	record
type:	ixtcc
access:	modify
mechanism:	reference

The IXTCC of the connection for which you want to validate the XTCB.

tcb

VMS usage:	record
type:	xtcb
access:	modify
mechanism:	reference

The XTCB that you want to validate.

Description

DECW$XPORT_VALIDATE_XTCB invokes DECW$XPORT_VALIDATE_XTCB_JSB for callers using CALLS.

DECW$XPORT_VALIDATE_XTCB validates that an XTCB is contained within the allocated buffer storage for the connection and that it is correctly formed.

Either DECW$XPORT_VALIDATE_XTCB or DECW$XPORT_VALIDATE_XTCB_JSB must be called before an XTCB is used in executive mode.

DECW$XPORT_VALIDATE_XTCB can be called in both user and executive modes.

Condition Values Returned

SS$_NORMAL	Routine successfully completed.
DECW$_NOT_INITIALIZED	The common transport is not initialized.
DECW$_NOT_XTCB	The XTCB is not in the buffer region.
DECW$_ILLFORMED_XTCB	The XTCB header is not valid.
SS$_IVBUFLEN	The XTCB length field is not valid.

JSB routine that validates that an XTCB is contained within the allocated storage for the connection and that it is correctly formed.

Format

DECW$XPORT_VALIDATE_XTCB_JSB itcc, tcb

RETURNS

VMS usage:	cond_value
type:	longword(unsigned)
access:	write
mechanism:	value

Returns a longword condition value to R0. Possible condition values are listed under Condition Values Returned.

Arguments

itcc

VMS usage:	record
type:	ixtcc
access:	modify
mechanism:	reference

The IXTCC of the connection for which you want to validate the XTCB.

tcb

VMS usage:	record
type:	xtcb
access:	modify
mechanism:	reference

The XTCB that you want to validate.

Description

DECW$XPORT_VALIDATE_XTCB_JSB validates that an XTCB is contained within the allocated buffer storage for the connection and that it is correctly formed.

Either DECW$XPORT_VALIDATE_XTCB_JSB or DECW$XPORT_VALIDATE_XTCB must be called before an XTCB is used in executive mode.

DECW$XPORT_VALIDATE_XTCB_JSB can be called in both user and executive modes.

Condition Values Returned

SS$_NORMAL	Routine successfully completed.
DECW$_NOT_INITIALIZED	The common transport is not initialized.
DECW$_NOT_XTCB	The XTCB is not in the buffer region.
DECW$_ILLFORMED_XTCB	The XTCB header is not valid.
SS$_IVBUFLEN	The XTCB length field is not valid.

Initiates a write operation on the connection.

Format

DECW$$XPORT_WRITE tcc, xtcb, mode

RETURNS

VMS usage:	cond_value
type:	longword (unsigned)
access:	write
mechanism:	value

Returns a longword condition value in R0. Condition values returned by this routine are listed under Condition Values Returned.

Arguments

tcc

VMS usage:	record
type:	xtcc
access:	modify
mechanism:	reference

The XTCC of the connection from which you want to write.

xtcb

VMS usage:	record
type:	xtcb
access:	modify
mechanism:	reference

The XTCB you want to write to the connection.

mode

VMS usage:	longword
type:	longword
access:	read
mechanism:	value

Modifying flags for the write operation. The valid field is:

Constant	Description
DECW$M_MODE_NOWRTBLOCK	If the specific transport was blocked for the XTCB write operation, DECW$$XPORT_WRITE returns with a DECW$_BLOCKED status.

Description

The system service DECW$$XPORT_WRITE initiates a write operation on the connection associated with an XTCC. DECW$$XPORT_WRITE dispatches a write operation to the transport-specific write function.

DECW$$XPORT_WRITE calls the VALIDATE_XTCC macro to validate the XTCC. If it is valid, DECW$$XPORT_WRITE gets the XTFT from the IXTCC$A_XPORT_TABLE field and calls the transport-specific XTFT$A_WRITE routine in executive mode to actually write the XTCB.

Condition Values Returned

SS$_NORMAL	Routine successfully completed.
DECW$_CNXABORT	Connection is in abort condition.
DECW$_RECIO_OPE	Recursive I/O operation.
DECW$_BLOCKED	The transport blocked the write operation.