mcs/class/Mono.Posix/Documentation/en/Mono.Unix.Native/PosixMadviseAdvice.xml

   1 <Type Name="PosixMadviseAdvice" FullName="Mono.Unix.Native.PosixMadviseAdvice">
   2   <TypeSignature Language="C#" Value="public enum PosixMadviseAdvice" />
   3   <AssemblyInfo>
   4     <AssemblyName>Mono.Posix</AssemblyName>
   5     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Enum</BaseTypeName>
  10   </Base>
  11   <Docs>
  12     <summary>Possible <see cref="M:Mono.Unix.Native.Syscall.posix_madvise" /><paramref name="advice" /> values.</summary>
  13     <remarks />
  14     <altmember cref="M:Mono.Unix.Native.Syscall.posix_madvise" />
  15   </Docs>
  16   <Members>
  17     <Member MemberName="POSIX_MADV_DONTNEED">
  18       <MemberSignature Language="C#" Value="POSIX_MADV_DONTNEED" />
  19       <MemberType>Field</MemberType>
  20       <ReturnValue>
  21         <ReturnType>Mono.Unix.Native.PosixMadviseAdvice</ReturnType>
  22       </ReturnValue>
  23       <Docs>
  24         <summary>Allows the VM system to decrease the in-memory priority of pages in the specified range.  Additionally future references to this address range will incur a page fault.</summary>
  25       </Docs>
  26       <AssemblyInfo>
  27         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  28         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  29       </AssemblyInfo>
  30     </Member>
  31     <Member MemberName="POSIX_MADV_NORMAL">
  32       <MemberSignature Language="C#" Value="POSIX_MADV_NORMAL" />
  33       <MemberType>Field</MemberType>
  34       <ReturnValue>
  35         <ReturnType>Mono.Unix.Native.PosixMadviseAdvice</ReturnType>
  36       </ReturnValue>
  37       <Docs>
  38         <summary>Tells the system to revert to the default paging behavior.</summary>
  39       </Docs>
  40       <AssemblyInfo>
  41         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  42         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  43       </AssemblyInfo>
  44     </Member>
  45     <Member MemberName="POSIX_MADV_RANDOM">
  46       <MemberSignature Language="C#" Value="POSIX_MADV_RANDOM" />
  47       <MemberType>Field</MemberType>
  48       <ReturnValue>
  49         <ReturnType>Mono.Unix.Native.PosixMadviseAdvice</ReturnType>
  50       </ReturnValue>
  51       <Docs>
  52         <summary>Is a hint that pages will be accessed randomly, and prefetching is likely not advantageous.</summary>
  53       </Docs>
  54       <AssemblyInfo>
  55         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  56         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  57       </AssemblyInfo>
  58     </Member>
  59     <Member MemberName="POSIX_MADV_SEQUENTIAL">
  60       <MemberSignature Language="C#" Value="POSIX_MADV_SEQUENTIAL" />
  61       <MemberType>Field</MemberType>
  62       <ReturnValue>
  63         <ReturnType>Mono.Unix.Native.PosixMadviseAdvice</ReturnType>
  64       </ReturnValue>
  65       <Docs>
  66         <summary>Causes the VM system to depress the priority of pages immediately preceding a given page when it is faulted in.</summary>
  67       </Docs>
  68       <AssemblyInfo>
  69         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  70         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  71       </AssemblyInfo>
  72     </Member>
  73     <Member MemberName="POSIX_MADV_WILLNEED">
  74       <MemberSignature Language="C#" Value="POSIX_MADV_WILLNEED" />
  75       <MemberType>Field</MemberType>
  76       <ReturnValue>
  77         <ReturnType>Mono.Unix.Native.PosixMadviseAdvice</ReturnType>
  78       </ReturnValue>
  79       <Docs>
  80         <summary>Causes pages that are in a given virtual address range to temporarily have higher priority, and if they are in memory, decrease the likelihood of them being freed.  Additionally, the pages that are already in memory will be immediately mapped into the process, thereby eliminating unnecessary overhead of going through the entire process of faulting the pages in.  This WILL NOT fault pages in from backing store, but quickly map the pages already in memory into the calling process.</summary>
  81       </Docs>
  82       <AssemblyInfo>
  83         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  84         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  85       </AssemblyInfo>
  86     </Member>
  87   </Members>
  88   <Attributes>
  89     <Attribute>
  90       <AttributeName>System.CLSCompliant(false)</AttributeName>
  91     </Attribute>
  92   </Attributes>
  93 </Type>