autodoc.git / autodoc.xml

version» Context lines:

autodoc.git/autodoc.xml:1123:   </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/autodoc.xml:1740:   <variable name='client_cert_distinguished_names'><type><array><valuetype><string/></valuetype></array></type></variable>   </docgroup>   <docgroup homogen-type='variable'><doc><text><p>Random cookies, sent and received with the hello-messages.</p>   </text></doc>   <variable name='client_random'><type><string/></type></variable>   <variable name='server_random'><type><string/></type></variable>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'><doc><group><param name='is_server'/><text><p>Whether this is the server end of the connection or not.</p>   </text></group><group><param name='ctx'/><text><p>The context for the connection.</p>   </text></group><group><param name='min_version'/><text><p>Minimum version of SSL to support. -  Defaults to <ref resolved='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p>   </text></group><group><param name='max_version'/><text><p>Maximum version of SSL to support.    Defaults to <ref resolved='7.8::SSL.Constants.PROTOCOL_minor'>Constants.PROTOCOL_minor</ref>.</p>   </text></group></doc>   <method name='create'>   <arguments><argument name='is_server'><type><int/></type></argument><argument name='ctx'><type><or><void/><object resolved='7.8::SSL.context'>SSL.context</object></or></type></argument><argument name='min_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument><argument name='max_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='handle_handshake' homogen-type='method'><doc><text><p>Do handshake processing. Type is one of HANDSHAKE_*, data is the    contents of the packet, and raw is the raw packet received (needed
autodoc.git/autodoc.xml:134060:    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='try_upgrade' homogen-type='method'><doc><text><p>Attempt to 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, in which -  case <expr>1</expr> will be returned.</p> - <p> For a downgraded write-lock, this operation will upgrade the -  key into a write-lock if there are no active read locks.</p> - </text><group><throws/><text><p>Throws an error for keys that didn't start out as write-locks.</p> - </text></group><group><returns/><text><p>Returns <expr>1</expr> if the key is now a write-lock, and -  <expr>0</expr> (zero) if it is (still) a read-lock.</p> - </text></group><group><seealso/><text><p><ref resolved='predef::Thread.RWKey.upgrade'>upgrade()</ref>, <ref resolved='predef::Thread.RWKey.downgrade'>downgrade()</ref></p> - </text></group></doc> - <method name='try_upgrade'> - <arguments/> - <returntype><int><min>0</min><max>1</max></int></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.try_upgrade'>try_upgrade()</ref>, <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'> - <arguments><argument name='c'><type><int/></type></argument></arguments> - <returntype><string/></returntype> - </method> - </docgroup> - <docgroup homogen-name='current_locking_keys' homogen-type='method'><doc><text><p>Return an array with the currently active keys -  to the mutex.</p> - </text><group><seealso/><text><p><ref resolved='predef::Thread.RWMutex.current_locking_threads'>current_locking_threads()</ref></p> - </text></group></doc> - <method name='current_locking_keys'> - <arguments/> - <returntype><array><valuetype><object resolved='predef::Thread.Thread'>Thread.Thread</object></valuetype></array></returntype> - </method> - </docgroup> - <docgroup homogen-name='current_locking_threads' homogen-type='method'><doc><text><p>Return an array with the treads that are holding -  keys to the mutex.</p> - </text><group><seealso/><text><p><ref resolved='predef::Thread.RWMutex.current_locking_threads'>current_locking_threads()</ref></p> - </text></group></doc> - <method name='current_locking_threads'> - <arguments/> - <returntype><array><valuetype><object resolved='predef::Thread.Thread'>Thread.Thread</object></valuetype></array></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.try_read_lock'>try_read_lock()</ref>, <ref resolved='predef::Thread.RWMutex.write_lock'>write_lock()</ref></p> - </text></group></doc> - <method name='read_lock'> - <arguments/> - <returntype><object resolved='predef::Thread.RWKey'>RWKey</object></returntype> - </method> - </docgroup> - <docgroup homogen-name='try_read_lock' homogen-type='method'><doc><text><p>Attempt to 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.read_lock'>read_lock()</ref>, <ref resolved='predef::Thread.RWMutex.write_lock'>write_lock()</ref></p> - </text></group></doc> - <method name='try_read_lock'> - <arguments/> - <returntype><object resolved='predef::Thread.RWKey'>RWKey</object></returntype> - </method> - </docgroup> - <docgroup homogen-name='try_write_lock' homogen-type='method'><doc><text><p>Attempt to 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 resolved='predef::Thread.RWMutex.try_read_lock'>try_read_lock()</ref>, <ref resolved='predef::Thread.RWMutex.write_lock'>write_lock()</ref></p> - </text></group></doc> - <method name='try_write_lock'> - <arguments/> - <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 resolved='predef::Thread.RWMutex.try_read_lock'>try_read_lock()</ref>, <ref resolved='predef::Thread.RWMutex.try_write_lock'>try_write_lock()</ref></p> - </text></group></doc> - <method name='write_lock'> - <arguments/> - <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>   </text><group><returns/><text><p>A <ref resolved='predef::Thread.ResourceCountKey'>ResourceCountKey</ref> to decrement the resource-counter again.</p>   </text></group></doc>   <method name='acquire'><modifiers><final/></modifiers>