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

   1 <Type Name="FileHandleOperations" FullName="Mono.Unix.FileHandleOperations">
   2   <TypeSignature Language="C#" Value="public sealed class FileHandleOperations" />
   3   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit FileHandleOperations extends System.Object" />
   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   <ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
  11   <Base>
  12     <BaseTypeName>System.Object</BaseTypeName>
  13   </Base>
  14   <Interfaces />
  15   <Docs>
  16     <summary>Operations that can be performed on a file handle.</summary>
  17     <remarks>
  18       The <see cref="T:Mono.Unix.FileHandleOperations" /> class provides
  19       access to operating system operations that effect file handles, such as
  20       <see cref="T:System.IO.FileStream" />s,
  21       <see cref="T:Mono.Unix.UnixStream" />s, and
  22       Unix file descriptors.
  23     </remarks>
  24   </Docs>
  25   <Members>
  26     <Member MemberName="AdviseFileAccessPattern">
  27       <MemberSignature Language="C#" Value="public static void AdviseFileAccessPattern (Mono.Unix.UnixStream stream, Mono.Unix.FileAccessPattern pattern);" />
  28       <MemberSignature Language="ILAsm" Value=".method public static hidebysig void AdviseFileAccessPattern(class Mono.Unix.UnixStream stream, valuetype Mono.Unix.FileAccessPattern pattern) cil managed" />
  29       <MemberType>Method</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>System.Void</ReturnType>
  37       </ReturnValue>
  38       <Parameters>
  39         <Parameter Name="stream" Type="Mono.Unix.UnixStream" />
  40         <Parameter Name="pattern" Type="Mono.Unix.FileAccessPattern" />
  41       </Parameters>
  42       <Docs>
  43         <param name="stream">File stream to advise.</param>
  44         <param name="pattern">
  45           A <see cref="T:Mono.Unix.FileAccessPattern" /> containing the file
  46           access pattern to suggest.
  47         </param>
  48         <summary>Advises a file access pattern for a file stream.</summary>
  49         <remarks>
  50           <para>
  51             <c>AdviseFileAccessPattern</c> is used to announce an intention
  52         to access file data with a specific pattern, allowing the kernel to
  53         perform appropriate optimizations.</para>
  54           <para>
  55             <paramref name="pattern" /> applies from beginning of file to end
  56           of file.</para>
  57           <para>The specified pattern is not binding; it merely constitutes an
  58         expectation on behalf of the application.</para>
  59         </remarks>
  60         <exception cref="T:System.ArgumentException">
  61           <para>
  62             <paramref name="stream" /> is not a valid file stream.
  63           </para>
  64           <para>-or-</para>
  65           <para>
  66             <paramref name="advice" /> is not a value.
  67           </para>
  68         </exception>
  69         <exception cref="T:System.ArgumentNullException">
  70           <paramref name="stream" />
  71           is <see langword="null" />.</exception>
  72         <exception cref="T:System.IO.IOException">
  73           <paramref name="stream" />
  74           refers to a pipe or FIFO.</exception>
  75         <altmember cref="M:Mono.Unix.Native.Syscall.posix_fadvise" />
  76       </Docs>
  77     </Member>
  78     <Member MemberName="AdviseFileAccessPattern">
  79       <MemberSignature Language="C#" Value="public static void AdviseFileAccessPattern (int fd, Mono.Unix.FileAccessPattern pattern);" />
  80       <MemberSignature Language="ILAsm" Value=".method public static hidebysig void AdviseFileAccessPattern(int32 fd, valuetype Mono.Unix.FileAccessPattern pattern) cil managed" />
  81       <MemberType>Method</MemberType>
  82       <AssemblyInfo>
  83         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  84         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  85         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  86       </AssemblyInfo>
  87       <ReturnValue>
  88         <ReturnType>System.Void</ReturnType>
  89       </ReturnValue>
  90       <Parameters>
  91         <Parameter Name="fd" Type="System.Int32" />
  92         <Parameter Name="pattern" Type="Mono.Unix.FileAccessPattern" />
  93       </Parameters>
  94       <Docs>
  95         <param name="fd">
  96           A <see cref="T:System.Int32" /> containing the file descriptor to advise.
  97         </param>
  98         <param name="pattern">
  99           A <see cref="T:Mono.Unix.FileAccessPattern" /> containing the file
 100           access pattern to suggest.
 101         </param>
 102         <summary>Advises a file access pattern for a Unix file descriptor.</summary>
 103         <remarks>
 104           <para>
 105             <c>AdviseFileAccessPattern</c> is used to announce an intention
 106         to access file data with a specific pattern, allowing the kernel to
 107         perform appropriate optimizations.</para>
 108           <para>
 109             <paramref name="pattern" /> applies from beginning of file to end
 110           of file.</para>
 111           <para>The specified pattern is not binding; it merely constitutes an
 112         expectation on behalf of the application.</para>
 113         </remarks>
 114         <exception cref="T:System.ArgumentException">
 115           <para>
 116             <paramref name="fd" /> is not a valid file descriptor.
 117           </para>
 118           <para>-or-</para>
 119           <para>
 120             <paramref name="advice" /> is not a valid value.
 121           </para>
 122         </exception>
 123         <exception cref="T:System.IO.IOException">
 124           <paramref name="fd" />
 125           refers to a pipe or FIFO.</exception>
 126         <altmember cref="M:Mono.Unix.Native.Syscall.posix_fadvise" />
 127       </Docs>
 128     </Member>
 129     <Member MemberName="AdviseFileAccessPattern">
 130       <MemberSignature Language="C#" Value="public static void AdviseFileAccessPattern (System.IO.FileStream file, Mono.Unix.FileAccessPattern pattern);" />
 131       <MemberSignature Language="ILAsm" Value=".method public static hidebysig void AdviseFileAccessPattern(class System.IO.FileStream file, valuetype Mono.Unix.FileAccessPattern pattern) cil managed" />
 132       <MemberType>Method</MemberType>
 133       <AssemblyInfo>
 134         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 135         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 136         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 137       </AssemblyInfo>
 138       <ReturnValue>
 139         <ReturnType>System.Void</ReturnType>
 140       </ReturnValue>
 141       <Parameters>
 142         <Parameter Name="file" Type="System.IO.FileStream" />
 143         <Parameter Name="pattern" Type="Mono.Unix.FileAccessPattern" />
 144       </Parameters>
 145       <Docs>
 146         <param name="file">File stream to advise.</param>
 147         <param name="pattern">
 148           A <see cref="T:Mono.Unix.FileAccessPattern" /> containing the file
 149           access pattern to suggest.
 150         </param>
 151         <summary>Advises a file access pattern for a file stream.</summary>
 152         <remarks>
 153           <para>
 154             <c>AdviseFileAccessPattern</c> is used to announce an intention
 155         to access file data with a specific pattern, allowing the kernel to
 156         perform appropriate optimizations.</para>
 157           <para>
 158             <paramref name="pattern" /> applies from beginning of file to end
 159                                 of file.</para>
 160           <para>The specified pattern is not binding; it merely constitutes an
 161         expectation on behalf of the application.</para>
 162         </remarks>
 163         <exception cref="T:System.ArgumentException">
 164           <para>
 165             <paramref name="file" /> is not a valid file stream.
 166           </para>
 167           <para>-or-</para>
 168           <para>
 169             <paramref name="advice" /> is not a valid value.
 170           </para>
 171         </exception>
 172         <exception cref="T:System.ArgumentNullException">
 173           <paramref name="file" />
 174           is <see langword="null" />.</exception>
 175         <exception cref="T:System.IO.IOException">
 176           <paramref name="file" />
 177           refers to a pipe or FIFO.</exception>
 178         <altmember cref="M:Mono.Unix.Native.Syscall.posix_fadvise" />
 179       </Docs>
 180     </Member>
 181     <Member MemberName="AdviseFileAccessPattern">
 182       <MemberSignature Language="C#" Value="public static void AdviseFileAccessPattern (Mono.Unix.UnixStream stream, Mono.Unix.FileAccessPattern pattern, long offset, long len);" />
 183       <MemberSignature Language="ILAsm" Value=".method public static hidebysig void AdviseFileAccessPattern(class Mono.Unix.UnixStream stream, valuetype Mono.Unix.FileAccessPattern pattern, int64 offset, int64 len) cil managed" />
 184       <MemberType>Method</MemberType>
 185       <AssemblyInfo>
 186         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 187         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 188         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 189       </AssemblyInfo>
 190       <ReturnValue>
 191         <ReturnType>System.Void</ReturnType>
 192       </ReturnValue>
 193       <Parameters>
 194         <Parameter Name="stream" Type="Mono.Unix.UnixStream" />
 195         <Parameter Name="pattern" Type="Mono.Unix.FileAccessPattern" />
 196         <Parameter Name="offset" Type="System.Int64" />
 197         <Parameter Name="len" Type="System.Int64" />
 198       </Parameters>
 199       <Docs>
 200         <param name="stream">File stream to advise.</param>
 201         <param name="pattern">
 202           A <see cref="T:Mono.Unix.FileAccessPattern" /> containing the file
 203           access pattern to suggest.
 204         </param>
 205         <param name="offset">
 206           A <see cref="T:System.Int64" /> containing the start of the range to suggest
 207           the <paramref name="pattern" /> access pattern.
 208         </param>
 209         <param name="len">
 210           A <see cref="T:System.Int64" /> containing the length of the range
 211           to suggest the <paramref name="pattern" />
 212           access pattern.  If <c>0</c>, <paramref name="pattern" /> is suggested
 213           until end-of-file.
 214         </param>
 215         <summary>Advises a file access pattern for a file stream.</summary>
 216         <remarks>
 217           <para>
 218             <c>AdviseFileAccessPattern</c> is used to announce an intention
 219         to access file data with a specific pattern, allowing the kernel to
 220         perform appropriate optimizations.</para>
 221           <para>
 222             <paramref name="pattern" /> applies to a region starting at
 223         <paramref name="offset" /> and extending for <paramref name="len" />
 224         bytes (or until end-of-file if <paramref name="len" /> is <c>0</c>)
 225         within the file specified by <paramref name="stream" />.  The specified
 226         region need not currently exist.</para>
 227           <para>The specified pattern is not binding; it merely constitutes an
 228         expectation on behalf of the application.</para>
 229         </remarks>
 230         <exception cref="T:System.ArgumentException">
 231           <para>
 232             <paramref name="stream" /> is not a valid file stream.
 233           </para>
 234           <para>-or-</para>
 235           <para>
 236             <paramref name="advice" /> is not a value.
 237           </para>
 238         </exception>
 239         <exception cref="T:System.ArgumentNullException">
 240           <paramref name="stream" /> is <see langword="null" />.</exception>
 241         <exception cref="T:System.IO.IOException">
 242           <paramref name="stream" />
 243           refers to a pipe or FIFO.</exception>
 244         <altmember cref="M:Mono.Unix.Native.Syscall.posix_fadvise" />
 245       </Docs>
 246     </Member>
 247     <Member MemberName="AdviseFileAccessPattern">
 248       <MemberSignature Language="C#" Value="public static void AdviseFileAccessPattern (int fd, Mono.Unix.FileAccessPattern pattern, long offset, long len);" />
 249       <MemberSignature Language="ILAsm" Value=".method public static hidebysig void AdviseFileAccessPattern(int32 fd, valuetype Mono.Unix.FileAccessPattern pattern, int64 offset, int64 len) cil managed" />
 250       <MemberType>Method</MemberType>
 251       <AssemblyInfo>
 252         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 253         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 254         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 255       </AssemblyInfo>
 256       <ReturnValue>
 257         <ReturnType>System.Void</ReturnType>
 258       </ReturnValue>
 259       <Parameters>
 260         <Parameter Name="fd" Type="System.Int32" />
 261         <Parameter Name="pattern" Type="Mono.Unix.FileAccessPattern" />
 262         <Parameter Name="offset" Type="System.Int64" />
 263         <Parameter Name="len" Type="System.Int64" />
 264       </Parameters>
 265       <Docs>
 266         <param name="fd">
 267           A <see cref="T:System.Int32" /> containing the file descriptor to advise.
 268         </param>
 269         <param name="pattern">
 270           A <see cref="T:Mono.Unix.FileAccessPattern" /> containing the file
 271           access pattern to suggest.
 272         </param>
 273         <param name="offset">
 274           A <see cref="T:System.Int64" /> containing the start of the range to suggest
 275           the <paramref name="pattern" /> access pattern.
 276         </param>
 277         <param name="len">
 278           A <see cref="T:System.Int64" /> containing the length of the range
 279           to suggest the <paramref name="pattern" />
 280           access pattern.  If <c>0</c>, <paramref name="pattern" /> is suggested
 281           until end-of-file.
 282         </param>
 283         <summary>Advises a file access pattern for a Unix file descriptor.</summary>
 284         <remarks>
 285           <para>
 286             <c>AdviseFileAccessPattern</c> is used to announce an intention
 287         to access file data with a specific pattern, allowing the kernel to
 288         perform appropriate optimizations.</para>
 289           <para>
 290             <paramref name="pattern" /> applies to a region starting at
 291         <paramref name="offset" /> and extending for <paramref name="len" />
 292         bytes (or until end-of-file if <paramref name="len" /> is <c>0</c>)
 293         within the file specified by <paramref name="fd" />.  The specified
 294         region need not currently exist.</para>
 295           <para>The specified pattern is not binding; it merely constitutes an
 296         expectation on behalf of the application.</para>
 297         </remarks>
 298         <exception cref="T:System.ArgumentException">
 299           <para>
 300             <paramref name="fd" /> is not a valid file descriptor.
 301           </para>
 302           <para>-or-</para>
 303           <para>
 304             <paramref name="advice" /> is not a valid value.
 305           </para>
 306         </exception>
 307         <exception cref="T:System.IO.IOException">
 308           <paramref name="fd" />
 309           refers to a pipe or FIFO.</exception>
 310         <altmember cref="M:Mono.Unix.Native.Syscall.posix_fadvise" />
 311       </Docs>
 312     </Member>
 313     <Member MemberName="AdviseFileAccessPattern">
 314       <MemberSignature Language="C#" Value="public static void AdviseFileAccessPattern (System.IO.FileStream file, Mono.Unix.FileAccessPattern pattern, long offset, long len);" />
 315       <MemberSignature Language="ILAsm" Value=".method public static hidebysig void AdviseFileAccessPattern(class System.IO.FileStream file, valuetype Mono.Unix.FileAccessPattern pattern, int64 offset, int64 len) cil managed" />
 316       <MemberType>Method</MemberType>
 317       <AssemblyInfo>
 318         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 319         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 320         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 321       </AssemblyInfo>
 322       <ReturnValue>
 323         <ReturnType>System.Void</ReturnType>
 324       </ReturnValue>
 325       <Parameters>
 326         <Parameter Name="file" Type="System.IO.FileStream" />
 327         <Parameter Name="pattern" Type="Mono.Unix.FileAccessPattern" />
 328         <Parameter Name="offset" Type="System.Int64" />
 329         <Parameter Name="len" Type="System.Int64" />
 330       </Parameters>
 331       <Docs>
 332         <param name="file">File stream to advise.</param>
 333         <param name="pattern">
 334           A <see cref="T:Mono.Unix.FileAccessPattern" /> containing the file
 335           access pattern to suggest.
 336         </param>
 337         <param name="offset">
 338           A <see cref="T:System.Int64" /> containing the start of the range to suggest
 339           the <paramref name="pattern" /> access pattern.
 340         </param>
 341         <param name="len">
 342           A <see cref="T:System.Int64" /> containing the length of the range
 343           to suggest the <paramref name="pattern" />
 344           access pattern.  If <c>0</c>, <paramref name="pattern" /> is suggested
 345           until end-of-file.
 346         </param>
 347         <summary>Advises a file access pattern for a Unix file descriptor.</summary>
 348         <remarks>
 349           <para>
 350             <c>AdviseFileAccessPattern</c> is used to announce an intention
 351         to access file data with a specific pattern, allowing the kernel to
 352         perform appropriate optimizations.</para>
 353           <para>
 354             <paramref name="pattern" /> applies to a region starting at
 355         <paramref name="offset" /> and extending for <paramref name="len" />
 356         bytes (or until end-of-file if <paramref name="len" /> is <c>0</c>)
 357         within the file specified by <paramref name="file" />.  The specified
 358         region need not currently exist.</para>
 359           <para>The specified pattern is not binding; it merely constitutes an
 360         expectation on behalf of the application.</para>
 361         </remarks>
 362         <exception cref="T:System.ArgumentException">
 363           <para>
 364             <paramref name="file" /> is not a valid file stream.
 365           </para>
 366           <para>-or-</para>
 367           <para>
 368             <paramref name="advice" /> is not a valid value.
 369           </para>
 370         </exception>
 371         <exception cref="T:System.ArgumentNullException">
 372           <paramref name="file" />
 373           is <see langword="null" />.</exception>
 374         <exception cref="T:System.IO.IOException">
 375           <paramref name="file" />
 376           refers to a pipe or FIFO.</exception>
 377         <altmember cref="M:Mono.Unix.Native.Syscall.posix_fadvise" />
 378       </Docs>
 379     </Member>
 380   </Members>
 381 </Type>