ServerTransaction class

Article
11/13/2008

Microsoft Office Live Communications Server 2005 with SP1

ServerTransaction

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 RequestReceivedEventArgs.ServerTransaction property, available on the RequestReceivedEventArgs object dispatched to a specific method by the MSPL script filter. (See the Dispatch MSPL built-in function for more information.) There are no public constructors for this class.

The request being serviced by this server transaction can be forwarded by calling ServerTransaction.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 ServerTransaction.Branches property. Requests are sent by calling ClientTransaction.SendRequest on each branch.

To send a response for the request the server transaction was created to service, call ServerTransaction.SendResponse with the Response object created by calling Request.CreateResponse on the Request object available in the RequestReceivedEventArgs.Request property.

The ServerTransaction class is derived from the Microsoft.Rtc.Sip.Transaction class.

Public Methods

The ServerTransaction class has the following public methods.

Method	Description
Cancel()	Inherited from Transaction. Cancels the transaction and raises the Canceled event.
ChallengeRequest()	Sends an authentication challenge response to the client transaction whose request is attempting to initiate this server transaction.
CreateBranch()	Adds a new ClientTransaction object to the Branches property.
Dispose()	Inherited from Transaction. Releases all resources used by this object and destroys it.
Equals(Object)	Inherited from System.Object. Determines whether the specified System.Object is equal to the current System.Object.
GetHashCode()	Inherited from System.Object. Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType()	Inherited from System.Object. Gets the System.Type of the current instance.
SendResponse(Response)	Sends a SIP response message to the client transaction whose request initiated this server transaction.
ToString()	Inherited from System.Object. Returns a System.String that represents the current System.Object.

Public Properties

The ServerTransaction class has the following public properties.

Property	Description
Branches	Data type: BranchCollection Access type: Read-only Contains all branches (client transactions) associated with this server transaction as a BranchCollection object.
EnableForking	Data type: Boolean Access type: Read/write Indicates whether request forking is enabled or not.
OriginationTime	Data type: DateTime Access type: Read-only Inherited from Transaction. Contains the date and time the transaction originated.
Request	Data type: Request Access type: Read-only Inherited from Transaction. Contains the Request object that initiated the transaction.
Responses	Data type: ResponseCollection Access type: Read-only Inherited from Transaction. Contains a collection of all Response objects associated with the transaction.
SyncRoot	Data type: Object Access type: Read-only Inherited from Transaction. Contains an object used for synchronizing access to a group of objects related to a server or client transaction.

Public Events

The ServerTransaction class has the following public events.

Event	Description
Canceled	Inherited from Transaction. Occurs when the transaction is canceled.
Terminated	Inherited from Transaction. Occurs when the transaction is terminated.
TimedOut	Inherited from Transaction. Occurs when the transaction times out.

Protected Methods

The ServerTransaction class has the following protected methods.

Method	Description
CheckDisposed()	Inherited from Transaction. Throws ObjectDisposedException if the transaction is in the disposed state.
Close()	Inherited from Transaction. Releases all resources associated with the transaction.
Dispose(Boolean)	Inherited from Transaction. Destroys this transaction and releases all unmanaged resources as well as optionally releasing all managed ones.
Finalize()	Inherited from Transaction. Provides a finalizer for this instance of the Transaction class.
OnCanceled()	Inherited from Transaction. Raises the Transaction.Canceled event.
OnTerminated()	Inherited from Transaction. Raises the Transaction.Terminated event.
OnTimedOut()	Inherited from Transaction. Raises the Transaction.TimedOut event.

Requirements

Redistributable: Requires Microsoft Office Live Communications Server 2005 with SP1.
Namespace: Microsoft.Rtc.Sip
Assembly: ServerAgent (in ServerAgent.dll)