SolrNet: HttpWebAdapters.IHttpWebResponse Interface Reference

SolrNet

HttpWebAdapters.IHttpWebResponse Interface Reference

Inheritance diagram for HttpWebAdapters.IHttpWebResponse:

List of all members.

Public Member Functions

string GetResponseHeader (string headerName)
 Gets the contents of a header that was returned with the response.
void Close ()
 When overridden by a descendant class, closes the response stream.
Stream GetResponseStream ()
 When overridden in a descendant class, returns the data stream from the Internet resource.

Properties

CookieCollection Cookies [get, set]
 Gets or sets the cookies that are associated with this response.
string ContentEncoding [get]
 Gets the method that is used to encode the body of the response.
string CharacterSet [get]
 Gets the character set of the response.
string Server [get]
 Gets the name of the server that sent the response.
DateTime LastModified [get]
 Gets the last date and time that the contents of the response were modified.
HttpStatusCode StatusCode [get]
 Gets the status of the response.
string StatusDescription [get]
 Gets the status description returned with the response.
Version ProtocolVersion [get]
 Gets the version of the HTTP protocol that is used in the response.
string Method [get]
 Gets the method that is used to return the response.
bool IsFromCache [get]
 Gets a T:System.Boolean value that indicates whether this response was obtained from the cache.
bool IsMutuallyAuthenticated [get]
 Gets a T:System.Boolean value that indicates whether mutual authentication occurred.
long ContentLength [get, set]
 When overridden in a descendant class, gets or sets the content length of data being received.
string ContentType [get, set]
 When overridden in a derived class, gets or sets the content type of the data being received.
Uri ResponseUri [get]
 When overridden in a derived class, gets the URI of the Internet resource that actually responded to the request.
WebHeaderCollection Headers [get]
 When overridden in a derived class, gets a collection of header name-value pairs associated with this request.

Member Function Documentation

void HttpWebAdapters.IHttpWebResponse.Close (  )

When overridden by a descendant class, closes the response stream.

Exceptions:
T:System.NotSupportedExceptionAny attempt is made to access the method, when the method is not overridden in a descendant class.

<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter.

string HttpWebAdapters.IHttpWebResponse.GetResponseHeader ( string  headerName )

Gets the contents of a header that was returned with the response.

Returns:
The contents of the specified header.
Parameters:
headerNameThe header value to return.
Exceptions:
T:System.ObjectDisposedExceptionThe current instance has been disposed.

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter, and HttpWebAdapters.WebResponseStub.

Stream HttpWebAdapters.IHttpWebResponse.GetResponseStream (  )

When overridden in a descendant class, returns the data stream from the Internet resource.

Returns:
An instance of the T:System.IO.Stream class for reading data from the Internet resource.
Exceptions:
T:System.NotSupportedExceptionAny attempt is made to access the method, when the method is not overridden in a descendant class.

<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter.


Property Documentation

string HttpWebAdapters.IHttpWebResponse.CharacterSet [get]

Gets the character set of the response.

Returns:
A string that contains the character set of the response.
Exceptions:
T:System.ObjectDisposedExceptionThe current instance has been disposed.

<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode"></PermissionSet>

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter, and HttpWebAdapters.WebResponseStub.

string HttpWebAdapters.IHttpWebResponse.ContentEncoding [get]

Gets the method that is used to encode the body of the response.

Returns:
A string that describes the method that is used to encode the body of the response.
Exceptions:
T:System.ObjectDisposedExceptionThe current instance has been disposed.

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter, and HttpWebAdapters.WebResponseStub.

long HttpWebAdapters.IHttpWebResponse.ContentLength [get, set]

When overridden in a descendant class, gets or sets the content length of data being received.

Returns:
The number of bytes returned from the Internet resource.
Exceptions:
T:System.NotSupportedExceptionAny attempt is made to get or set the property, when the property is not overridden in a descendant class.

<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter.

string HttpWebAdapters.IHttpWebResponse.ContentType [get, set]

When overridden in a derived class, gets or sets the content type of the data being received.

Returns:
A string that contains the content type of the response.
Exceptions:
T:System.NotSupportedExceptionAny attempt is made to get or set the property, when the property is not overridden in a descendant class.

<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter.

CookieCollection HttpWebAdapters.IHttpWebResponse.Cookies [get, set]

Gets or sets the cookies that are associated with this response.

Returns:
A T:System.Net.CookieCollection that contains the cookies that are associated with this response.
Exceptions:
T:System.ObjectDisposedExceptionThe current instance has been disposed.

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter, and HttpWebAdapters.WebResponseStub.

WebHeaderCollection HttpWebAdapters.IHttpWebResponse.Headers [get]

When overridden in a derived class, gets a collection of header name-value pairs associated with this request.

Returns:
An instance of the T:System.Net.WebHeaderCollection class that contains header values associated with this response.
Exceptions:
T:System.NotSupportedExceptionAny attempt is made to get or set the property, when the property is not overridden in a descendant class.

<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter.

bool HttpWebAdapters.IHttpWebResponse.IsFromCache [get]

Gets a T:System.Boolean value that indicates whether this response was obtained from the cache.

Returns:
true if the response was taken from the cache; otherwise, false.

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter.

bool HttpWebAdapters.IHttpWebResponse.IsMutuallyAuthenticated [get]

Gets a T:System.Boolean value that indicates whether mutual authentication occurred.

Returns:
true if both client and server were authenticated; otherwise, false.

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter.

DateTime HttpWebAdapters.IHttpWebResponse.LastModified [get]

Gets the last date and time that the contents of the response were modified.

Returns:
A T:System.DateTime that contains the date and time that the contents of the response were modified.
Exceptions:
T:System.ObjectDisposedExceptionThe current instance has been disposed.

<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter, and HttpWebAdapters.WebResponseStub.

string HttpWebAdapters.IHttpWebResponse.Method [get]

Gets the method that is used to return the response.

Returns:
A string that contains the HTTP method that is used to return the response.
Exceptions:
T:System.ObjectDisposedExceptionThe current instance has been disposed.

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter, and HttpWebAdapters.WebResponseStub.

Version HttpWebAdapters.IHttpWebResponse.ProtocolVersion [get]

Gets the version of the HTTP protocol that is used in the response.

Returns:
A T:System.Version that contains the HTTP protocol version of the response.
Exceptions:
T:System.ObjectDisposedExceptionThe current instance has been disposed.

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter, and HttpWebAdapters.WebResponseStub.

Uri HttpWebAdapters.IHttpWebResponse.ResponseUri [get]

When overridden in a derived class, gets the URI of the Internet resource that actually responded to the request.

Returns:
An instance of the T:System.Uri class that contains the URI of the Internet resource that actually responded to the request.
Exceptions:
T:System.NotSupportedExceptionAny attempt is made to get or set the property, when the property is not overridden in a descendant class.

<PermissionSet><IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" flags="UnmanagedCode, ControlEvidence"></PermissionSet>

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter.

string HttpWebAdapters.IHttpWebResponse.Server [get]

Gets the name of the server that sent the response.

Returns:
A string that contains the name of the server that sent the response.
Exceptions:
T:System.ObjectDisposedExceptionThe current instance has been disposed.

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter, and HttpWebAdapters.WebResponseStub.

HttpStatusCode HttpWebAdapters.IHttpWebResponse.StatusCode [get]

Gets the status of the response.

Returns:
One of the T:System.Net.HttpStatusCode values.
Exceptions:
T:System.ObjectDisposedExceptionThe current instance has been disposed.

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter, and HttpWebAdapters.WebResponseStub.

string HttpWebAdapters.IHttpWebResponse.StatusDescription [get]

Gets the status description returned with the response.

Returns:
A string that describes the status of the response.
Exceptions:
T:System.ObjectDisposedExceptionThe current instance has been disposed.

Implemented in HttpWebAdapters.Adapters.HttpWebResponseAdapter, and HttpWebAdapters.WebResponseStub.


The documentation for this interface was generated from the following file:
  • HttpWebAdapters/IHttpWebResponse.cs
Generated on Sun May 3 2015 17:19:05 for SolrNet by  doxygen 1.7.2