IHttpProtocolProvider.ProcessResponse Method

Article
12/03/2008

The distributor uses this method to pass an HTTP response from the destination HTTP server to the delivery protocol for processing.

Namespace: Microsoft.SqlServer.NotificationServices
Assembly: Microsoft.SqlServer.NotificationServices (in microsoft.sqlserver.notificationservices.dll)

Syntax

'Declaration
Function ProcessResponse ( _
    httpResponseCode As HttpStatusCode, _
    responseBody As String, _
    postSuccess As Boolean _
) As Boolean

bool ProcessResponse (
    HttpStatusCode httpResponseCode,
    string responseBody,
    bool postSuccess
)

bool ProcessResponse (
    HttpStatusCode httpResponseCode, 
    String^ responseBody, 
    bool postSuccess
)

boolean ProcessResponse (
    HttpStatusCode httpResponseCode, 
    String responseBody, 
    boolean postSuccess
)

function ProcessResponse (
    httpResponseCode : HttpStatusCode, 
    responseBody : String, 
    postSuccess : boolean
) : boolean

Parameters

httpResponseCode
A reference to an HttpStatusCode object that contains the HTTP response code.

responseBody
A String containing the body of the HTTP response.

postSuccess
A Boolean value indicating whether the post was successful from the HTTP delivery perspective. The responseBody parameter may contain a message indicating an application-level failure on the server.

Return Value

A Boolean value indicating whether the response indicates the post was successful.

Remarks

The postSuccess argument indicates whether the delivery succeeded at the HTTP level. This post status might conflict with the actual delivery status. For instance, the post might have succeeded at the HTTP level, but the delivery itself might have failed. The text HTTP response received from the server is supplied in the responseBody argument. You must evaluate the contents of this response to determine the actual delivery status, and then set the return value to indicate success or failure.

The simplest implementation of the ProcessResponse method is to return the postSuccess value that is passed to the ProcessResponse as the return value. This is the case if the HTTP response code is the only success or failure indicator from the remote delivery service (the target of the HTTP post).

Example

For an example of how to implement the ProcessResponse method, see the IHttpProtocolProvider topic.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms