NSPurgeableData Class Reference

Inherits from
Conforms to
Framework
/System/Library/Frameworks/Foundation.framework
Availability
Available in OS X v10.6 and later.
Declared in
NSData.h

Overview

You should use the NSPurgeableData class when you have objects with bytes that can be discarded when no longer needed. Purging these bytes may be advantageous for your system, because doing so frees up memory needed by other applications. The NSPurgeableData class provides a default implementation of the NSDiscardableContent protocol, from which it inherits its interface.

NSPurgeableData objects inherit their creation methods from their superclass, NSMutableData. All NSPurgeableData objects begin "accessed” to ensure that they are not instantly discarded (see NSDiscardableContent). The beginContentAccess method marks the object’s bytes as “accessed,” thus protecting them from being discarded, and must be called before accessing the object, or else an exception will be raised. This method returns YES if the bytes have not been discarded and if they have been successfully marked as “accessed”. Any method that directly or indirectly accesses these bytes or their length when they are not “accessed” will raise an exception. When you are done with the data, call endContentAccess to allow them to be discarded in order to quickly free up memory.

You may use these objects by themselves, and do not necessarily have to use them in conjunction with NSCache to get the purging behavior. The NSCache class incorporates a caching mechanism with some auto-removal policies to ensure that its memory footprint does not get too large.

NSPurgeableData objects should not be used as keys in hashing-based collections, because the value of the bytes pointer can change after every mutation of the data.

Adopted Protocols

NSDiscardableContent