Response 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.

The Response class defines a SIP response sent from a server transaction to a client transaction.To generate a response message for a request, call CreateResponse() on the associated Request object. Populate the Response message with the proper status class and reason phrase, and then pass it to SendResponse(Response), using the ServerTransaction object for the initial request.There are two methods for receiving a response:First, the response is filtered by the MSPL message filter and dispatched to a specific method that is defined in your application. (For more information, see the Dispatch built-in MSPL function.) The method handling the response must have a signature that matches the RequestReceivedEventHandler delegate. Second, the originating request that incurred the response was sent from a specific ClientTransaction object instance that is running on your application. In this case, the response is obtained by registering an event handler for the ResponseReceived event. In both cases, the response is returned as the Response property, which contains a Response object. In the case where a ClientTransaction object on the application incurred the response, the ClientTransaction property will contain a reference to the specific client transaction.

public ref class Response : Microsoft::Rtc::Sip::Message

public class Response : Microsoft.Rtc.Sip.Message

Public Class Response
Inherits Message

Inheritance: Object

ReplicatedObject

Message
Response

Constructors

Response()

Protected constructor to prevent public use.

Fields

marshalContent	The marshalContent field is used to marshal content. (Inherited from Message)
state	(Inherited from ReplicatedObject)

Properties

AllHeaders	Collection that contains all of the headers for this message. (Inherited from Message)
AllStamps	Returns all the stamps that are associated with the message. (Inherited from Message)
AuthenticationInfo	Stack-specific authentication information. (Inherited from Message)
Content	Message content parsed as a string. (Inherited from Message)
RawContent	Raw message content. (Inherited from Message)
ReasonPhrase	Text explanation of the status code.
Received	Indicates whether this message was received by the server (as opposed to having been created by the calling application). (Inherited from Message)
Stamp	The Stamp property contains the string that is used to stamp a message. Setting Stamp marks the message with the supplied string, which can then be read either by the application or downstream instances of the application. (Inherited from Message)
StampPool	The StampPool property specifies the name of the Enterprise Edition pool in which the last stamp for the application was set. (Inherited from Message)
StatusClass	The StatusClass property contains the class of the numeric SIP status code.
StatusCode	The StatusCode property contains the numeric SIP status code for the response.
TimeReceived	The TimeReceived property indicates the date and time (represented as a DateTime object) the message was received by the server. (Inherited from Message)

Methods

GetHeaders(String)	A read-only collection of headers of the specified type. (Inherited from Message)
GetStatusClass(Int32)	Numeric SIP status code class - static version.
InitializeMarshaled(ServerAgent, ObjectSpace, UInt32)	(Inherited from ReplicatedObject)
InitializeUnmarshaled(ReplicatedObject)	Initializes an object that is created by the application in the Unmarshaled state. (Inherited from Message)
InitializeUnmarshaled(ServerAgent, ObjectSpace)	(Inherited from ReplicatedObject)
SetMarshaled()	Updates state to Marshaled.

Explicit Interface Implementations

ICloneable.Clone()

Creates a copy of this object.

(Inherited from Message)

Applies to