Method teRemove

Control/L3TranEntry.cpp:1926–1956

Used by MMLayer to immediately remove the transaction, without notifying MM layer. An assumption is that the dialog pointer is valid as long as the transaction exists, so we dont zero out the dialog pointer until we kill the dialog.

// An assumption is that the dialog pointer is valid as long as the transaction exists,
// so we dont zero out the dialog pointer until we kill the dialog.
void TranEntry::teRemove(CancelCause cause)
{
	CallState state = getGSMState();

	SipDialog *dialog = getDialog();
	mDialog = 0;

	if (dialog) {
		// For the special case of outbound handover we must destroy the dialog immediately
		// in case a new handover comes back to us in the reverse direction.
		// just drop the dialog, dont send a BYE.
		//bool terminate = (state == CCState::HandoverOutbound);
		if (state == CCState::HandoverOutbound) {
			cause = CancelCauseHandoverOutbound;
		}
		dialog->dialogCancel(cause);		// Does nothing if dialog not yet started.
	}

	// It is important to make this transaction no longer point at the dialog, because the dialog
	// will not destroy itself while a transaction still points at it.  Taking the transaction
	// out of the TransactionTable prevents the dialog from finding the transaction any longer.
	// However to prevent a race we must do this after using the dialog, which we did above.
	setGSMState(CCState::NullState);	// redundant, transaction is being deleted.
	gNewTransactionTable.ttRemove(this->tranID());

	while (currentProcedure()) {
		delete tran()->tePopMachine();
	}

	if (mContext) { mContext->mmDisconnectTran(this); }	// DANGER: this deletes the transaction as a side effect.
}

// Send closure messages for a transaction that is known to be a CS transaction, using the specified CC cause.
// Must only call from the thread running the channel.