autodoc.git / modref.xml

autodoc.git/modref.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2020-06-28' version='Pike v8.1.13'> + <manual time-stamp='2020-06-29' version='Pike v8.1.13'>    <dir name='./ignored'>    <file name='./ignored/ignored'>    <chapter number='1' title='ignored'>    <autodoc>   <namespace name=''>   <doc><text><p>Symbols implicitly inherited from the virtual base class.</p>   <p> These symbols exist mainly to simplify implementation of    the corresponding lfuns.</p>   </text><group><seealso/><text><p><ref resolved='lfun::'>lfun::</ref></p>   </text></group></doc>
autodoc.git/modref.xml:1126:   </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/modref.xml:1910:   <variable name='rsa'><type><object resolved='7.8::Crypto.RSA'>Crypto.RSA</object></type></variable>   </docgroup>   <docgroup homogen-name='set_cipher_suite' homogen-type='method'><doc><text><p>Sets the proper authentication method and cipher specification    for the given cipher <ref resolved='7.8::SSL.session.set_cipher_suite.suite'>suite</ref> and <ref>verison</ref>.</p>   </text></doc>   <method name='set_cipher_suite'>   <arguments><argument name='suite'><type><int/></type></argument><argument name='version'><type><or><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object><int/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup> - <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='7.8::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is + <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='predef::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is    supported.</p>   </text></doc>   <method name='set_compression_method'>   <arguments><argument name='compr'><type><int/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='sslfile'>   <doc><text><p>Interface similar to <ref resolved='7.8::Stdio.File'>Stdio.File</ref>.</p>
autodoc.git/modref.xml:133184:    automatically be unlocked.</p>   <p> The <ref resolved='predef::Thread.Mutex.shared_lock.type'>type</ref> argument specifies what <ref resolved='predef::Thread.Mutex.lock'>lock()</ref> should do if the    mutex is already locked exclusively by this thread:</p>   <int><group><value>0</value><text><p>Throw an error.</p>   </text></group><group><value>1</value><text><p>Sleep until the mutex is unlocked. Useful if some    other thread will unlock it.</p>   </text></group><group><value>2</value><text><p>Return zero. This allows recursion within a locked region of    code, but in conjunction with other locks it easily leads    to unspecified locking order and therefore a risk for deadlocks.</p>   </text></group></int> - </text><group><note/><text><p>If the mutex is destructed while it's locked or while threads are + </text><group><note/><text><p>Note that if the current thread already holds a shared key, +  a new will be created without waiting, and regardless of +  the value of <ref resolved='predef::Thread.Mutex.shared_lock.type'>type</ref>.</p> + </text></group><group><note/><text><p>If the mutex is destructed while it's locked or while threads are    waiting on it, it will continue to exist internally until the last    thread has stopped waiting and the last <ref resolved='predef::Thread.MutexKey'>MutexKey</ref> has    disappeared, but further calls to the functions in this class will    fail as is usual for destructed objects.</p> - </text></group><group><note/><text><p>A thread may hold several shared locks concurrently.</p> +    </text></group><group><seealso/><text><p><ref resolved='predef::Thread.Mutex.lock'>lock()</ref>, <ref resolved='predef::Thread.Mutex.trylock'>trylock()</ref>, <ref resolved='predef::Thread.Mutex.try_shared_lock'>try_shared_lock()</ref></p>   </text></group></doc>   <method name='shared_lock'>   <arguments/>   <returntype><object resolved='predef::Thread.MutexKey'>MutexKey</object></returntype>   </method>   <method name='shared_lock'>   <arguments><argument name='type'><type><int/></type></argument></arguments>   <returntype><object resolved='predef::Thread.MutexKey'>MutexKey</object></returntype>   </method>