Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r63298 - trunk/libs/iostreams/doc/classes
From: steven_at_[hidden]
Date: 2010-06-24 17:22:17

Next message: talljimbo_at_[hidden]: "[Boost-commit] svn:boost r63299 - in sandbox/numpy: boost/python/numpy libs/python/numpy/test"
Previous message: steven_at_[hidden]: "[Boost-commit] svn:boost r63297 - trunk/libs/iostreams/src"

Author: steven_watanabe
Date: 2010-06-24 17:22:16 EDT (Thu, 24 Jun 2010)
New Revision: 63298
URL: http://svn.boost.org/trac/boost/changeset/63298

Log:
Document private mapping with mapped_file. Refs #1612.
Text files modified:
trunk/libs/iostreams/doc/classes/mapped_file.html | 126 ++++++++++++++++++++++++++++++++++++---
1 files changed, 114 insertions(+), 12 deletions(-)

Modified: trunk/libs/iostreams/doc/classes/mapped_file.html
==============================================================================
--- trunk/libs/iostreams/doc/classes/mapped_file.html (original)
+++ trunk/libs/iostreams/doc/classes/mapped_file.html 2010-06-24 17:22:16 EDT (Thu, 24 Jun 2010)
@@ -90,7 +90,8 @@
 explicit mapped_file_params();
 explicit mapped_file_params(const std::string& path);
 std::string <A CLASS='documented' HREF='#mapped_file_params_hint'>path</A>;
- std::ios_base::openmode <A CLASS='documented' HREF='#mapped_file_params_mode'>mode</A>;
+ mapped_file::mapmode <A CLASS='documented' HREF='#mapped_file_params_flags'>flags</A>;
+ std::ios_base::openmode <A CLASS='documented' HREF='#mapped_file_params_mode'>mode</A>; // Deprecated
 stream_offset <A CLASS='documented' HREF='#mapped_file_params_offset'>offset</A>;
 std::size_t <A CLASS='documented' HREF='#mapped_file_params_length'>length</A>;
 stream_offset <A CLASS="documented" HREF="#mapped_file_params_size">new_file_size</A>;
@@ -111,7 +112,14 @@

<PRE CLASS="broken_ie"> std::ios_base::openmode mode;</PRE>

-Indicates whether the file should be opened with read-access, write-access or both. Ignored by <CODE>mapped_file_source</CODE> and <CODE>mapped_file_sink</CODE> .
+Indicates whether the file should be opened with read-access, write-access or both. Ignored by <CODE>mapped_file_source</CODE> and <CODE>mapped_file_sink</CODE>. This member is deprecated. Please use flags in new code instead.
+
+<A NAME="mapped_file_params_flags"></A>
+<H4><CODE>mapped_file_params::flags</CODE></H4>
+
+<PRE CLASS="broken_ie"> mapped_file::mapmode flags;</PRE>
+
+Indicates whether the file should be opened with read-access, read-write-access, or private access. A file opened with private access can be written to, but the changes will not affect the underlying file.

<A NAME="mapped_file_params_offset"></A>
<H4><CODE>mapped_file_params::offset</CODE></H4>
@@ -289,16 +297,20 @@
public:
 typedef char char_type;
 typedef [implementation-defined] category;
+ enum mapmode { readwrite, priv };
 <A CLASS='documented' HREF='#mapped_file_sink_default_ctor'>mapped_file_sink</A>();
 explicit <A CLASS='documented' HREF='#mapped_file_sink_params_ctor'>mapped_file_sink</A>(<A CLASS='documented' HREF='#mapped_file_params'>mapped_file_params</A> params);
 explicit <A CLASS='documented' HREF='#mapped_file_sink_basic_ctor'>mapped_file_sink</A>( const std::string& path,
 size_type length = max_length,
- boost::intmax_t offset = 0 );
+ boost::intmax_t offset = 0,
+ mapmode flags = readwrite );
 void <A CLASS='documented' HREF='#mapped_file_sink_params_open'>open</A>(<A CLASS='documented' HREF='#mapped_file_params'>mapped_file_params</A> params);
 void <A CLASS='documented' HREF='#mapped_file_sink_basic_open'>open</A>( const std::string& path,
 size_type length = max_length,
- boost::intmax_t offset = 0 );
+ boost::intmax_t offset = 0,
+ mapmode flags = readwrite );
 bool <A CLASS='documented' HREF='#mapped_file_sink_is_open'>is_open</A>() const;
+ mapmode <A CLASS='documented' HREF='#mapped_file_sink_flags'>flags</A>() const;
 void <A CLASS='documented' HREF='#mapped_file_sink_close'>close</A>();
 size_type <A CLASS='documented' HREF='#mapped_file_sink_size'>size</A>() const;
 char* <A CLASS='documented' HREF='#mapped_file_sink_data'>data</A>() const;
@@ -322,7 +334,8 @@
<A NAME="mapped_file_sink_basic_ctor"></A>
<PRE CLASS="broken_ie"> explicit mapped_file_sink( const std::string& path,
 size_type length = max_length,
- boost::intmax_t offset = 0 );</PRE>
+ boost::intmax_t offset = 0,
+ mapmode flags );</PRE>

Constructs a <CODE>mapped_file_sink</CODE> to access a specified file. The parameters have the following interpretation:

@@ -340,6 +353,10 @@
 <TD VALIGN="top">offset</TD><TD WIDTH="2em" VALIGN="top">-</TD>
 <TD>The offset where the mapping is to begin. This value must be a multiple of the operating system's virtual memory allocation granularity, which can be obtained using the static member function <A HREF='#mapped_file_sink_alignment'><CODE>alignment</CODE></A>.</TD>
 </TR>
+ <TR>
+ <TD VALIGN="top">flags</TD><TD WIDTH="2em" VALIGN="top">-</TD>
+ <TD>Indicates whether the <CODE>mapped_file_sink</CODE> should be opened for read-write access or private access.</TD>
+ </TR>
</TABLE>

<A NAME="mapped_file_sink_params_open"></A>
@@ -352,7 +369,8 @@
<A NAME="mapped_file_sink_basic_open"></A>
<PRE CLASS="broken_ie"> void open( const std::string& path,
 size_type length = max_length,
- boost::intmax_t offset = 0 );</PRE>
+ boost::intmax_t offset = 0
+ mapmode flags );</PRE>

Connects this <CODE>mapped_file_sink</CODE> to a memory-mapped file obtained as described by the given parameters, which have the following interpretation:

@@ -370,6 +388,10 @@
 <TD VALIGN="top">offset</TD><TD WIDTH="2em" VALIGN="top">-</TD>
 <TD>The offset where the mapping is to begin. This value must be a multiple of the operating system's virtual memory allocation granularity, which can be obtained using the static member function <A HREF='#mapped_file_sink_alignment'><CODE>alignment</CODE></A>.</TD>
 </TR>
+ <TR>
+ <TD VALIGN="top">flags</TD><TD WIDTH="2em" VALIGN="top">-</TD>
+ <TD>Indicates whether the <CODE>mapped_file_sink</CODE> should be opened for read-write access or private access.</TD>
+ </TR>
</TABLE>

<A NAME="mapped_file_sink_is_open"></A>
@@ -379,6 +401,13 @@

Returns <CODE>true</CODE> if this <CODE>mapped_file_sink</CODE> has been successfully opened without subsequently having been closed.

+<A NAME="mapped_file_sink_flags"></A>
+<H4><CODE>mapped_file_sink::flags</CODE></H4>
+
+<PRE CLASS="broken_ie"> mapmode flags() const;</PRE>
+
+Indicates whether the <CODE>mapped_file_sink</CODE> was opened for read/write-access or private-access.
+
<A NAME="mapped_file_sink_close"></A>
<H4><CODE>mapped_file_sink::close</CODE></H4>

@@ -422,20 +451,30 @@
public:
 typedef char char_type;
 typedef [implementation-defined] category;
+ enum mapmode { readonly, readwrite, priv };
 <A CLASS='documented' HREF='#mapped_file_default_ctor'>mapped_file</A>();
 explicit <A CLASS='documented' HREF='#mapped_file_params_ctor'>mapped_file</A>(<A CLASS='documented' HREF='#mapped_file_params'>mapped_file_params</A> params);
 explicit <A CLASS='documented' HREF='#mapped_file_basic_ctor'>mapped_file</A>( const std::string& path,
 std::ios_base::openmode mode =
- std::ios_base | std::ios_base,
+ std::ios_base::in | std::ios_base::out,
 size_type length = max_length,
 boost::intmax_t offset = 0 );
- void <A CLASS='documented' HREF='#mapped_file_params_open'>open</A>(<A CLASS='documented' HREF='#mapped_file_params'>mapped_file_params</A> params);
- void <A CLASS='documented' HREF='#mapped_file_basic_open'>open</A>( const std::string& path,
+ explicit <A CLASS='documented' HREF='#mapped_file_mapmode_ctor'>mapped_file</A>( const std::string& path,
+ mapmode mode,
+ size_type length = max_length,
+ boost::intmax_t offset = 0 );
+ void <A CLASS='documented' HREF='#mapped_file_params_open'>open</A>(<A CLASS='documented' HREF='#mapped_file_params'>mapped_file_params</A> params);
+ void <A CLASS='documented' HREF='#mapped_file_basic_open'>open</A>( const std::string& path,
 std::ios_base::openmode mode =
 std::ios_base | std::ios_base,
 size_type length = max_length,
 boost::intmax_t offset = 0 );
+ void <A CLASS='documented' HREF='#mapped_file_mapmode_open'>open</A>( const std::string& path,
+ mapmode mode,
+ size_type length = max_length,
+ boost::intmax_t offset = 0 );
 bool <A CLASS='documented' HREF='#mapped_file_is_open'>is_open</A>() const;
+ mapmode <A CLASS='documented' HREF='#mapped_file_flags'>flags</A>() const;
 void <A CLASS='documented' HREF='#mapped_file_close'>close</A>();
 size_type <A CLASS='documented' HREF='#mapped_file_size'>size</A>() const;
 char* <A CLASS='documented' HREF='#mapped_file_data'>data</A>() const;
@@ -443,7 +482,7 @@
 static int <A CLASS='documented' HREF='#mapped_file_alignment'>alignment</A>();
};

