← Back to branch summary

~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.Foundation/NSDataReadingOptions.xml

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
Import upstream version 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
external/monomac/docs/en/MonoMac.Foundation/NSDataReadingOptions.xml
14
14
    </Attribute>
15
15
  </Attributes>
16
16
  <Docs>
17
 
    <summary>To be added.</summary>
18
 
    <remarks>To be added.</remarks>
 
17
    <summary>Flags that determine how NSData loads files.</summary>
 
18
    <remarks>
 
19
      <para>
 
20
        By default NSData will loads the contents of the file in memory
 
21
        by allocating a block of memory and then reading the contents of
 
22
        the file into it.
 
23
      </para>
 
24
      <para>
 
25
 
 
26
        The Mapped and MappedAlways parameter instruct NSData to use
 
27
        the kernel's interface to map the file into the process
 
28
        address space.  This has a few advantages: instead of
 
29
        allocating read/write memory for the process, that becomes
 
30
        real memory usage, the mapped versions map the file into
 
31
        memory which means that the data is loaded on demand instead
 
32
        of being loaded upfront.  This also allows the kernel to
 
33
        discard the data loaded from memory when the system is running
 
34
        low on memory. 
 
35
      </para>
 
36
    </remarks>
19
37
  </Docs>
20
38
  <Members>
21
39
    <Member MemberName="Coordinated">
48
66
        <ReturnType>MonoMac.Foundation.NSDataReadingOptions</ReturnType>
49
67
      </ReturnValue>
50
68
      <Docs>
51
 
        <summary>To be added.</summary>
 
69
        <summary>Use the kernel's virtual memory map to load the file, if possible. If sucessful, this replaces read/write memory that can be very expensive with discardable memory that is backed by a file.</summary>
52
70
      </Docs>
53
71
    </Member>
54
72
    <Member MemberName="MappedAlways">
67
85
        <ReturnType>MonoMac.Foundation.NSDataReadingOptions</ReturnType>
68
86
      </ReturnValue>
69
87
      <Docs>
70
 
        <summary>To be added.</summary>
 
88
        <summary>Force NSData to try to use the kernel's mapping support to load the file.   If sucessful, this replaces read/write memory that can be very expensive with discardable memory that is backed by a file.</summary>
71
89
      </Docs>
72
90
    </Member>
73
91
    <Member MemberName="Uncached">
81
99
        <ReturnType>MonoMac.Foundation.NSDataReadingOptions</ReturnType>
82
100
      </ReturnValue>
83
101
      <Docs>
84
 
        <summary>To be added.</summary>
 
102
        <summary>Notify the kernel that it should not try to cache the contents of this file in its buffer cache.</summary>
85
103
      </Docs>
86
104
    </Member>
87
105
  </Members>