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