Change line-endings back to UNIX format.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19650 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Niels Sascha Reedijk
2006-12-28 23:28:29 +00:00
parent ef33454cfd
commit 335c6a0b55
8 changed files with 1254 additions and 1254 deletions
+53 -53
View File
@@ -1,53 +1,53 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<sect2 id="bdataio"> <sect2 id="bdataio">
<title>BDataIO</title> <title>BDataIO</title>
<itemizedlist> <itemizedlist>
<listitem><para><emphasis>Derived from:</emphasis> none</para></listitem> <listitem><para><emphasis>Derived from:</emphasis> none</para></listitem>
<listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/DataIO.h</filename></para></listitem> <listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/DataIO.h</filename></para></listitem>
<listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem> <listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem>
</itemizedlist> </itemizedlist>
<para><classname>BDataIO</classname> provides a base interface for reading and writing data.</para> <para><classname>BDataIO</classname> provides a base interface for reading and writing data.</para>
<bridgehead renderas="sect2">Constructors and Destructors</bridgehead> <bridgehead renderas="sect2">Constructors and Destructors</bridgehead>
<sect3 id="bdataio_constructor"> <sect3 id="bdataio_constructor">
<title>BDataIO()</title> <title>BDataIO()</title>
<constructorsynopsis> <constructorsynopsis>
<methodname>BDataIO</methodname> <methodname>BDataIO</methodname>
</constructorsynopsis> </constructorsynopsis>
</sect3> </sect3>
<sect3 id="bdataio_destructor"> <sect3 id="bdataio_destructor">
<title>~BDataIO()</title> <title>~BDataIO()</title>
<destructorsynopsis> <destructorsynopsis>
<modifier>virtual</modifier><methodname>~BDataIO</methodname> <modifier>virtual</modifier><methodname>~BDataIO</methodname>
</destructorsynopsis> </destructorsynopsis>
</sect3> </sect3>
<bridgehead renderas="sect2">Member Functions</bridgehead> <bridgehead renderas="sect2">Member Functions</bridgehead>
<sect3 id="bdataio_read"> <sect3 id="bdataio_read">
<title>Read()</title> <title>Read()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>ssize_t</type><methodname>Read</methodname> <modifier>virtual</modifier><type>ssize_t</type><methodname>Read</methodname>
<methodparam><type>void *</type><parameter>buffer</parameter></methodparam> <methodparam><type>void *</type><parameter>buffer</parameter></methodparam>
<methodparam><type>size_t</type><parameter>size</parameter></methodparam> <methodparam><type>size_t</type><parameter>size</parameter></methodparam>
<modifier>= 0</modifier> <modifier>= 0</modifier>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bdataio_write"> <sect3 id="bdataio_write">
<title>Write()</title> <title>Write()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>ssize_t</type><methodname>Write</methodname> <modifier>virtual</modifier><type>ssize_t</type><methodname>Write</methodname>
<methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam> <methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam>
<methodparam><type>size_t</type><parameter>size</parameter></methodparam> <methodparam><type>size_t</type><parameter>size</parameter></methodparam>
<modifier>= 0</modifier> <modifier>= 0</modifier>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
</sect2> </sect2>
+104 -104
View File
@@ -1,105 +1,105 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<sect2 id="bmallocio"> <sect2 id="bmallocio">
<title>BMallocIO</title> <title>BMallocIO</title>
<itemizedlist> <itemizedlist>
<listitem><para><emphasis>Derived from:</emphasis><link linkend="bpositionio"><classname>BPositionIO</classname></link></para></listitem> <listitem><para><emphasis>Derived from:</emphasis><link linkend="bpositionio"><classname>BPositionIO</classname></link></para></listitem>
<listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/DataIO.h</filename></para></listitem> <listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/DataIO.h</filename></para></listitem>
<listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem> <listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem>
</itemizedlist> </itemizedlist>
<para><classname>BMallocIO</classname> provides an interface for reading, writing and seeking in a buffer that it maintains itself.</para> <para><classname>BMallocIO</classname> provides an interface for reading, writing and seeking in a buffer that it maintains itself.</para>
<bridgehead renderas="sect2">Constructors and Destructors</bridgehead> <bridgehead renderas="sect2">Constructors and Destructors</bridgehead>
<sect3 id="bmallocio_constructor"> <sect3 id="bmallocio_constructor">
<title>BMallocIO()</title> <title>BMallocIO()</title>
<constructorsynopsis> <constructorsynopsis>
<methodname>BMallocIO</methodname> <methodname>BMallocIO</methodname>
</constructorsynopsis> </constructorsynopsis>
</sect3> </sect3>
<sect3 id="bmallocio_destructor"> <sect3 id="bmallocio_destructor">
<title>~BMallocIO()</title> <title>~BMallocIO()</title>
<destructorsynopsis> <destructorsynopsis>
<modifier>virtual</modifier><methodname>~BMallocIO</methodname> <modifier>virtual</modifier><methodname>~BMallocIO</methodname>
</destructorsynopsis> </destructorsynopsis>
</sect3> </sect3>
<bridgehead renderas="sect2">Member functions</bridgehead> <bridgehead renderas="sect2">Member functions</bridgehead>
<sect3 id="bmallocio_buffer"> <sect3 id="bmallocio_buffer">
<title>Buffer()</title> <title>Buffer()</title>
<methodsynopsis> <methodsynopsis>
<type>const void *</type><methodname>Buffer</methodname><modifier>const</modifier> <type>const void *</type><methodname>Buffer</methodname><modifier>const</modifier>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bmallocio_bufferlength"> <sect3 id="bmallocio_bufferlength">
<title>BufferLength()</title> <title>BufferLength()</title>
<methodsynopsis> <methodsynopsis>
<type>size_t</type><methodname>BufferLength()</methodname><modifier>const</modifier> <type>size_t</type><methodname>BufferLength()</methodname><modifier>const</modifier>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bmallocio_position"> <sect3 id="bmallocio_position">
<title>Position()</title> <title>Position()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>off_t</type><methodname>Position</methodname><modifier>const</modifier> <modifier>virtual</modifier><type>off_t</type><methodname>Position</methodname><modifier>const</modifier>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bmallocio_readat"> <sect3 id="bmallocio_readat">
<title>ReadAt()</title> <title>ReadAt()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>ssize_t</type><methodname>ReadAt</methodname> <modifier>virtual</modifier><type>ssize_t</type><methodname>ReadAt</methodname>
<methodparam><type>off_t</type><parameter>position</parameter></methodparam> <methodparam><type>off_t</type><parameter>position</parameter></methodparam>
<methodparam><type>void *</type><parameter>buffer</parameter></methodparam> <methodparam><type>void *</type><parameter>buffer</parameter></methodparam>
<methodparam><type>size_t</type><parameter>size</parameter></methodparam> <methodparam><type>size_t</type><parameter>size</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bmallocio_seek"> <sect3 id="bmallocio_seek">
<title>Seek()</title> <title>Seek()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>off_t</type><methodname>Seek</methodname> <modifier>virtual</modifier><type>off_t</type><methodname>Seek</methodname>
<methodparam><type>off_t</type><parameter>position</parameter></methodparam> <methodparam><type>off_t</type><parameter>position</parameter></methodparam>
<methodparam><type>uint32</type><parameter>seekMode</parameter></methodparam> <methodparam><type>uint32</type><parameter>seekMode</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bmallocio_setblocksize"> <sect3 id="bmallocio_setblocksize">
<title>SetBlockSize()</title> <title>SetBlockSize()</title>
<methodsynopsis> <methodsynopsis>
<void/><methodname>SetBlockSize</methodname> <void/><methodname>SetBlockSize</methodname>
<methodparam><type>size_t</type><parameter>blockSize</parameter></methodparam> <methodparam><type>size_t</type><parameter>blockSize</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bmallocio_setsize"> <sect3 id="bmallocio_setsize">
<title>SetSize()</title> <title>SetSize()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>status_t</type><methodname>SetSize</methodname> <modifier>virtual</modifier><type>status_t</type><methodname>SetSize</methodname>
<methodparam><type>off_t</type><parameter>size</parameter></methodparam> <methodparam><type>off_t</type><parameter>size</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bmallocio_writeat"> <sect3 id="bmallocio_writeat">
<title>WriteAt()</title> <title>WriteAt()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>ssize_t</type><methodname>WriteAt</methodname> <modifier>virtual</modifier><type>ssize_t</type><methodname>WriteAt</methodname>
<methodparam><type>off_t</type><parameter>position</parameter></methodparam> <methodparam><type>off_t</type><parameter>position</parameter></methodparam>
<methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam> <methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam>
<methodparam><type>size_t</type><parameter>size</parameter></methodparam> <methodparam><type>size_t</type><parameter>size</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
</sect2> </sect2>
@@ -1,88 +1,88 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<sect2 id="bmemoryio"> <sect2 id="bmemoryio">
<title>BMemoryIO</title> <title>BMemoryIO</title>
<itemizedlist> <itemizedlist>
<listitem><para><emphasis>Derived from:</emphasis><link linkend="bpositionio"><classname>BPositionIO</classname></link></para></listitem> <listitem><para><emphasis>Derived from:</emphasis><link linkend="bpositionio"><classname>BPositionIO</classname></link></para></listitem>
<listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/DataIO.h</filename></para></listitem> <listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/DataIO.h</filename></para></listitem>
<listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem> <listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem>
</itemizedlist> </itemizedlist>
<para><classname>BMemoryIO</classname> implements reading, writing and seeking in a data buffer.</para> <para><classname>BMemoryIO</classname> implements reading, writing and seeking in a data buffer.</para>
<bridgehead renderas="sect2">Constructors and Destructors</bridgehead> <bridgehead renderas="sect2">Constructors and Destructors</bridgehead>
<sect3 id="bmemoryio_constructor"> <sect3 id="bmemoryio_constructor">
<title>BMemoryIO()</title> <title>BMemoryIO()</title>
<constructorsynopsis> <constructorsynopsis>
<methodname>BMemoryIO</methodname> <methodname>BMemoryIO</methodname>
<methodparam><type>void *</type><parameter>data</parameter></methodparam> <methodparam><type>void *</type><parameter>data</parameter></methodparam>
<methodparam><type>size_t</type><parameter>length</parameter></methodparam> <methodparam><type>size_t</type><parameter>length</parameter></methodparam>
</constructorsynopsis> </constructorsynopsis>
<constructorsynopsis> <constructorsynopsis>
<methodname>BMemoryIO</methodname> <methodname>BMemoryIO</methodname>
<methodparam><modifier>const</modifier><type>void *</type><parameter>data</parameter></methodparam> <methodparam><modifier>const</modifier><type>void *</type><parameter>data</parameter></methodparam>
<methodparam><type>size_t</type><parameter>length</parameter></methodparam> <methodparam><type>size_t</type><parameter>length</parameter></methodparam>
</constructorsynopsis> </constructorsynopsis>
</sect3> </sect3>
<sect3 id="bmemoryio_destructor"> <sect3 id="bmemoryio_destructor">
<title>~BMemoryIO()</title> <title>~BMemoryIO()</title>
<destructorsynopsis> <destructorsynopsis>
<modifier>virtual</modifier><methodname>~BMemoryIO</methodname> <modifier>virtual</modifier><methodname>~BMemoryIO</methodname>
</destructorsynopsis> </destructorsynopsis>
</sect3> </sect3>
<bridgehead renderas="sect2">Member functions</bridgehead> <bridgehead renderas="sect2">Member functions</bridgehead>
<sect3 id="bmemoryio_position"> <sect3 id="bmemoryio_position">
<title>Position()</title> <title>Position()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>off_t</type><methodname>Position</methodname><modifier>const</modifier> <modifier>virtual</modifier><type>off_t</type><methodname>Position</methodname><modifier>const</modifier>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bmemoryio_readat"> <sect3 id="bmemoryio_readat">
<title>ReadAt()</title> <title>ReadAt()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>ssize_t</type><methodname>ReadAt</methodname> <modifier>virtual</modifier><type>ssize_t</type><methodname>ReadAt</methodname>
<methodparam><type>off_t</type><parameter>position</parameter></methodparam> <methodparam><type>off_t</type><parameter>position</parameter></methodparam>
<methodparam><type>void *</type><parameter>buffer</parameter></methodparam> <methodparam><type>void *</type><parameter>buffer</parameter></methodparam>
<methodparam><type>size_t</type><parameter>size</parameter></methodparam> <methodparam><type>size_t</type><parameter>size</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bmemoryio_seek"> <sect3 id="bmemoryio_seek">
<title>Seek()</title> <title>Seek()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>off_t</type><methodname>Seek</methodname> <modifier>virtual</modifier><type>off_t</type><methodname>Seek</methodname>
<methodparam><type>off_t</type><parameter>position</parameter></methodparam> <methodparam><type>off_t</type><parameter>position</parameter></methodparam>
<methodparam><type>uint32</type><parameter>seekMode</parameter></methodparam> <methodparam><type>uint32</type><parameter>seekMode</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bmemoryio_setsize"> <sect3 id="bmemoryio_setsize">
<title>SetSize()</title> <title>SetSize()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>status_t</type><methodname>SetSize</methodname> <modifier>virtual</modifier><type>status_t</type><methodname>SetSize</methodname>
<methodparam><type>off_t</type><parameter>size</parameter></methodparam> <methodparam><type>off_t</type><parameter>size</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bmemoryio_writeat"> <sect3 id="bmemoryio_writeat">
<title>WriteAt()</title> <title>WriteAt()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>ssize_t</type><methodname>WriteAt</methodname> <modifier>virtual</modifier><type>ssize_t</type><methodname>WriteAt</methodname>
<methodparam><type>off_t</type><parameter>position</parameter></methodparam> <methodparam><type>off_t</type><parameter>position</parameter></methodparam>
<methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam> <methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam>
<methodparam><type>size_t</type><parameter>size</parameter></methodparam> <methodparam><type>size_t</type><parameter>size</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
</sect2> </sect2>
@@ -1,112 +1,112 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<sect2 id="bpositionio"> <sect2 id="bpositionio">
<title>BPositionIO</title> <title>BPositionIO</title>
<itemizedlist> <itemizedlist>
<listitem><para><emphasis>Derived from:</emphasis><link linkend="bdataio"><classname>BDataIO</classname></link></para></listitem> <listitem><para><emphasis>Derived from:</emphasis><link linkend="bdataio"><classname>BDataIO</classname></link></para></listitem>
<listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/DataIO.h</filename></para></listitem> <listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/DataIO.h</filename></para></listitem>
<listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem> <listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem>
</itemizedlist> </itemizedlist>
<para><classname>BPositionIO</classname> provides an interface for reading, writing and seeking within data.</para> <para><classname>BPositionIO</classname> provides an interface for reading, writing and seeking within data.</para>
<bridgehead renderas="sect2">Constructors and Destructors</bridgehead> <bridgehead renderas="sect2">Constructors and Destructors</bridgehead>
<sect3 id="bpositionio_constructor"> <sect3 id="bpositionio_constructor">
<title>BPositionIO()</title> <title>BPositionIO()</title>
<constructorsynopsis> <constructorsynopsis>
<methodname>BPositionIO</methodname> <methodname>BPositionIO</methodname>
</constructorsynopsis> </constructorsynopsis>
</sect3> </sect3>
<sect3 id="bpositionio_destructor"> <sect3 id="bpositionio_destructor">
<title>~BPositionIO()</title> <title>~BPositionIO()</title>
<destructorsynopsis> <destructorsynopsis>
<modifier>virtual</modifier><methodname>~BPositionIO</methodname> <modifier>virtual</modifier><methodname>~BPositionIO</methodname>
</destructorsynopsis> </destructorsynopsis>
</sect3> </sect3>
<bridgehead renderas="sect2">Member functions</bridgehead> <bridgehead renderas="sect2">Member functions</bridgehead>
<sect3 id="bpositionio_getsize"> <sect3 id="bpositionio_getsize">
<title>GetSize()</title> <title>GetSize()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>status_t</type><methodname>GetSize</methodname> <modifier>virtual</modifier><type>status_t</type><methodname>GetSize</methodname>
<methodparam><type>off_t *</type><parameter>size</parameter></methodparam> <methodparam><type>off_t *</type><parameter>size</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bpositionio_position"> <sect3 id="bpositionio_position">
<title>Position()</title> <title>Position()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>off_t</type><methodname>Position</methodname><modifier>const</modifier><modifier>= 0</modifier> <modifier>virtual</modifier><type>off_t</type><methodname>Position</methodname><modifier>const</modifier><modifier>= 0</modifier>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bpositionio_read"> <sect3 id="bpositionio_read">
<title>Read()</title> <title>Read()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>ssize_t</type><methodname>Read</methodname> <modifier>virtual</modifier><type>ssize_t</type><methodname>Read</methodname>
<methodparam><type>void *</type><parameter>buffer</parameter></methodparam> <methodparam><type>void *</type><parameter>buffer</parameter></methodparam>
<methodparam><type>size_t</type><parameter>size</parameter></methodparam> <methodparam><type>size_t</type><parameter>size</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bpositionio_readat"> <sect3 id="bpositionio_readat">
<title>ReadAt()</title> <title>ReadAt()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>ssize_t</type><methodname>ReadAt</methodname> <modifier>virtual</modifier><type>ssize_t</type><methodname>ReadAt</methodname>
<methodparam><type>off_t</type><parameter>position</parameter></methodparam> <methodparam><type>off_t</type><parameter>position</parameter></methodparam>
<methodparam><type>void *</type><parameter>buffer</parameter></methodparam> <methodparam><type>void *</type><parameter>buffer</parameter></methodparam>
<methodparam><type>size_t</type><parameter>size</parameter></methodparam> <methodparam><type>size_t</type><parameter>size</parameter></methodparam>
<modifier>= 0</modifier> <modifier>= 0</modifier>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bpositionio_seek"> <sect3 id="bpositionio_seek">
<title>Seek()</title> <title>Seek()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>off_t</type><methodname>Seek</methodname> <modifier>virtual</modifier><type>off_t</type><methodname>Seek</methodname>
<methodparam><type>off_t</type><parameter>position</parameter></methodparam> <methodparam><type>off_t</type><parameter>position</parameter></methodparam>
<methodparam><type>uint32</type><parameter>seekMode</parameter></methodparam> <methodparam><type>uint32</type><parameter>seekMode</parameter></methodparam>
<modifier>= 0</modifier> <modifier>= 0</modifier>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bpositionio_setsize"> <sect3 id="bpositionio_setsize">
<title>SetSize()</title> <title>SetSize()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>status_t</type><methodname>SetSize</methodname> <modifier>virtual</modifier><type>status_t</type><methodname>SetSize</methodname>
<methodparam><type>off_t</type><parameter>size</parameter></methodparam> <methodparam><type>off_t</type><parameter>size</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bpositionio_write"> <sect3 id="bpositionio_write">
<title>Write()</title> <title>Write()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>ssize_t</type><methodname>Write</methodname> <modifier>virtual</modifier><type>ssize_t</type><methodname>Write</methodname>
<methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam> <methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam>
<methodparam><type>size_t</type><parameter>size</parameter></methodparam> <methodparam><type>size_t</type><parameter>size</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
<sect3 id="bpositionio_writeat"> <sect3 id="bpositionio_writeat">
<title>WriteAt()</title> <title>WriteAt()</title>
<methodsynopsis> <methodsynopsis>
<modifier>virtual</modifier><type>ssize_t</type><methodname>WriteAt</methodname> <modifier>virtual</modifier><type>ssize_t</type><methodname>WriteAt</methodname>
<methodparam><type>off_t</type><parameter>position</parameter></methodparam> <methodparam><type>off_t</type><parameter>position</parameter></methodparam>
<methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam> <methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam>
<methodparam><type>size_t</type><parameter>size</parameter></methodparam> <methodparam><type>size_t</type><parameter>size</parameter></methodparam>
<modifier>= 0</modifier> <modifier>= 0</modifier>
</methodsynopsis> </methodsynopsis>
</sect3> </sect3>
</sect2> </sect2>
+151 -151
View File
@@ -1,151 +1,151 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<sect2 id="bstopwatch"> <sect2 id="bstopwatch">
<title>BStopWatch</title> <title>BStopWatch</title>
<itemizedlist> <itemizedlist>
<listitem><para><emphasis>Derived from:</emphasis> none</para></listitem> <listitem><para><emphasis>Derived from:</emphasis> none</para></listitem>
<listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/StopWatch.h</filename></para></listitem> <listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/StopWatch.h</filename></para></listitem>
<listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem> <listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem>
</itemizedlist> </itemizedlist>
<para><classname>BStopWatch</classname> is a timer class.</para> <para><classname>BStopWatch</classname> is a timer class.</para>
<para> <para>
This class provides method to time events. The interface is designed to behave like a This class provides method to time events. The interface is designed to behave like a
physical stopwatch. It is especially useful for debugging certain parts of your code, since physical stopwatch. It is especially useful for debugging certain parts of your code, since
it can behave like a 'cheap' profiler. it can behave like a 'cheap' profiler.
</para> </para>
<bridgehead renderas="sect2">Constructors and Destructors</bridgehead> <bridgehead renderas="sect2">Constructors and Destructors</bridgehead>
<sect3 id="bstopwatch_constructor"> <sect3 id="bstopwatch_constructor">
<title>BStopWatch()</title> <title>BStopWatch()</title>
<constructorsynopsis> <constructorsynopsis>
<methodname>BStopWatch</methodname> <methodname>BStopWatch</methodname>
<methodparam><modifier>const</modifier><type>char *</type><parameter>name</parameter></methodparam> <methodparam><modifier>const</modifier><type>char *</type><parameter>name</parameter></methodparam>
<methodparam><type>bool</type><parameter>silent</parameter><initializer>false</initializer></methodparam> <methodparam><type>bool</type><parameter>silent</parameter><initializer>false</initializer></methodparam>
</constructorsynopsis> </constructorsynopsis>
<para> <para>
The constructor creates a clean <classname>BStopWatch</classname> object. This object The constructor creates a clean <classname>BStopWatch</classname> object. This object
can be given a <parameter>name</parameter>. As soon as the object is created, the time can be given a <parameter>name</parameter>. As soon as the object is created, the time
will start ticking away. This class is designed to be usuable as a primitive profiling tool. will start ticking away. This class is designed to be usuable as a primitive profiling tool.
If you are profiling your code with this class, pass <literal>true</literal> as the If you are profiling your code with this class, pass <literal>true</literal> as the
<parameter>silent</parameter> parameter. Whenever the object is destroyed, information on <parameter>silent</parameter> parameter. Whenever the object is destroyed, information on
the elapsed time will be streamed to standard output. the elapsed time will be streamed to standard output.
</para> </para>
</sect3> </sect3>
<sect3 id="bstopwatch_destructor"> <sect3 id="bstopwatch_destructor">
<title>~BStopWatch()</title> <title>~BStopWatch()</title>
<destructorsynopsis> <destructorsynopsis>
<modifier>virtual</modifier><methodname>~BStopWatch</methodname> <modifier>virtual</modifier><methodname>~BStopWatch</methodname>
</destructorsynopsis> </destructorsynopsis>
<para> <para>
Destroys the object. If the object was constructed with the parameter Destroys the object. If the object was constructed with the parameter
<literal>silent</literal> set t to <literal>false</literal>, this destructor will print <literal>silent</literal> set t to <literal>false</literal>, this destructor will print
information on the elapsed time to standard output. information on the elapsed time to standard output.
</para> </para>
</sect3> </sect3>
<bridgehead renderas="sect2">Member Functions</bridgehead> <bridgehead renderas="sect2">Member Functions</bridgehead>
<sect3 id="bstopwatch_elapsedtime"> <sect3 id="bstopwatch_elapsedtime">
<title>ElapsedTime()</title> <title>ElapsedTime()</title>
<methodsynopsis> <methodsynopsis>
<type>bigtime_t</type><methodname>ElapsedTime</methodname><modifier>const</modifier> <type>bigtime_t</type><methodname>ElapsedTime</methodname><modifier>const</modifier>
</methodsynopsis> </methodsynopsis>
<para> <para>
This method returns the elapsed time in microseconds since the object was created. If This method returns the elapsed time in microseconds since the object was created. If
the object is suspended, the time until the suspend will be returned. the object is suspended, the time until the suspend will be returned.
</para> </para>
<para> <para>
See also: Suspend(). See also: Suspend().
</para> </para>
</sect3> </sect3>
<sect3 id="bstopwatch_lap"> <sect3 id="bstopwatch_lap">
<title>Lap</title> <title>Lap</title>
<methodsynopsis> <methodsynopsis>
<type>bigtime_t</type><methodname>Lap</methodname> <type>bigtime_t</type><methodname>Lap</methodname>
</methodsynopsis> </methodsynopsis>
<para> <para>
This method sets a lap. With the current implementation you are unable to actually This method sets a lap. With the current implementation you are unable to actually
retrieve the timings of the laps. This is only printed to the standard output when the retrieve the timings of the laps. This is only printed to the standard output when the
object is destroyed. Thus making this tool only usuable for use when doing some object is destroyed. Thus making this tool only usuable for use when doing some
profiling. profiling.
</para> </para>
<note><para> <note><para>
Please note that the current implementation is limited to 10 laps. The value returned Please note that the current implementation is limited to 10 laps. The value returned
is the time that has passed since the timer was started (and not the time that has is the time that has passed since the timer was started (and not the time that has
passed since the last lap). Any lap call beyond the 10th lap will overwrite the last passed since the last lap). Any lap call beyond the 10th lap will overwrite the last
value. Note that if the timer is suspended, nothing happens and the method will return value. Note that if the timer is suspended, nothing happens and the method will return
<returnvalue>0</returnvalue>. <returnvalue>0</returnvalue>.
</para></note> </para></note>
</sect3> </sect3>
<sect3 id="bstopwatch_name"> <sect3 id="bstopwatch_name">
<title>Name()</title> <title>Name()</title>
<methodsynopsis> <methodsynopsis>
<type>const char *</type><methodname>Name</methodname><modifier>const</modifier> <type>const char *</type><methodname>Name</methodname><modifier>const</modifier>
</methodsynopsis> </methodsynopsis>
<para> <para>
Returns the name that was given when the object was constructed. Returns the name that was given when the object was constructed.
</para> </para>
</sect3> </sect3>
<sect3 id="bstopwatch_reset"> <sect3 id="bstopwatch_reset">
<title>Reset()</title> <title>Reset()</title>
<methodsynopsis> <methodsynopsis>
<void/><methodname>Reset</methodname> <void/><methodname>Reset</methodname>
</methodsynopsis> </methodsynopsis>
<para> <para>
Resets the object: it clears the start time, it clears the stored laps and it restarts Resets the object: it clears the start time, it clears the stored laps and it restarts
the timer. the timer.
</para> </para>
</sect3> </sect3>
<sect3 id="bstopwatch_resume"> <sect3 id="bstopwatch_resume">
<title>Resume()</title> <title>Resume()</title>
<methodsynopsis> <methodsynopsis>
<void/><methodname>Resume</methodname> <void/><methodname>Resume</methodname>
</methodsynopsis> </methodsynopsis>
<para> <para>
Resumes the timer when it is in a suspended state. Resumes the timer when it is in a suspended state.
</para> </para>
<para> <para>
See Also: Suspend(). See Also: Suspend().
</para> </para>
</sect3> </sect3>
<sect3 id="bstopwatch_suspend"> <sect3 id="bstopwatch_suspend">
<title>Suspend()</title> <title>Suspend()</title>
<methodsynopsis> <methodsynopsis>
<void/><methodname>Suspend</methodname> <void/><methodname>Suspend</methodname>
</methodsynopsis> </methodsynopsis>
<para> <para>
Suspends the timer. Suspends the timer.
</para> </para>
<para> <para>
See Also: Resume(). See Also: Resume().
</para> </para>
</sect3> </sect3>
</sect2> </sect2>
File diff suppressed because it is too large Load Diff
+35 -35
View File
@@ -1,35 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY archivable SYSTEM "Archivable.xml"> <!ENTITY archivable SYSTEM "Archivable.xml">
<!ENTITY autolock SYSTEM "Autolock.xml"> <!ENTITY autolock SYSTEM "Autolock.xml">
<!ENTITY blockcache SYSTEM "BlockCache.xml"> <!ENTITY blockcache SYSTEM "BlockCache.xml">
<!ENTITY dataio SYSTEM "DataIO.xml"> <!ENTITY dataio SYSTEM "DataIO.xml">
<!ENTITY flattenable SYSTEM "Flattenable.xml"> <!ENTITY flattenable SYSTEM "Flattenable.xml">
<!ENTITY list SYSTEM "List.xml"> <!ENTITY list SYSTEM "List.xml">
<!ENTITY locker SYSTEM "Locker.xml"> <!ENTITY locker SYSTEM "Locker.xml">
<!ENTITY mallocio SYSTEM "MallocIO.xml"> <!ENTITY mallocio SYSTEM "MallocIO.xml">
<!ENTITY memoryio SYSTEM "MemoryIO.xml"> <!ENTITY memoryio SYSTEM "MemoryIO.xml">
<!ENTITY positionio SYSTEM "PositionIO.xml"> <!ENTITY positionio SYSTEM "PositionIO.xml">
<!ENTITY stopwatch SYSTEM "StopWatch.xml"> <!ENTITY stopwatch SYSTEM "StopWatch.xml">
<!ENTITY string SYSTEM "String.xml"> <!ENTITY string SYSTEM "String.xml">
]> ]>
<sect1 id="supportapi"> <sect1 id="supportapi">
<title>Support Kit API</title> <title>Support Kit API</title>
&archivable; &archivable;
&autolock; &autolock;
&dataio; &dataio;
&blockcache; &blockcache;
&flattenable; &flattenable;
&list; &list;
&locker; &locker;
&mallocio; &mallocio;
&memoryio; &memoryio;
&positionio; &positionio;
&stopwatch; &stopwatch;
&string; &string;
</sect1> </sect1>
+48 -48
View File
@@ -1,48 +1,48 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
]> ]>
<sect1 id="support-intro"> <sect1 id="support-intro">
<title>Introduction</title> <title>Introduction</title>
<para> <para>
The <emphasis>Support Kit</emphasis> is an assortment of easy to use classes which allow a programmer to quickly extend their applications without re-writing much common functionality. Many benefits can arrise from using these classes when one starts to extend an application in the future. Functionality includes: The <emphasis>Support Kit</emphasis> is an assortment of easy to use classes which allow a programmer to quickly extend their applications without re-writing much common functionality. Many benefits can arrise from using these classes when one starts to extend an application in the future. Functionality includes:
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
Threading utility classes: Threading utility classes:
<itemizedlist> <itemizedlist>
<listitem><para><link linkend="blocker">BLocker</link> and <link linkend="bautolock">BAutoLock</link></para></listitem> <listitem><para><link linkend="blocker">BLocker</link> and <link linkend="bautolock">BAutoLock</link></para></listitem>
<listitem><para> "Thread Local Storage" </para></listitem> <listitem><para> "Thread Local Storage" </para></listitem>
</itemizedlist> </itemizedlist>
</para></listitem> </para></listitem>
<listitem><para>Archiving and IO:</para> <listitem><para>Archiving and IO:</para>
<itemizedlist> <itemizedlist>
<listitem><para><link linkend="barchivable">BArchivable</link></para></listitem> <listitem><para><link linkend="barchivable">BArchivable</link></para></listitem>
<listitem><para><link linkend="bflattenable">BFlattenable</link></para></listitem> <listitem><para><link linkend="bflattenable">BFlattenable</link></para></listitem>
<listitem><para><link linkend="bdataio">BDataIO</link></para> <listitem><para><link linkend="bdataio">BDataIO</link></para>
<itemizedlist> <itemizedlist>
<listitem><para><link linkend="bpositionio">BPositionIO</link></para> <listitem><para><link linkend="bpositionio">BPositionIO</link></para>
<itemizedlist> <itemizedlist>
<listitem><para><link linkend="bmemoryio">BMemoryIO</link></para></listitem> <listitem><para><link linkend="bmemoryio">BMemoryIO</link></para></listitem>
<listitem><para><link linkend="bmallocio">BMallocIO</link></para></listitem> <listitem><para><link linkend="bmallocio">BMallocIO</link></para></listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</listitem> </listitem>
</itemizedlist></listitem> </itemizedlist></listitem>
<listitem><para> <listitem><para>
Container classes: Container classes:
<itemizedlist> <itemizedlist>
<listitem><para><link linkend="bblockcache">BBlockCache</link></para></listitem> <listitem><para><link linkend="bblockcache">BBlockCache</link></para></listitem>
<listitem><para><link linkend="blist">BList</link></para></listitem> <listitem><para><link linkend="blist">BList</link></para></listitem>
<listitem><para><link linkend="bstring">BString</link></para></listitem> <listitem><para><link linkend="bstring">BString</link></para></listitem>
</itemizedlist> </itemizedlist>
</para></listitem> </para></listitem>
<listitem><para><link linkend="bstopwatch">BStopWatch</link></para></listitem> <listitem><para><link linkend="bstopwatch">BStopWatch</link></para></listitem>
<listitem><para> Common types and constants </para></listitem> <listitem><para> Common types and constants </para></listitem>
<listitem><para> Error codes for all kits </para></listitem> <listitem><para> Error codes for all kits </para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</sect1> </sect1>