summaryrefslogtreecommitdiff
path: root/mmap
diff options
context:
space:
mode:
authorRyan Bloom <rbb@apache.org>2000-03-15 02:10:35 +0000
committerRyan Bloom <rbb@apache.org>2000-03-15 02:10:35 +0000
commit4777dc199da3386a4bcd6dce38f560b5dd334c70 (patch)
treec95a8addb0184292fcc66ade796e3ed0c21b266b /mmap
parentce9caaee44ca9c7527cd35c7e4f7941b88aed0c3 (diff)
downloadapr-4777dc199da3386a4bcd6dce38f560b5dd334c70.tar.gz
Updating more docs. :-)
git-svn-id: https://svn.apache.org/repos/asf/apr/apr/trunk@59705 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'mmap')
-rw-r--r--mmap/unix/common.c7
-rw-r--r--mmap/unix/mmap.c14
2 files changed, 21 insertions, 0 deletions
diff --git a/mmap/unix/common.c b/mmap/unix/common.c
index 4901080db..6e87c1b64 100644
--- a/mmap/unix/common.c
+++ b/mmap/unix/common.c
@@ -70,6 +70,13 @@
#if HAVE_MMAP
+/* ***APRDOC********************************************************
+ * ap_status_t ap_mmap_offset(void **addr, ap_mmap_t *mmap, ap_offset_t offset)
+ * Move the pointer into the mmap'ed file to the specified offset.
+ * arg 1) The pointer to the offset specified.
+ * arg 2) The mmap'ed file.
+ * arg 3) The offset to move to.
+ */
ap_status_t ap_mmap_offset(void **addr, ap_mmap_t *mmap, ap_off_t offset)
{
if (offset < 0 || offset > mmap->size)
diff --git a/mmap/unix/mmap.c b/mmap/unix/mmap.c
index 34cfa8e0c..8a252ba63 100644
--- a/mmap/unix/mmap.c
+++ b/mmap/unix/mmap.c
@@ -76,6 +76,15 @@ ap_status_t mmap_cleanup(void *themmap)
return errno;
}
+/* ***APRDOC********************************************************
+ * ap_status_t ap_mmap_create(ap_mmap_t **new, ap_file_t *file, ap_off_t offset)
+ * Create a new mmap'ed file out of an existing APR file.
+ * arg 1) The newly created mmap'ed file.
+ * arg 2) The file turn into an mmap.
+ * arg 3) The offset into the file to start the data pointer at.
+ * arg 4) The size of the file
+ * arg 5) The context to use when creating the mmap.
+ */
ap_status_t ap_mmap_create(ap_mmap_t **new, ap_file_t *file, ap_off_t offset,
ap_size_t size, ap_context_t *cont)
{
@@ -103,6 +112,11 @@ ap_status_t ap_mmap_create(ap_mmap_t **new, ap_file_t *file, ap_off_t offset,
return APR_SUCCESS;
}
+/* ***APRDOC********************************************************
+ * ap_status_t ap_mmap_delete(ap_mmap_t *mmap)
+ * Remove a mmap'ed.
+ * arg 1) The mmap'ed file.
+ */
ap_status_t ap_mmap_delete(struct mmap_t *mmap)
{
ap_status_t rv;