Legacy Document

Inside Macintosh: Networking /

Chapter 5 - AppleTalk Data Stream Protocol (ADSP) / ADSP Reference

Routines / Establishing and Terminating an ADSP Connection

dspRemove

The dspRemove routine closes any open connection and eliminates the connection
end, releasing all memory associated with it. You use the PBControl function to
call the dspRemove routine. See "Routines" on page 5-43 for a description of the PBControl function.

-->	ioCompletion	ProcPtr	A pointer to a completion routine.
<--	ioResult	OSErr	The function result.
-->	ioCRefNum	Integer	The driver reference number.
-->	csCode	Integer	Always dspRemove for this function.
-->	ccbRefNum	Integer	The CCB reference number.
-->	abort	Byte	A value specifying to abort connection if not 0.

Field Description

csCode

The routine selector, always equal to dspRemove for this routine.

ccbRefNum

The connection control block (CCB) reference number that was returned by the dspNewCID routine for the connection end that
you want to remove.

abort

A value that specifies whether or not to send all of the data in
the send queue and all outstanding messages before closing the connection end. If the abort parameter is nonzero, ADSP cancels any outstanding requests to send data packets (such as the dspAttention routine) and discards all data in the send queue.
If the abort parameter is 0, ADSP does not close the connection
end until all of the data in the send queue and all outstanding attention messages have been sent and acknowledged.

DESCRIPTION

The dspRemove routine closes the connection end whose connection control block (CCB) you specify, and it eliminates that connection end; that is, ADSP no longer retains control of the CCB, send queue, receive queue, and attention-message buffer. You cannot continue to read bytes from the receive queue after you have called the dspRemove routine. After you call the dspRemove routine, you can release all of the memory you allocated for the connection end if you do not intend to reopen the connection end.

ASSEMBLY-LANGUAGE INFORMATION

To execute the dspRemove routine from assembly language, call the _Control trap macro with a value of dspRemove in the csCode field of the parameter block.

RESULT CODES

noErr	0	No error
errRefNum	-1280	Bad connection reference number