autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2020-06-13' version='Pike v8.1.13'> + <manual time-stamp='2020-06-14' version='Pike v8.1.13'>    <dir name='./onepage'>    <file name='./onepage/manual.html'>    <chapter number='1' title='Control Structures'>      <p>In this chapter all the control structures in Pike will be   explained. Control structures are used to control the flow of the   program execution. Note that functions that make the program pause and   simple function calls are not qualified as control structures.</p>      <section number='1' title='Conditions'>
autodoc.git/onepage.xml:2688:   </docgroup>   </class>   <class name='DES3'>   <docgroup homogen-name='CBC' homogen-type='inherit'>   <inherit name='CBC'><classname resolved='8.0::Crypto.CBC'>Crypto.CBC</classname></inherit>   </docgroup>   </class>   <class name='DHKeyExchange'>   <doc><text><p>Implements Diffie-Hellman key-exchange.</p>   <p> The following key exchange methods are implemented here: -  <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p> +  <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p>   </text></doc>   <docgroup homogen-name='create' homogen-type='method'>   <method name='create'><modifiers><protected/></modifiers>   <arguments><argument name='p'><type><object resolved='7.8::SSL.Cipher.DHParameters'>DHParameters</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='DHParameters'>   <doc><text><p>Diffie-Hellman parameters.</p>
autodoc.git/onepage.xml:134854:    too small to hold the <ref resolved='predef::Thread.Queue.write.value'>value</ref> it will be expanded to make room.    The number of items in the queue after the write is returned.</p>   </text><group><seealso/><text><p><ref resolved='predef::Thread.Queue.read'>read()</ref></p>   </text></group></doc>   <method name='write'>   <arguments><argument name='value'><type><mixed/></type></argument></arguments>   <returntype><int/></returntype>   </method>   </docgroup>   </class> -  + <class name='RWKey'> + <docgroup homogen-name='downgrade' homogen-type='method'><doc><text><p>Downgrade this key into a (temporary) read-lock.</p> + <p> This allows for concurrent read operations. This is +  a no-op for keys that aren't write-locks.</p> + <p> If the key was a write-lock, it may later be upgraded +  back into a write-lock.</p> + </text><group><seealso/><text><p><ref resolved='predef::Thread.RWKey.upgrade'>upgrade()</ref></p> + </text></group></doc> + <method name='downgrade'> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='upgrade' homogen-type='method'><doc><text><p>Upgrade this key back into a write-lock.</p> + <p> This operation is only allowed on keys that have started +  out as write-locks.</p> + <p> This is a no-op on keys that already are write-locks.</p> + <p> For a downgraded write-lock, this operation will block +  until all concurrent read-locks are released.</p> + </text><group><throws/><text><p>Throws an error for keys that didn't start out as write-locks.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Thread.RWKey.downgrade'>downgrade()</ref></p> + </text></group></doc> + <method name='upgrade'> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> + </class>   <class name='RWMutex'>   <doc><text><p>Read-Write Mutex.</p>   <p> A mutex that allows for a single writer (exclusive locking)    or multiple readers (shared locking).</p>   </text><group><seealso/><text><p><ref resolved='predef::Thread.Mutex'>Mutex</ref></p>   </text></group></doc>   <docgroup homogen-name='_sprintf' homogen-type='method'><doc><text><p>Describes the mutex including the thread(s) that currently hold    locks (if any).</p>   </text></doc>   <method name='_sprintf'>
autodoc.git/onepage.xml:134876:   <returntype><string/></returntype>   </method>   </docgroup>   <docgroup homogen-name='read_lock' homogen-type='method'><doc><text><p>Obtain a lock for reading (shared lock).</p>   </text><group><throws/><text><p>Throws an error if the current thread already has    a lock (read or write).</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Thread.RWMutex.write_lock'>write_lock()</ref></p>   </text></group></doc>   <method name='read_lock'>   <arguments/> - <returntype><object>RWKey</object></returntype> + <returntype><object resolved='predef::Thread.RWKey'>RWKey</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='write_lock' homogen-type='method'><doc><text><p>Obtain a lock for writing (exclusive lock).</p>   </text><group><throws/><text><p>Throws an error if the current thread already has    a lock (read or write).</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Thread.RWMutex.read_lock'>read_lock()</ref>, <ref>try_read_lock()</ref></p>   </text></group></doc>   <method name='write_lock'>   <arguments/> - <returntype><object>RWKey</object></returntype> + <returntype><object resolved='predef::Thread.RWKey'>RWKey</object></returntype>   </method>   </docgroup>   </class>   <class name='ResourceCount'>   <doc><text><p>Implements an inverted-semaphore-like resource    counter. A thread can poll or perform a blocking wait for the    resource-count to drop below a certain <ref>level</ref>.</p>   </text><group><seealso/><text><p><ref resolved='predef::Thread.ResourceCountKey'>ResourceCountKey</ref>, <ref resolved='predef::Thread.Condition'>Condition</ref>, <ref resolved='predef::Thread.Mutex'>Mutex</ref></p>   </text></group></doc>   <docgroup homogen-name='acquire' homogen-type='method'><doc><text><p>Increments the resource-counter.</p>