mcs/class/Mono.Posix/Documentation/en/Mono.Unix/FileAccessPattern.xml

   1 <Type Name="FileAccessPattern" FullName="Mono.Unix.FileAccessPattern">
   2   <TypeSignature Language="C#" Value="public enum FileAccessPattern" />
   3   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed FileAccessPattern extends System.Enum" />
   4   <AssemblyInfo>
   5     <AssemblyName>Mono.Posix</AssemblyName>
   6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   9   </AssemblyInfo>
  10   <Base>
  11     <BaseTypeName>System.Enum</BaseTypeName>
  12   </Base>
  13   <Docs>
  14     <summary>Possible operating system hints for future file data access.</summary>
  15     <remarks>
  16       <para>Operating systems maintain a cache of all open files to speed up
  17     performance for common tasks.  The default caching behavior may not be
  18     appropriate for some tasks.  The <c>FileAccessPattern</c> enumeration
  19     contains possible alternate caching behaviors that your operating system
  20     may support.</para>
  21     </remarks>
  22     <altmember cref="M:Mono.Unix.FileHandleOperations.AdviseFileAccessPattern" />
  23     <altmember cref="M:Mono.Unix.UnixStream.AdviseFileAccessPattern" />
  24   </Docs>
  25   <Members>
  26     <Member MemberName="FlushCache">
  27       <MemberSignature Language="C#" Value="FlushCache" />
  28       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Unix.FileAccessPattern FlushCache = int32(4)" />
  29       <MemberType>Field</MemberType>
  30       <AssemblyInfo>
  31         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  32         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  33         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  34       </AssemblyInfo>
  35       <ReturnValue>
  36         <ReturnType>Mono.Unix.FileAccessPattern</ReturnType>
  37       </ReturnValue>
  38       <Docs>
  39         <summary>The specified data will not be needed, and should be removed
  40         from the disk cache if present.</summary>
  41       </Docs>
  42     </Member>
  43     <Member MemberName="NoReuse">
  44       <MemberSignature Language="C#" Value="NoReuse" />
  45       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Unix.FileAccessPattern NoReuse = int32(5)" />
  46       <MemberType>Field</MemberType>
  47       <AssemblyInfo>
  48         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  49         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  50         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  51       </AssemblyInfo>
  52       <ReturnValue>
  53         <ReturnType>Mono.Unix.FileAccessPattern</ReturnType>
  54       </ReturnValue>
  55       <Docs>
  56         <summary>The specified data will not be re-used (i.e. it will only be
  57         used once), so it shouldn't be kept around in the disk cache after it
  58         has been used..</summary>
  59       </Docs>
  60     </Member>
  61     <Member MemberName="Normal">
  62       <MemberSignature Language="C#" Value="Normal" />
  63       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Unix.FileAccessPattern Normal = int32(0)" />
  64       <MemberType>Field</MemberType>
  65       <AssemblyInfo>
  66         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  67         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  68         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  69       </AssemblyInfo>
  70       <ReturnValue>
  71         <ReturnType>Mono.Unix.FileAccessPattern</ReturnType>
  72       </ReturnValue>
  73       <Docs>
  74         <summary>No advice given.  This is the default.</summary>
  75       </Docs>
  76     </Member>
  77     <Member MemberName="PreLoad">
  78       <MemberSignature Language="C#" Value="PreLoad" />
  79       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Unix.FileAccessPattern PreLoad = int32(3)" />
  80       <MemberType>Field</MemberType>
  81       <AssemblyInfo>
  82         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  83         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  84         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  85       </AssemblyInfo>
  86       <ReturnValue>
  87         <ReturnType>Mono.Unix.FileAccessPattern</ReturnType>
  88       </ReturnValue>
  89       <Docs>
  90         <summary>The specified data will soon be accessed, so it should be
  91         pre-loaded.</summary>
  92       </Docs>
  93     </Member>
  94     <Member MemberName="Random">
  95       <MemberSignature Language="C#" Value="Random" />
  96       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Unix.FileAccessPattern Random = int32(1)" />
  97       <MemberType>Field</MemberType>
  98       <AssemblyInfo>
  99         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 100         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 101         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 102       </AssemblyInfo>
 103       <ReturnValue>
 104         <ReturnType>Mono.Unix.FileAccessPattern</ReturnType>
 105       </ReturnValue>
 106       <Docs>
 107         <summary>The specified data will be accessed in a random order.</summary>
 108       </Docs>
 109     </Member>
 110     <Member MemberName="Sequential">
 111       <MemberSignature Language="C#" Value="Sequential" />
 112       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Unix.FileAccessPattern Sequential = int32(2)" />
 113       <MemberType>Field</MemberType>
 114       <AssemblyInfo>
 115         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 116         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 117         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 118       </AssemblyInfo>
 119       <ReturnValue>
 120         <ReturnType>Mono.Unix.FileAccessPattern</ReturnType>
 121       </ReturnValue>
 122       <Docs>
 123         <summary>
 124         The application will access file data in a sequential order (from
 125         beginning of file to end of file).
 126         </summary>
 127       </Docs>
 128     </Member>
 129   </Members>
 130 </Type>