-} } // End namespace boost::io</PRE>
+} } // End namespace boost::iostreams</PRE>

<A NAME="mapped_file_default_ctor"></A>
<H4><CODE>mapped_file::mapped_file</CODE></H4>
@@ -474,7 +513,35 @@
 </TR>
 <TR>
 <TD VALIGN="top">mode</TD><TD WIDTH="2em" VALIGN="top">-</TD>
- <TD>Indicates whether the file should be opened with read-access, write-access or both.</TD>
+ <TD>Indicates whether the file should be opened with read-access, write-access or both. Use of <CODE>std::ios_base::openmode</CODE> with <CODE>mapped_file</CODE> is deprecated. Please use <CODE>mapmode</CODE> instead in new code.</TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top">length</TD><TD WIDTH="2em" VALIGN="top">-</TD>
+ <TD>The number of bytes to map. If this parameter is not specified, the entire file is mapped.</TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top">offset</TD><TD WIDTH="2em" VALIGN="top">-</TD>
+ <TD>The offset where the mapping is to begin. This value must be a multiple of the operating system's virtual memory allocation granularity, which can be obtained using the static member function <A HREF='#mapped_file_alignment'><CODE>alignment</CODE></A>.</TD>
+ </TR>
+</TABLE>
+
+<A NAME="mapped_file_mapmode_ctor"></A>
+<PRE CLASS="broken_ie"> explicit mapped_file( const std::string& path,
+ mapmode mode,
+ size_type length = max_length,
+ boost::intmax_t offset = 0 );</PRE>
+
+Constructs a <CODE>mapped_file</CODE> to access a specified file. The parameters have the following interpretation:
+
+<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2>
+<TR>
+ <TR>
+ <TD VALIGN="top">path</TD><TD WIDTH="2em" VALIGN="top">-</TD>
+ <TD>The pathname of the file to map.</TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top">mode</TD><TD WIDTH="2em" VALIGN="top">-</TD>
+ <TD>Indicates whether the file should be opened with read-access, read/write-access or private-access.</TD>
 </TR>
 <TR>
 <TD VALIGN="top">length</TD><TD WIDTH="2em" VALIGN="top">-</TD>
@@ -510,7 +577,35 @@
 </TR>
 <TR>
 <TD VALIGN="top">mode</TD><TD WIDTH="2em" VALIGN="top">-</TD>
- <TD>Indicates whether the file should be opened with read-access, write-access or both.</TD>
+ <TD>Indicates whether the file should be opened with read-access, write-access or both. Use of <CODE>std::ios_base::openmode</CODE> with <CODE>mapped_file</CODE> is deprecated. Please use <CODE>mapmode</CODE> in new code.</TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top">length</TD><TD WIDTH="2em" VALIGN="top">-</TD>
+ <TD>The number of bytes to map. If this parameter is not specified, the entire file is mapped.</TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top">offset</TD><TD WIDTH="2em" VALIGN="top">-</TD>
+ <TD>The offset where the mapping is to begin. This value must be a multiple of the operating system's virtual memory allocation granularity, which can be obtained using the static member function <A HREF='#mapped_file_alignment'><CODE>alignment</CODE></A>.</TD>
+ </TR>
+</TABLE>
+
+<A NAME="mapped_file_mapmode_open"></A>
+<PRE CLASS="broken_ie"> void open( const std::string& path,
+ mapmode mode,
+ size_type length = max_length,
+ boost::intmax_t offset = 0 );</PRE>
+
+Connects this <CODE>mapped_file</CODE> to a memory-mapped file obtained as described by the given parameters, which have the following interpretation:
+
+<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2>
+<TR>
+ <TR>
+ <TD VALIGN="top">path</TD><TD WIDTH="2em" VALIGN="top">-</TD>
+ <TD>The pathname of the file to map.</TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top">mode</TD><TD WIDTH="2em" VALIGN="top">-</TD>
+ <TD>Indicates whether the file should be opened with read-access, read/write-access or private access.</TD>
 </TR>
 <TR>
 <TD VALIGN="top">length</TD><TD WIDTH="2em" VALIGN="top">-</TD>
@@ -529,6 +624,13 @@

Returns <CODE>true</CODE> if this <CODE>mapped_file</CODE> has been successfully opened without subsequently having been closed.

+<A NAME="mapped_file_flags"></A>
+<H4><CODE>mapped_file::flags</CODE></H4>
+
+<PRE CLASS="broken_ie"> mapmode flags() const;</PRE>
+
+Indicates whether the <CODE>mapped_file</CODE> was opened for read-access, read/write-access or private-access.
+
<A NAME="mapped_file_close"></A>
<H4><CODE>mapped_file::close</CODE></H4>

Next message: talljimbo_at_[hidden]: "[Boost-commit] svn:boost r63299 - in sandbox/numpy: boost/python/numpy libs/python/numpy/test"
Previous message: steven_at_[hidden]: "[Boost-commit] svn:boost r63297 - trunk/libs/iostreams/src"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk