httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dgau...@locus.apache.org
Subject cvs commit: apache-2.0/src/lib/apr/include apr_file_io.h
Date Fri, 14 Apr 2000 00:55:03 GMT
dgaudet     00/04/13 17:55:02

  Modified:    src/lib/apr/file_io/unix dir.c fileacc.c filedup.c
                        filestat.c open.c pipe.c seek.c
               src/lib/apr/include apr_file_io.h
  Log:
  more documentation moving
  
  Revision  Changes    Path
  1.26      +0 -61     apache-2.0/src/lib/apr/file_io/unix/dir.c
  
  Index: dir.c
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/lib/apr/file_io/unix/dir.c,v
  retrieving revision 1.25
  retrieving revision 1.26
  diff -u -r1.25 -r1.26
  --- dir.c	2000/04/06 16:11:32	1.25
  +++ dir.c	2000/04/14 00:54:59	1.26
  @@ -66,13 +66,6 @@
       }
   } 
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_opendir(ap_dir_t **new, char *dirname, ap_context_t *cont)
  - *    Open the specified directory. 
  - * arg 1) The opened directory descriptor.
  - * arg 2) The full path to the directory (use / on all systems)
  - * arg 3) The context to use.
  - */                        
   ap_status_t ap_opendir(ap_dir_t **new, const char *dirname, ap_context_t *cont)
   {
       if (new == NULL)
  @@ -95,11 +88,6 @@
       }
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_closedir(ap_dir_t *thedir)
  - *    close the specified directory. 
  - * arg 1) the directory descriptor to close.
  - */                        
   ap_status_t ap_closedir(ap_dir_t *thedir)
   {
       ap_status_t rv;
  @@ -114,12 +102,6 @@
       return rv;
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_readdir(ap_dir_t *thedir)
  - *    Read the next entry from the specified directory. 
  - * arg 1) the directory descriptor to read from, and fill out.
  - * NOTE: All systems return . and .. as the first two files.
  - */                        
   ap_status_t ap_readdir(ap_dir_t *thedir)
   {
   #if APR_HAS_THREADS && defined(_POSIX_THREAD_SAFE_FUNCTIONS) \
  @@ -152,11 +134,6 @@
   #endif
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_rewinddir(ap_dir_t *thedir)
  - *    Rewind the directory to the first entry. 
  - * arg 1) the directory descriptor to rewind.
  - */                        
   ap_status_t ap_rewinddir(ap_dir_t *thedir)
   {
       if (thedir == NULL)
  @@ -166,14 +143,6 @@
       return APR_SUCCESS;
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_make_dir(const char *path, ap_fileperms_t perm, 
  - *                         ap_context_t *cont)
  - *    Create a new directory on the file system. 
  - * arg 1) the path for the directory to be created.  (use / on all systems)
  - * arg 2) Permissions for the new direcoty.
  - * arg 3) the context to use.
  - */                        
   ap_status_t ap_make_dir(const char *path, ap_fileperms_t perm, ap_context_t *cont)
   {
       mode_t mode = get_fileperms(perm);
  @@ -186,12 +155,6 @@
       }
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_remove_dir(const char *path, ap_context_t *cont)
  - *    Remove directory from the file system. 
  - * arg 1) the path for the directory to be removed.  (use / on all systems)
  - * arg 2) the context to use.
  - */                        
   ap_status_t ap_remove_dir(const char *path, ap_context_t *cont)
   {
       if (rmdir(path) == 0) {
  @@ -202,12 +165,6 @@
       }
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_dir_entry_size(ap_ssize_t *size, ap_dir_t *thedir)
  - *    Get the size of the current directory entry. 
  - * arg 1) the size of the directory entry. 
  - * arg 2) the currently open directory.
  - */                        
   ap_status_t ap_dir_entry_size(ap_ssize_t *size, ap_dir_t *thedir)
   {
       struct stat filestat;
  @@ -231,12 +188,6 @@
       return APR_SUCCESS;
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_dir_entry_mtime(ap_time_t *mtime, ap_dir_t *thedir)
  - *    Get the last modified time of the current directory entry. 
  - * arg 1) the last modified time of the directory entry. 
  - * arg 2) the currently open directory.
  - */                        
   ap_status_t ap_dir_entry_mtime(ap_time_t *mtime, ap_dir_t *thedir)
   {
       struct stat filestat;
  @@ -261,12 +212,6 @@
       return APR_SUCCESS;
   }
    
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_dir_entry_ftype(ap_filetype_e *type, ap_dir_t *thedir)
  - *    Get the file type of the current directory entry. 
  - * arg 1) the file type of the directory entry. 
  - * arg 2) the currently open directory.
  - */                        
   ap_status_t ap_dir_entry_ftype(ap_filetype_e *type, ap_dir_t *thedir)
   {
       struct stat filestat;
  @@ -306,12 +251,6 @@
       return APR_SUCCESS;
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_get_dir_filename(char **new, ap_dir_t *thedir) 
  - *    Get the file name of the current directory entry. 
  - * arg 1) the file name of the directory entry. 
  - * arg 2) the currently open directory.
  - */                        
   ap_status_t ap_get_dir_filename(char **new, ap_dir_t *thedir)
   {
       if (new == NULL)
  
  
  
  1.22      +0 -22     apache-2.0/src/lib/apr/file_io/unix/fileacc.c
  
  Index: fileacc.c
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/lib/apr/file_io/unix/fileacc.c,v
  retrieving revision 1.21
  retrieving revision 1.22
  diff -u -r1.21 -r1.22
  --- fileacc.c	2000/04/03 19:44:29	1.21
  +++ fileacc.c	2000/04/14 00:55:00	1.22
  @@ -56,12 +56,6 @@
   
   /* A file to put ALL of the accessor functions for ap_file_t types. */
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_get_filename(char **new, ap_file_t *thefile)
  - *    return the file name of the current file.
  - * arg 1) The path of the file.  
  - * arg 2) The currently open file.
  - */                     
   ap_status_t ap_get_filename(char **new, ap_file_t *thefile)
   {
       if(new == NULL)
  @@ -105,13 +99,6 @@
       return rv;
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_get_filedata(void **data, char *key, ap_file_t *file)
  - *    Return the data associated with the current file.
  - * arg 1) The user data associated with the file.  
  - * arg 2) The key to use for retreiving data associated with this file.
  - * arg 3) The currently open file.
  - */                     
   ap_status_t ap_get_filedata(void **data, char *key, ap_file_t *file)
   {    
       if(data == NULL || key == NULL)
  @@ -126,15 +113,6 @@
       }
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_set_filedata(ap_file_t *file, void *data, char *key,
  - *                             ap_status (*cleanup) (void *))
  - *    Set the data associated with the current file.
  - * arg 1) The currently open file.
  - * arg 2) The user data to associate with the file.  
  - * arg 3) The key to use for assocaiteing data with the file.
  - * arg 4) The cleanup routine to use when the file is destroyed.
  - */                     
   ap_status_t ap_set_filedata(ap_file_t *file, void *data, char *key,
                               ap_status_t (*cleanup) (void *))
   {    
  
  
  
  1.16      +0 -7      apache-2.0/src/lib/apr/file_io/unix/filedup.c
  
  Index: filedup.c
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/lib/apr/file_io/unix/filedup.c,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- filedup.c	2000/04/06 23:25:05	1.15
  +++ filedup.c	2000/04/14 00:55:00	1.16
  @@ -54,13 +54,6 @@
   
   #include "fileio.h"
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_dupfile(ap_file_t **new_file, ap_file_t *old_file)
  - *    duplicate the specified file descriptor.
  - * arg 1) The structure to duplicate into. 
  - * arg 2) The file to duplicate.
  - * NOTE: *arg1 must point to a valid ap_file_t, or point to NULL
  - */         
   ap_status_t ap_dupfile(ap_file_t **new_file, ap_file_t *old_file)
   {
       char *buf_oflags;
  
  
  
  1.22      +0 -14     apache-2.0/src/lib/apr/file_io/unix/filestat.c
  
  Index: filestat.c
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/lib/apr/file_io/unix/filestat.c,v
  retrieving revision 1.21
  retrieving revision 1.22
  diff -u -r1.21 -r1.22
  --- filestat.c	2000/04/06 23:25:05	1.21
  +++ filestat.c	2000/04/14 00:55:00	1.22
  @@ -80,12 +80,6 @@
       return type;
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_getfileinfo(ap_finfo_t *finfo, ap_file_t *thefile)
  - *    get the specified file's stats..
  - * arg 1) Where to store the information about the file.
  - * arg 2) The file to get information about. 
  - */ 
   ap_status_t ap_getfileinfo(ap_finfo_t *finfo, ap_file_t *thefile)
   {
       struct stat info;
  @@ -111,14 +105,6 @@
       }
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_stat(ap_file_t **finfo, char *fname, ap_context_t *cont)
  - *    get the specified file's stats.  The file is specified by filename,
  - *    instead of using a pre-opened file.
  - * arg 1) Where to store the information about the file.
  - * arg 2) The name of the file to stat.
  - * arg 3) the context to use to allocate the new file. 
  - */ 
   ap_status_t ap_stat(ap_finfo_t *finfo, const char *fname, ap_context_t *cont)
   {
       struct stat info;
  
  
  
  1.43      +0 -53     apache-2.0/src/lib/apr/file_io/unix/open.c
  
  Index: open.c
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/lib/apr/file_io/unix/open.c,v
  retrieving revision 1.42
  retrieving revision 1.43
  diff -u -r1.42 -r1.43
  --- open.c	2000/04/06 23:53:58	1.42
  +++ open.c	2000/04/14 00:55:00	1.43
  @@ -72,28 +72,6 @@
       }
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_open(ap_file_t **new, char *fname, ap_int32 flag, 
  - *                     ap_fileperms perm, ap_context_t *cont)
  - *    Open the specified file.
  - * arg 1) The opened file descriptor.
  - * arg 2) The full path to the file (using / on all systems)
  - * arg 3) Or'ed value of:
  - *          APR_READ             open for reading
  - *          APR_WRITE            open for writing
  - *          APR_CREATE           create the file if not there
  - *          APR_APPEND           file ptr is set to end prior to all writes
  - *          APR_TRUNCATE         set length to zero if file exists
  - *          APR_BINARY           not a text file (This flag is ignored on UNIX because
it has no meaning)
  - *          APR_BUFFERED         buffer the data.  Default is non-buffered
  - *          APR_EXCL             return error if APR_CREATE and file exists
  - *          APR_DELONCLOSE       delete the file after closing.
  - * arg 4) Access permissions for file.
  - * arg 5) The context to use.
  - * NOTE:  If mode is APR_OS_DEFAULT, the system open command will be 
  - *        called without any mode parameters.  *arg1 must point to a valid
  - *        file_t, or NULL (in which case it will be allocated)
  - */
   ap_status_t ap_open(ap_file_t **new, const char *fname, ap_int32_t flag,  ap_fileperms_t
perm, ap_context_t *cont)
   {
       int oflags = 0;
  @@ -167,11 +145,6 @@
       return APR_SUCCESS;
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_close(ap_file_t *file)
  - *    Close the specified file.
  - * arg 1) The file descriptor to close.
  - */
   ap_status_t ap_close(ap_file_t *file)
   {
       ap_status_t rv;
  @@ -186,14 +159,6 @@
       return rv;
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_remove_file(char *path, ap_context_t *cont) 
  - *    delete the specified file.
  - * arg 1) The full path to the file (using / on all systems)
  - * arg 2) The context to use.
  - * NOTE: If the file is open, it won't be removed until all instances are
  - *       closed.
  - */
   ap_status_t ap_remove_file(char *path, ap_context_t *cont)
   {
       if (unlink(path) == 0) {
  @@ -253,12 +218,6 @@
       return APR_SUCCESS;
   }    
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_eof(ap_file_t *fptr) 
  - *    Are we at the end of the file
  - * arg 1) The apr file we are testing.
  - * NOTE:  Returns APR_EOF if we are at the end of file, APR_SUCCESS otherwise.
  - */
   ap_status_t ap_eof(ap_file_t *fptr)
   {
       if (fptr == NULL)
  @@ -270,12 +229,6 @@
       return APR_SUCCESS;
   }   
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_ferror(ap_file_t *fptr) 
  - *    Is there an error on the stream?
  - * arg 1) The apr file we are testing.
  - * NOTE:  Returns -1 if the error indicator is set, APR_SUCCESS otherwise.
  - */
   ap_status_t ap_ferror(ap_file_t *fptr)
   {
   /* Thist function should be removed ASAP.  It is next on my list once
  @@ -287,12 +240,6 @@
       return APR_SUCCESS;
   }   
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_open_stderr(ap_file_t **thefile, ap_context_t *cont) 
  - *    open standard error as an apr file pointer.
  - * arg 1) The apr file to use as stderr.
  - * arg 2) The context to allocate the file out of.
  - */
   ap_status_t ap_open_stderr(ap_file_t **thefile, ap_context_t *cont)
   {
       if (thefile == NULL)
  
  
  
  1.23      +0 -28     apache-2.0/src/lib/apr/file_io/unix/pipe.c
  
  Index: pipe.c
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/lib/apr/file_io/unix/pipe.c,v
  retrieving revision 1.22
  retrieving revision 1.23
  diff -u -r1.22 -r1.23
  --- pipe.c	2000/04/06 23:25:05	1.22
  +++ pipe.c	2000/04/14 00:55:00	1.23
  @@ -77,13 +77,6 @@
   }
   
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_set_pipe_timeout(ap_file_t *thepipe, ap_int32_t timeout)
  - *    Set the timeout value for a pipe.
  - * arg 1) The pipe we are setting a timeout on.
  - * arg 3) The timeout value in seconds.  Values < 0 mean wait forever, 0
  - *        means do not wait at all.
  - */
   ap_status_t ap_set_pipe_timeout(ap_file_t *thepipe, ap_int32_t timeout)
   {
       if(thepipe == NULL)
  @@ -96,14 +89,6 @@
       return APR_EINVAL;
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_create_pipe(ap_file_t **in, ap_file_t **out, 
  - *                            ap_context_t *cont)
  - *    Create an anonymous pipe.
  - * arg 1) The file descriptor to use as input to the pipe.
  - * arg 2) The file descriptor to use as output from the pipe.
  - * arg 3) The context to operate on.
  - */
   ap_status_t ap_create_pipe(ap_file_t **in, ap_file_t **out, ap_context_t *cont)
   {
       int filedes[2];
  @@ -135,14 +120,6 @@
       return APR_SUCCESS;
   }
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_create_namedpipe(char *filename, ap_fileperms_t perm, 
  - *                                 ap_context_t *cont)
  - *    Create a named pipe.
  - * arg 1) The filename of the named pipe
  - * arg 2) The permissions for the newly created pipe.
  - * arg 3) The context to operate on.
  - */
   ap_status_t ap_create_namedpipe(char *filename, 
                                   ap_fileperms_t perm, ap_context_t *cont)
   {
  @@ -154,11 +131,6 @@
       return APR_SUCCESS;
   } 
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_block_pipe(ap_file_t *thepipe)
  - *    Set a pipe to use blocking I/O.
  - * arg 1) The pipe to operate on.
  - */
   ap_status_t ap_block_pipe(ap_file_t *thepipe)
   {
   #ifndef BEOS /* this code won't work on BeOS */
  
  
  
  1.10      +0 -13     apache-2.0/src/lib/apr/file_io/unix/seek.c
  
  Index: seek.c
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/lib/apr/file_io/unix/seek.c,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- seek.c	2000/04/06 23:25:05	1.9
  +++ seek.c	2000/04/14 00:55:00	1.10
  @@ -54,19 +54,6 @@
   
   #include "fileio.h"
   
  -/* ***APRDOC********************************************************
  - * ap_status_t ap_seek(ap_file_t *thefile, ap_seek_where_t where, 
  - *                     ap_off_t *offset)
  - *    Move the read/write file offset to a specified byte within a file.
  - * arg 1) The file descriptor
  - * arg 2) How to move the pointer, one of:
  - *            APR_SET  --  set the offset to offset
  - *            APR_CUR  --  add the offset to the current position 
  - *            APR_END  --  add the offset to the current file size 
  - * arg 3) The offset to move the pointer to.
  - * NOTE:  The third argument is modified to be the offset the pointer
  - *        was actually moved to.
  - */
   ap_status_t ap_seek(ap_file_t *thefile, ap_seek_where_t where, ap_off_t *offset)
   {
       ap_off_t rv;
  
  
  
  1.41      +220 -0    apache-2.0/src/lib/apr/include/apr_file_io.h
  
  Index: apr_file_io.h
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/lib/apr/include/apr_file_io.h,v
  retrieving revision 1.40
  retrieving revision 1.41
  diff -u -r1.40 -r1.41
  --- apr_file_io.h	2000/04/14 00:46:50	1.40
  +++ apr_file_io.h	2000/04/14 00:55:02	1.41
  @@ -124,12 +124,70 @@
   };
   
   /*   Function definitions */
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_open(ap_file_t **new, char *fname, ap_int32 flag, 
  + *                     ap_fileperms perm, ap_context_t *cont)
  + *    Open the specified file.
  + * arg 1) The opened file descriptor.
  + * arg 2) The full path to the file (using / on all systems)
  + * arg 3) Or'ed value of:
  + *          APR_READ             open for reading
  + *          APR_WRITE            open for writing
  + *          APR_CREATE           create the file if not there
  + *          APR_APPEND           file ptr is set to end prior to all writes
  + *          APR_TRUNCATE         set length to zero if file exists
  + *          APR_BINARY           not a text file (This flag is ignored on UNIX because
it has no meaning)
  + *          APR_BUFFERED         buffer the data.  Default is non-buffered
  + *          APR_EXCL             return error if APR_CREATE and file exists
  + *          APR_DELONCLOSE       delete the file after closing.
  + * arg 4) Access permissions for file.
  + * arg 5) The context to use.
  + * NOTE:  If mode is APR_OS_DEFAULT, the system open command will be 
  + *        called without any mode parameters.  *arg1 must point to a valid
  + *        file_t, or NULL (in which case it will be allocated)
  + */
   ap_status_t ap_open(ap_file_t **new, const char *fname, ap_int32_t flag, 
                       ap_fileperms_t perm, ap_context_t *cont);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_close(ap_file_t *file)
  + *    Close the specified file.
  + * arg 1) The file descriptor to close.
  + */
   ap_status_t ap_close(ap_file_t *file);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_remove_file(char *path, ap_context_t *cont) 
  + *    delete the specified file.
  + * arg 1) The full path to the file (using / on all systems)
  + * arg 2) The context to use.
  + * NOTE: If the file is open, it won't be removed until all instances are
  + *       closed.
  + */
   ap_status_t ap_remove_file(char *path, ap_context_t *cont);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_eof(ap_file_t *fptr) 
  + *    Are we at the end of the file
  + * arg 1) The apr file we are testing.
  + * NOTE:  Returns APR_EOF if we are at the end of file, APR_SUCCESS otherwise.
  + */
   ap_status_t ap_eof(ap_file_t *fptr);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_ferror(ap_file_t *fptr) 
  + *    Is there an error on the stream?
  + * arg 1) The apr file we are testing.
  + * NOTE:  Returns -1 if the error indicator is set, APR_SUCCESS otherwise.
  + */
   ap_status_t ap_ferror(ap_file_t *fptr);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_open_stderr(ap_file_t **thefile, ap_context_t *cont) 
  + *    open standard error as an apr file pointer.
  + * arg 1) The apr file to use as stderr.
  + * arg 2) The context to allocate the file out of.
  + */
   ap_status_t ap_open_stderr(ap_file_t **thefile, ap_context_t *cont);
   
   /* ***APRDOC********************************************************
  @@ -243,34 +301,196 @@
   API_EXPORT(int) ap_fprintf(ap_file_t *fptr, const char *format, ...)
           __attribute__((format(printf,2,3)));
   
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_dupfile(ap_file_t **new_file, ap_file_t *old_file)
  + *    duplicate the specified file descriptor.
  + * arg 1) The structure to duplicate into. 
  + * arg 2) The file to duplicate.
  + * NOTE: *arg1 must point to a valid ap_file_t, or point to NULL
  + */         
   ap_status_t ap_dupfile(ap_file_t **new_file, ap_file_t *old_file);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_getfileinfo(ap_finfo_t *finfo, ap_file_t *thefile)
  + *    get the specified file's stats..
  + * arg 1) Where to store the information about the file.
  + * arg 2) The file to get information about. 
  + */ 
   ap_status_t ap_getfileinfo(ap_finfo_t *finfo, ap_file_t *thefile);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_stat(ap_file_t **finfo, char *fname, ap_context_t *cont)
  + *    get the specified file's stats.  The file is specified by filename,
  + *    instead of using a pre-opened file.
  + * arg 1) Where to store the information about the file.
  + * arg 2) The name of the file to stat.
  + * arg 3) the context to use to allocate the new file. 
  + */ 
   ap_status_t ap_stat(ap_finfo_t *finfo, const char *fname, ap_context_t *cont);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_seek(ap_file_t *thefile, ap_seek_where_t where, 
  + *                     ap_off_t *offset)
  + *    Move the read/write file offset to a specified byte within a file.
  + * arg 1) The file descriptor
  + * arg 2) How to move the pointer, one of:
  + *            APR_SET  --  set the offset to offset
  + *            APR_CUR  --  add the offset to the current position 
  + *            APR_END  --  add the offset to the current file size 
  + * arg 3) The offset to move the pointer to.
  + * NOTE:  The third argument is modified to be the offset the pointer
  + *        was actually moved to.
  + */
   ap_status_t ap_seek(ap_file_t *thefile, ap_seek_where_t where,ap_off_t *offset);
   
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_opendir(ap_dir_t **new, char *dirname, ap_context_t *cont)
  + *    Open the specified directory. 
  + * arg 1) The opened directory descriptor.
  + * arg 2) The full path to the directory (use / on all systems)
  + * arg 3) The context to use.
  + */                        
   ap_status_t ap_opendir(ap_dir_t **new, const char *dirname, ap_context_t *cont);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_closedir(ap_dir_t *thedir)
  + *    close the specified directory. 
  + * arg 1) the directory descriptor to close.
  + */                        
   ap_status_t ap_closedir(ap_dir_t *thedir);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_readdir(ap_dir_t *thedir)
  + *    Read the next entry from the specified directory. 
  + * arg 1) the directory descriptor to read from, and fill out.
  + * NOTE: All systems return . and .. as the first two files.
  + */                        
   ap_status_t ap_readdir(ap_dir_t *thedir);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_rewinddir(ap_dir_t *thedir)
  + *    Rewind the directory to the first entry. 
  + * arg 1) the directory descriptor to rewind.
  + */                        
   ap_status_t ap_rewinddir(ap_dir_t *thedir);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_make_dir(const char *path, ap_fileperms_t perm, 
  + *                         ap_context_t *cont)
  + *    Create a new directory on the file system. 
  + * arg 1) the path for the directory to be created.  (use / on all systems)
  + * arg 2) Permissions for the new direcoty.
  + * arg 3) the context to use.
  + */                        
   ap_status_t ap_make_dir(const char *path, ap_fileperms_t perm, 
                           ap_context_t *cont);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_remove_dir(const char *path, ap_context_t *cont)
  + *    Remove directory from the file system. 
  + * arg 1) the path for the directory to be removed.  (use / on all systems)
  + * arg 2) the context to use.
  + */                        
   ap_status_t ap_remove_dir(const char *path, ap_context_t *cont);
   
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_create_pipe(ap_file_t **in, ap_file_t **out, 
  + *                            ap_context_t *cont)
  + *    Create an anonymous pipe.
  + * arg 1) The file descriptor to use as input to the pipe.
  + * arg 2) The file descriptor to use as output from the pipe.
  + * arg 3) The context to operate on.
  + */
   ap_status_t ap_create_pipe(ap_file_t **in, ap_file_t **out, ap_context_t *cont);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_create_namedpipe(char *filename, ap_fileperms_t perm, 
  + *                                 ap_context_t *cont)
  + *    Create a named pipe.
  + * arg 1) The filename of the named pipe
  + * arg 2) The permissions for the newly created pipe.
  + * arg 3) The context to operate on.
  + */
   ap_status_t ap_create_namedpipe(char *filename, ap_fileperms_t perm, 
                                   ap_context_t *cont);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_set_pipe_timeout(ap_file_t *thepipe, ap_int32_t timeout)
  + *    Set the timeout value for a pipe.
  + * arg 1) The pipe we are setting a timeout on.
  + * arg 3) The timeout value in seconds.  Values < 0 mean wait forever, 0
  + *        means do not wait at all.
  + */
   ap_status_t ap_set_pipe_timeout(ap_file_t *thepipe, ap_int32_t timeout);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_block_pipe(ap_file_t *thepipe)
  + *    Set a pipe to use blocking I/O.
  + * arg 1) The pipe to operate on.
  + */
   ap_status_t ap_block_pipe(ap_file_t *thepipe);
   
   /*accessor and general file_io functions. */
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_get_filename(char **new, ap_file_t *thefile)
  + *    return the file name of the current file.
  + * arg 1) The path of the file.  
  + * arg 2) The currently open file.
  + */                     
   ap_status_t ap_get_filename(char **new, ap_file_t *thefile);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_get_dir_filename(char **new, ap_dir_t *thedir) 
  + *    Get the file name of the current directory entry. 
  + * arg 1) the file name of the directory entry. 
  + * arg 2) the currently open directory.
  + */                        
   ap_status_t ap_get_dir_filename(char **new, ap_dir_t *thedir);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_get_filedata(void **data, char *key, ap_file_t *file)
  + *    Return the data associated with the current file.
  + * arg 1) The user data associated with the file.  
  + * arg 2) The key to use for retreiving data associated with this file.
  + * arg 3) The currently open file.
  + */                     
   ap_status_t ap_get_filedata(void **data, char *key, ap_file_t *file);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_set_filedata(ap_file_t *file, void *data, char *key,
  + *                             ap_status (*cleanup) (void *))
  + *    Set the data associated with the current file.
  + * arg 1) The currently open file.
  + * arg 2) The user data to associate with the file.  
  + * arg 3) The key to use for assocaiteing data with the file.
  + * arg 4) The cleanup routine to use when the file is destroyed.
  + */                     
   ap_status_t ap_set_filedata(ap_file_t *file, void *data, char *key,
                               ap_status_t (*cleanup) (void *));
   
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_dir_entry_size(ap_ssize_t *size, ap_dir_t *thedir)
  + *    Get the size of the current directory entry. 
  + * arg 1) the size of the directory entry. 
  + * arg 2) the currently open directory.
  + */                        
   ap_status_t ap_dir_entry_size(ap_ssize_t *size, ap_dir_t *thedir);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_dir_entry_mtime(ap_time_t *mtime, ap_dir_t *thedir)
  + *    Get the last modified time of the current directory entry. 
  + * arg 1) the last modified time of the directory entry. 
  + * arg 2) the currently open directory.
  + */                        
   ap_status_t ap_dir_entry_mtime(ap_time_t *mtime, ap_dir_t *thedir);
  +
  +/* ***APRDOC********************************************************
  + * ap_status_t ap_dir_entry_ftype(ap_filetype_e *type, ap_dir_t *thedir)
  + *    Get the file type of the current directory entry. 
  + * arg 1) the file type of the directory entry. 
  + * arg 2) the currently open directory.
  + */                        
   ap_status_t ap_dir_entry_ftype(ap_filetype_e *type, ap_dir_t *thedir);
   
   #ifdef __cplusplus
  
  
  

Mime
View raw message