The ClientTransactionclass defines a SIP client transaction object located on a SIP proxy.

A ClientTransactionobject is created by calling the CreateBranch () () () () method on a ServerTransaction object. To fork the proxy behavior, ServerTransaction.CreateBranchcan be called multiple times. However, a ClientTransactionobject can service only one request. To send the request, call the SendRequest(Request) method.

To handle the responses for the request that are sent by a specific client transaction, you must register for the ResponseReceived event. This event returns a ResponseReceivedEventArgs object whenever it is raised, and contains the response as a Response class object.

Currently, the User Account Control (UAC) client transaction case is not supported, where the server originates a client transaction. Only proxy behaviors are available for this class

The ClientTransactionclass is derived from the Transaction class.

The ClientTransactiontype exposes the following members.

Constructors

  Name Description
Protected method ClientTransaction () () () () Protected constructor that prevents direct creation of the server transaction objects by general callers.
Public method ClientTransaction(ServerAgent) Creates a new client transaction.
Top

Properties

  Name Description
Public property IsForked Fork state of the outgoing client transaction.
Public property MarshalContent Determines whether the content body of the SIP message is marshaled or is not marshaled.(Inherited from Transaction.)
Public property OriginationTime Time the transaction was originated.(Inherited from Transaction.)
Public property Request Request that started the transaction.(Inherited from Transaction.)
Public property Responses Collection of responses in the transaction.(Inherited from Transaction.)
Public property ServerAgent The ServerAgent which created this transaction.(Inherited from Transaction.)
Public property ServerTransaction The ServerTransactionproperty contains the root ServerTransaction object for which this client transaction is a branch.
Public property SyncRoot Object space used for synchronizing access to a group of objects related to a server or a UAC transaction.(Inherited from Transaction.)
Public property TraceCorrelationId Trace Correlation ID.(Inherited from Transaction.)
Public property TraceFilterMatch Determines whether the message matches any existing trace filter.(Inherited from Transaction.)
Top

Methods

  Name Description
Public method Cancel () () () () Cancels the client transaction.
Public method Cancel(CancelContext) Cancels the client transaction.
Protected method CheckDisposed Throws an [ObjectDisposedException] if the object is in the disposed state.(Inherited from Transaction.)
Protected method Close Allows derived classes to provide custom lifetime management.(Inherited from Transaction.)
Public method Dispose () () () () Releases all resources used by this object.(Inherited from Transaction.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by this object and optionally releases the managed resources.(Inherited from Transaction.)
Public method Equals (Inherited from Object.)
Protected method Finalize The Finalizemethod provides a finalizer for this instance of the Transactionclass.(Inherited from Transaction.)
Public method GetCorrelationId Trace correlation ID.(Inherited from Transaction.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method IsTraceFilterMatch Determines whether the message matches any existing trace filter.(Inherited from Transaction.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnCanceled Raises the [Canceled] event.(Inherited from Transaction.)
Protected method OnResponseReceived The OnResponseReceivedmethod raises the ResponseReceived event.
Protected method OnTerminated Raises the Terminated event.(Inherited from Transaction.)
Protected method OnTimedOut Raises the TimedOut event.(Inherited from Transaction.)
Public method SendRequest The SendRequestmethod sends a SIP request to a server transaction on a proxy or user account system (UAS).
Public method ToString (Inherited from Object.)
Top

Events

  Name Description
Public event Canceled Occurs when the transaction has been canceled.(Inherited from Transaction.)
Public event ResponseReceived The ResponseReceivedevent is raised when a response message for the request sent by the ClientTransaction object is received.
Public event Terminated Occurs when the transaction is terminated.(Inherited from Transaction.)
Public event TimedOut Occurs when the transaction has timed out.(Inherited from Transaction.)
Top

Fields

  Name Description
Protected field simpleProxy For internal use.(Inherited from Transaction.)
Top

See also