ServerTransaction Class

Reference

Definition

Namespace:: Microsoft.Rtc.Sip

Assembly:: ServerAgent.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents SIP server transactions.The ServerTransaction class defines a SIP server transaction object located on a SIP proxy or user agent server (UAS). A ServerTransaction instance 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, CreateBranch can 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 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 ServerTransaction class is derived from the Transaction class.

public ref class ServerTransaction : Microsoft::Rtc::Sip::Transaction

public class ServerTransaction : Microsoft.Rtc.Sip.Transaction

Public Class ServerTransaction
Inherits Transaction

Inheritance: Object

ReplicatedObject

Transaction
ServerTransaction

Remarks

Server transactions are used by UASs and proxies.

Constructors

ServerTransaction()

Protected constructor that prevents direct creation of server transaction objects by general callers.

Fields

simpleProxy	For internal use. (Inherited from Transaction)
state	(Inherited from ReplicatedObject)

Properties

Branches	The Branches property 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)
TraceCorrelationGuid	(Inherited from Transaction)
TraceCorrelationId	Trace Correlation ID. (Inherited from Transaction)
TraceFilterMatch	Determines whether the message matches any existing trace filter. (Inherited from Transaction)

Methods

ChallengeRequest()	The ChallengeRequest method 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 CreateBranch method 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)
GetCorrelationId()	Trace correlation ID. (Inherited from Transaction)
InitializeMarshaled(ServerAgent, ObjectSpace, UInt32)	(Inherited from ReplicatedObject)
InitializeUnmarshaled(ReplicatedObject)	(Inherited from ReplicatedObject)
InitializeUnmarshaled(ServerAgent, ObjectSpace)	(Inherited from ReplicatedObject)
IsTraceFilterMatch()	Determines whether the message matches any existing trace filter. (Inherited from Transaction)
OnCanceled(String)	(Inherited from Transaction)
OnTerminated()	Raises the Terminated event. (Inherited from Transaction)
OnTimedOut()	Raises the TimedOut event. (Inherited from Transaction)
SendResponse(Response)	The SendResponse method sends a SIP response message to the client transaction whose request initiated this server transaction.
SetMarshaled()	(Inherited from ReplicatedObject)

Events

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)

Applies to