Show / Hide Table of Contents

Class UACInviteTransaction

SIP transaction that initiates a call to a SIP User Agent Server. This transaction processes outgoing calls SENT by the application.

Inheritance
System.Object
SIPTransaction
UACInviteTransaction
Inherited Members
SIPTransaction.logger
SIPTransaction.m_maxRingTime
SIPTransaction.Retransmits
SIPTransaction.AckRetransmits
SIPTransaction.PrackRetransmits
SIPTransaction.InitialTransmit
SIPTransaction.LastTransmit
SIPTransaction.DeliveryPending
SIPTransaction.DeliveryFailed
SIPTransaction.HasTimedOut
SIPTransaction.TransactionId
SIPTransaction.TransactionType
SIPTransaction.Created
SIPTransaction.CompletedAt
SIPTransaction.TimedOutAt
SIPTransaction.m_branchId
SIPTransaction.BranchId
SIPTransaction.m_callId
SIPTransaction.m_localTag
SIPTransaction.m_remoteTag
SIPTransaction.AckRequest
SIPTransaction.PRackRequest
SIPTransaction.TransactionRequestURI
SIPTransaction.TransactionRequestFrom
SIPTransaction.OutboundProxy
SIPTransaction.CDR
SIPTransaction.TransactionState
SIPTransaction.m_transactionRequest
SIPTransaction.TransactionRequest
SIPTransaction.UnreliableProvisionalResponse
SIPTransaction.ReliableProvisionalResponse
SIPTransaction.RSeq
SIPTransaction.m_transactionFinalResponse
SIPTransaction.TransactionFinalResponse
SIPTransaction.PrackSupported
SIPTransaction.TransactionInformationResponseReceived
SIPTransaction.TransactionFinalResponseReceived
SIPTransaction.TransactionFailed
SIPTransaction.OnAckRequestReceived
SIPTransaction.TransactionDuplicateResponse
SIPTransaction.TransactionRequestRetransmit
SIPTransaction.TransactionStateChanged
SIPTransaction.TransactionTraceMessage
SIPTransaction.m_sipTransport
SIPTransaction.GetRequestTransactionId(String, SIPMethodsEnum)
SIPTransaction.GotResponse(SIPEndPoint, SIPEndPoint, SIPResponse)
SIPTransaction.UpdateTransactionState(SIPTransactionStatesEnum)
SIPTransaction.SendFinalResponse(SIPResponse)
SIPTransaction.SendProvisionalResponse(SIPResponse)
SIPTransaction.SendReliableRequest()
SIPTransaction.GetInfoResponse(SIPRequest, SIPResponseStatusCodesEnum)
SIPTransaction.ACKReceived(SIPEndPoint, SIPEndPoint, SIPRequest)
SIPTransaction.PRACKReceived(SIPEndPoint, SIPEndPoint, SIPRequest)
SIPTransaction.SendRequestAsync(SIPRequest)
SIPTransaction.OnRetransmitFinalResponse()
SIPTransaction.OnRetransmitProvisionalResponse()
SIPTransaction.OnTimedOutProvisionalResponse()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: SIPSorcery.SIP
Assembly: SIPSorcery.dll
Syntax
public class UACInviteTransaction : SIPTransaction

Constructors

| Improve this Doc View Source

UACInviteTransaction(SIPTransport, SIPRequest, SIPEndPoint, Boolean)

Default constructor for user agent client INVITE transaction.

Declaration
public UACInviteTransaction(SIPTransport sipTransport, SIPRequest sipRequest, SIPEndPoint outboundProxy, bool sendOkAckManually = false)
Parameters
Type Name Description
SIPTransport sipTransport
SIPRequest sipRequest
SIPEndPoint outboundProxy
System.Boolean sendOkAckManually

If set an ACK request for the 2xx response will NOT be sent and it will be up to the application to explicitly call the SendACK request.

| Improve this Doc View Source

UACInviteTransaction(SIPTransport, SIPRequest, SIPEndPoint, Boolean, Boolean)

Default constructor for user agent client INVITE transaction.

Declaration
[Obsolete("Please use the new constructor without disablePrackSupport. Note the original implementation of disablePrackSupport does not behave as previously summarised.")]
public UACInviteTransaction(SIPTransport sipTransport, SIPRequest sipRequest, SIPEndPoint outboundProxy, bool sendOkAckManually, bool disablePrackSupport)
Parameters
Type Name Description
SIPTransport sipTransport
SIPRequest sipRequest
SIPEndPoint outboundProxy
System.Boolean sendOkAckManually

If set an ACK request for the 2xx response will NOT be sent and it will be up to the application to explicitly call the SendACK request.

System.Boolean disablePrackSupport

If set to true then PRACK support will not be set in the initial INVITE request.

Methods

| Improve this Doc View Source

AckAnswer(SIPResponse, String, String)

Sends AckAnswer response.

Declaration
public void AckAnswer(SIPResponse sipResponse, string content, string contentType)
Parameters
Type Name Description
SIPResponse sipResponse

SIPResponse to acknowledge

System.String content

The optional content body for the ACK request.

System.String contentType

The optional content type.

| Improve this Doc View Source

CancelCall(String)

Cancels this transaction. This does NOT generate a CANCEL request. A separate reliable transaction needs to be created for that.

Declaration
public void CancelCall(string cancelReason = null)
Parameters
Type Name Description
System.String cancelReason

The reason for cancelling the transaction.

| Improve this Doc View Source

SendInviteRequest()

Declaration
public void SendInviteRequest()

Events

| Improve this Doc View Source

UACInviteTransactionFailed

Declaration
public event SIPTransactionFailedDelegate UACInviteTransactionFailed
Event Type
Type Description
SIPTransactionFailedDelegate
| Improve this Doc View Source

UACInviteTransactionFinalResponseReceived

Declaration
public event SIPTransactionResponseReceivedDelegate UACInviteTransactionFinalResponseReceived
Event Type
Type Description
SIPTransactionResponseReceivedDelegate
| Improve this Doc View Source

UACInviteTransactionInformationResponseReceived

Declaration
public event SIPTransactionResponseReceivedDelegate UACInviteTransactionInformationResponseReceived
Event Type
Type Description
SIPTransactionResponseReceivedDelegate

Extension Methods

JSONWriter.ToJson(Object)
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX