Represents SIP server transactions.
The ServerTransactionclass defines a SIP server transaction object located on a SIP proxy or user agent server (UAS).
A ServerTransactioninstance is generated as the ServerTransaction property, available on the RequestReceivedEventArgs object dispatched to a specific method by the MSPL script filter. (For more information, see the Dispatch MSPL built-in function.) There are no public constructors for this class.
The request being serviced by this server transaction can be forwarded by calling CreateBranch () () () () , which will create an associated ClientTransaction . To fork a message, CreateBranchcan be called for each fork. The collection of branches for this server transaction can be obtained as a BranchCollection object by referencing the Branches property. Requests are sent by calling SendRequest(Request) on each branch.
To send a response for the request the server transaction was created to service, call [M:Microsoft.Rtc.Sip.ServerTransaction.SendResponse(Microsoft.Rtc.Sip.Response] with the Response object created by calling CreateResponse(Int32) on the Request object available in the Request property.
The ServerTransactionclass is derived from the Transaction class.
The ServerTransactiontype exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
ServerTransaction | Protected constructor that prevents direct creation of server transaction objects by general callers. |
Properties
| Name | Description | |
|---|---|---|
|
Branches | The Branchesproperty contains all branches (client transactions) associated with this server transaction as a BranchCollection object. |
|
|
EnableForking | Flag indicating whether this transaction might be forked. |
|
|
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.) |
|
|
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 | |
|---|---|---|
|
ChallengeRequest | The ChallengeRequestmethod sends an authentication challenge response to the client transaction whose request is attempting to initiate this server 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.) |
|
|
CreateBranch | The CreateBranchmethod adds a new ClientTransaction object to the Branches property. |
|
|
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.) |
|
|
OnTerminated | Raises the Terminated event.(Inherited from Transaction.) |
|
|
OnTimedOut | Raises the TimedOut event.(Inherited from Transaction.) |
|
|
SendResponse | The SendResponsemethod sends a SIP response message to the client transaction whose request initiated this server transaction. |
|
|
ToString | (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
|
Canceled | Occurs when the transaction has been canceled.(Inherited from Transaction.) |
|
|
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.) |
See also
