ServerTransaction members

Lync 2013

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 [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 ServerTransaction class is derived from the Transaction class.

The ServerTransaction type exposes the following members.

  Name Description
Protected method ServerTransaction Protected constructor that prevents direct creation of server transaction objects by general callers.
Top

  Name Description
Public property Branches The Branches property contains all branches (client transactions) associated with this server transaction as a BranchCollection object.
Public property EnableForking Flag indicating whether this transaction might be forked.
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 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

  Name Description
Public method ChallengeRequest The ChallengeRequest method sends an authentication challenge response to the client transaction whose request is attempting to initiate this server 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 CreateBranch The CreateBranch method adds a new ClientTransaction object to the Branches property.
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 Finalize method provides a finalizer for this instance of the Transaction class. (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 OnTerminated Raises the Terminated event. (Inherited from Transaction.)
Protected method OnTimedOut Raises the TimedOut event. (Inherited from Transaction.)
Public method SendResponse The SendResponse method sends a SIP response message to the client transaction whose request initiated this server transaction.
Public method ToString (Inherited from Object.)
Top

  Name Description
Public event Canceled Occurs when the transaction has been canceled. (Inherited from Transaction.)
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

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