📄 classpsafecoll.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title> TemplatePSafeColl< Coll, Base > class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>PSafeColl< Coll, Base > Class Template Reference</h1><code>#include <<a class="el" href="safecoll_8h-source.html">safecoll.h</a>></code><p><p>Inheritance diagram for PSafeColl< Coll, Base >:<p><center><img src="classPSafeColl.png" usemap="#PSafeColl< Coll, Base >_map" border="0" alt=""></center><map name="PSafeColl< Coll, Base >_map"><area href="classPSafeCollection.html" alt="PSafeCollection" shape="rect" coords="0,56,151,80"><area href="classPObject.html" alt="PObject" shape="rect" coords="0,0,151,24"></map><a href="classPSafeColl-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Public Methods</h2></td></tr><tr><td colspan="2"><div class="groupHeader">Construction</div></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPSafeColl.html#z337_0">PSafeColl</a> ()</td></tr><tr><td colspan="2"><div class="groupHeader">Operations</div></td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPSafePtr.html">PSafePtr</a>< Base > </td><td valign=bottom><a class="el" href="classPSafeColl.html#z339_0">Append</a> (Base *obj, <a class="el" href="safecoll_8h.html#a4">PSafetyMode</a> mode=PSafeReference)</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPSafeColl.html#z339_1">Remove</a> (Base *obj)</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPSafeColl.html#z339_2">RemoveAt</a> (PINDEX idx)</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPSafePtr.html">PSafePtr</a>< Base > </td><td valign=bottom><a class="el" href="classPSafeColl.html#z339_3">GetAt</a> (PINDEX idx, <a class="el" href="safecoll_8h.html#a4">PSafetyMode</a> mode=PSafeReadWrite)</td></tr><tr><td nowrap align=right valign=top>virtual <a class="el" href="classPSafePtr.html">PSafePtr</a>< Base > </td><td valign=bottom><a class="el" href="classPSafeColl.html#z339_4">FindWithLock</a> (const Base &value, <a class="el" href="safecoll_8h.html#a4">PSafetyMode</a> mode=PSafeReadWrite)</td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2><h3>template<class Coll, class Base><br> class PSafeColl< Coll, Base ></h3>This class defines a thread-safe collection of objects.<p>This is part of a set of classes to solve the general problem of a collection (eg a PList or PDictionary) of objects that needs to be a made thread safe. Any thread can add, read, write or remove an object with both the object and the database of objects itself kept thread safe.<p>See the <a class="el" href="classPSafeObject.html">PSafeObject</a> class for more details. Especially in regard to enumeration of collections. <p><hr><h2>Constructor & Destructor Documentation</h2><a name="z337_0" doxytag="PSafeColl::PSafeColl"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" colspan="4">template<class Coll, class Base> </td> </tr> <tr> <td class="md" nowrap valign="top"> PSafeColl< Coll, Base >::PSafeColl </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create a safe list collection wrapper around the real collection. </td> </tr></table><hr><h2>Member Function Documentation</h2><a name="z339_0" doxytag="PSafeColl::Append"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" colspan="4">template<class Coll, class Base> </td> </tr> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="classPSafePtr.html">PSafePtr</a><Base> PSafeColl< Coll, Base >::Append </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">Base * </td> <td class="mdname" nowrap> <em>obj</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="safecoll_8h.html#a4">PSafetyMode</a> </td> <td class="mdname" nowrap> <em>mode</em> = PSafeReference</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [inline, virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Add an object to the collection. This uses the <a class="el" href="classPCollection.html#z75_0">PCollection::Append()</a> function to add the object to the collection, with full mutual exclusion locking on the collection. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>mode</em> </td><td>Object to add to safe collection. </td></tr></table></dl> </td> </tr></table><a name="z339_4" doxytag="PSafeColl::FindWithLock"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" colspan="4">template<class Coll, class Base> </td> </tr> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="classPSafePtr.html">PSafePtr</a><Base> PSafeColl< Coll, Base >::FindWithLock </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const Base & </td> <td class="mdname" nowrap> <em>value</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="safecoll_8h.html#a4">PSafetyMode</a> </td> <td class="mdname" nowrap> <em>mode</em> = PSafeReadWrite</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [inline, virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Find the instance in the collection of an object with the same value. The returned safe pointer will increment the reference count on the <a class="el" href="classPSafeObject.html">PSafeObject</a> and lock to the object in the mode specified. The lock will remain until the <a class="el" href="classPSafePtr.html">PSafePtr</a> goes out of scope. </td> </tr></table><a name="z339_3" doxytag="PSafeColl::GetAt"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" colspan="4">template<class Coll, class Base> </td> </tr> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="classPSafePtr.html">PSafePtr</a><Base> PSafeColl< Coll, Base >::GetAt </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">PINDEX </td> <td class="mdname" nowrap> <em>idx</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="safecoll_8h.html#a4">PSafetyMode</a> </td> <td class="mdname" nowrap> <em>mode</em> = PSafeReadWrite</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [inline, virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Get the instance in the collection of the index. The returned safe pointer will increment the reference count on the <a class="el" href="classPSafeObject.html">PSafeObject</a> and lock to the object in the mode specified. The lock will remain until the <a class="el" href="classPSafePtr.html">PSafePtr</a> goes out of scope. </td> </tr></table><a name="z339_1" doxytag="PSafeColl::Remove"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" colspan="4">template<class Coll, class Base> </td> </tr> <tr> <td class="md" nowrap valign="top"> virtual BOOL PSafeColl< Coll, Base >::Remove </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">Base * </td> <td class="mdname1" valign="top" nowrap> <em>obj</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline, virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Remove an object to the collection. This function removes the object from the collection itself, but does not actually delete the object. It simply moves the object to a list of objects to be garbage collected at a later time.<p>As for <a class="el" href="classPSafeColl.html#z339_0">Append()</a> full mutual exclusion locking on the collection itself is maintained. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>obj</em> </td><td>Object to remove from safe collection </td></tr></table></dl> </td> </tr></table><a name="z339_2" doxytag="PSafeColl::RemoveAt"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" colspan="4">template<class Coll, class Base> </td> </tr> <tr> <td class="md" nowrap valign="top"> virtual BOOL PSafeColl< Coll, Base >::RemoveAt </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">PINDEX </td> <td class="mdname1" valign="top" nowrap> <em>idx</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline, virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Remove an object to the collection. This function removes the object from the collection itself, but does not actually delete the object. It simply moves the object to a list of objects to be garbage collected at a later time.<p>As for <a class="el" href="classPSafeColl.html#z339_0">Append()</a> full mutual exclusion locking on the collection itself is maintained. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>idx</em> </td><td>Index to remove </td></tr></table></dl> </td> </tr></table><hr>The documentation for this class was generated from the following file:<ul><li><a class="el" href="safecoll_8h-source.html">safecoll.h</a></ul><hr><address style="align: right;"><small>Generated on Wed Sep 29 22:44:18 2004 for PWLib by<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.18 </small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -