HttpRequestCachePolicy Class

 

Defines an application's caching requirements for resources obtained by using HttpWebRequest objects.

Namespace:   System.Net.Cache
Assembly:  System (in System.dll)

System::Object
  System.Net.Cache::RequestCachePolicy
    System.Net.Cache::HttpRequestCachePolicy

public ref class HttpRequestCachePolicy : RequestCachePolicy

NameDescription
System_CAPS_pubmethodHttpRequestCachePolicy()

Initializes a new instance of the HttpRequestCachePolicy class.

System_CAPS_pubmethodHttpRequestCachePolicy(DateTime)

Initializes a new instance of the HttpRequestCachePolicy class using the specified cache synchronization date.

System_CAPS_pubmethodHttpRequestCachePolicy(HttpCacheAgeControl, TimeSpan)

Initializes a new instance of the HttpRequestCachePolicy class using the specified age control and time values.

System_CAPS_pubmethodHttpRequestCachePolicy(HttpCacheAgeControl, TimeSpan, TimeSpan)

Initializes a new instance of the HttpRequestCachePolicy class using the specified maximum age, age control value, and time value.

System_CAPS_pubmethodHttpRequestCachePolicy(HttpCacheAgeControl, TimeSpan, TimeSpan, DateTime)

Initializes a new instance of the HttpRequestCachePolicy class using the specified maximum age, age control value, time value, and cache synchronization date.

System_CAPS_pubmethodHttpRequestCachePolicy(HttpRequestCacheLevel)

Initializes a new instance of the HttpRequestCachePolicy class using the specified cache policy.

NameDescription
System_CAPS_pubpropertyCacheSyncDate

Gets the cache synchronization date for this instance.

System_CAPS_pubpropertyLevel

Gets the HttpRequestCacheLevel value that was specified when this instance was created.

System_CAPS_pubpropertyMaxAge

Gets the maximum age permitted for a resource returned from the cache.

System_CAPS_pubpropertyMaxStale

Gets the maximum staleness value that is permitted for a resource returned from the cache.

System_CAPS_pubpropertyMinFresh

Gets the minimum freshness that is permitted for a resource returned from the cache.

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string representation of this instance.(Overrides RequestCachePolicy::ToString().)

You can specify a default cache policy for your application by using the DefaultCachePolicy property or the application or machine configuration files. For more information, see <requestCaching> Element (Network Settings).

You can specify the cache policy for an individual request by using the CachePolicy property.

Caching for Web services is not supported.

The following code example creates a default cache policy for the application domain, and overrides it for a request.

// The following method demonstrates overriding the
// caching policy for a request.
static WebResponse^ GetResponseNoCache( Uri^ uri )
{
   // Set a default policy level for the "http:" and "https" schemes.
   HttpRequestCachePolicy^ policy = gcnew HttpRequestCachePolicy( HttpRequestCacheLevel::Default );
   HttpWebRequest::DefaultCachePolicy = policy;

   // Create the request.
   WebRequest^ request = WebRequest::Create( uri );

   // Define a cache policy for this request only. 
   HttpRequestCachePolicy^ noCachePolicy = gcnew HttpRequestCachePolicy( HttpRequestCacheLevel::NoCacheNoStore );
   request->CachePolicy = noCachePolicy;
   WebResponse^ response = request->GetResponse();
   Console::WriteLine( L"IsFromCache? {0}", response->IsFromCache );

   return response;
}

.NET Framework
Available since 2.0

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

Return to top
Show: