RequestReceivedEventArgs

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

RequestReceivedEventArgs

The RequestReceivedEventArgs class defines information to an application regarding the arrival of a SIP request.

When a request has been successfully dispatched by the MSPL message filter (see the Dispatch built-in function), an event containing a RequestReceivedEventArgs object will be dispatched to the specified method (whose signature must match the RequestReceivedEventHandler delegate). RequestReceivedEventArgs contains the request as the RequestReceivedEventArgs.Request property.

An instance of ServerTransaction is created as a property of RequestReceivedEventArgs. This property represents the new server transaction for the request. To forward this request, call ServerTransaction.CreateBranch to create a ClientTransaction and call ClientTransaction.SendRequest, passing the Request Sip Class object in the RequestReceivedEventArgs.Request property.

The RequestReceivedEventArgs class is derived from the System.Object class.

Public Methods

The RequestReceivedEventArgs class has the following public methods.

Method

Description

Equals(Object)

Inherited from Message. Determines whether the specified System.Object is equal to the current System.Object.

GetHashCode()

Inherited from Message. 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 Message. Gets the System.Type of the current instance.

ToString()

Inherited from Message. Returns a System.String that represents the current System.Object.

Public Properties

The RequestReceivedEventArgs class has the following public properties.

Property

Description

RequestReceivedEventArgs

Data type: Request

Access type: Read-only

Contains the Request object for the request that initiated the server transaction contained in RequestReceivedEventArgs.ServerTransaction.

RequestReceivedEventArgs.ServerTransaction

Data type: ServerTransaction

Access type: Read-only

Contains the new ServerTransaction object that will service the received request.

Requirements

Redistributable: Requires Microsoft Office Communications Server 2007 R2.

Namespace:Microsoft.Rtc.Sip

Assembly: ServerAgent (in ServerAgent.dll)

See Also

Concepts

Dispatch

Request Sip Class

RequestReceivedEventHandler

ServerTransaction