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 | |
---|---|---|
ClientTransaction () () () () | Protected constructor that prevents direct creation of the server transaction objects by general callers. | |
ClientTransaction(ServerAgent) | Creates a new client transaction. |
Properties
Name | Description | |
---|---|---|
IsForked | Fork state of the outgoing client transaction. | |
MarshalContent | Determines whether the content body of the SIP message is marshaled or is not marshaled.(Inherited from Transaction.) | |
OriginationTime | Time the transaction was originated.(Inherited from Transaction.) | |
Request | Request that started the transaction.(Inherited from Transaction.) | |
Responses | Collection of responses in the transaction.(Inherited from Transaction.) | |
ServerAgent | The ServerAgent which created this transaction.(Inherited from Transaction.) | |
ServerTransaction | The ServerTransactionproperty contains the root ServerTransaction object for which this client transaction is a branch. | |
SyncRoot | Object space used for synchronizing access to a group of objects related to a server or a UAC transaction.(Inherited from Transaction.) | |
TraceCorrelationId | Trace Correlation ID.(Inherited from Transaction.) | |
TraceFilterMatch | Determines whether the message matches any existing trace filter.(Inherited from Transaction.) |
Methods
Name | Description | |
---|---|---|
Cancel () () () () | Cancels the client transaction. | |
Cancel(CancelContext) | Cancels the client transaction. | |
CheckDisposed | Throws an [ObjectDisposedException] if the object is in the disposed state.(Inherited from Transaction.) | |
Close | Allows derived classes to provide custom lifetime management.(Inherited from Transaction.) | |
Dispose () () () () | Releases all resources used by this object.(Inherited from Transaction.) | |
Dispose(Boolean) | Releases the unmanaged resources used by this object and optionally releases the managed resources.(Inherited from Transaction.) | |
Equals | (Inherited from Object.) | |
Finalize | The Finalizemethod provides a finalizer for this instance of the Transactionclass.(Inherited from Transaction.) | |
GetCorrelationId | Trace correlation ID.(Inherited from Transaction.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
IsTraceFilterMatch | Determines whether the message matches any existing trace filter.(Inherited from Transaction.) | |
MemberwiseClone | (Inherited from Object.) | |
OnCanceled | Raises the [Canceled] event.(Inherited from Transaction.) | |
OnResponseReceived | The OnResponseReceivedmethod raises the ResponseReceived event. | |
OnTerminated | Raises the Terminated event.(Inherited from Transaction.) | |
OnTimedOut | Raises the TimedOut event.(Inherited from Transaction.) | |
SendRequest | The SendRequestmethod sends a SIP request to a server transaction on a proxy or user account system (UAS). | |
ToString | (Inherited from Object.) |
Events
Name | Description | |
---|---|---|
Canceled | Occurs when the transaction has been canceled.(Inherited from Transaction.) | |
ResponseReceived | The ResponseReceivedevent is raised when a response message for the request sent by the ClientTransaction object is received. | |
Terminated | Occurs when the transaction is terminated.(Inherited from Transaction.) | |
TimedOut | Occurs when the transaction has timed out.(Inherited from Transaction.) |
Fields
Name | Description | |
---|---|---|
simpleProxy | For internal use.(Inherited from Transaction.) |