autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:3878:   </docgroup>   </class>   <class name='DES3'>   <docgroup homogen-name='CBC' homogen-type='inherit'>   <inherit name='CBC'><classname resolved='predef::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='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> +  <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>   </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:4495:   <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='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='7.8::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/onepage.xml:22444:   <p> The lock is released when the object is destructed.</p>   </text></doc>   </class>   </class>   <module name='Concurrent'>   <doc><text><p>Module for handling multiple concurrent events.</p>   <p> The <ref resolved='predef::Concurrent.Future'>Future</ref> and <ref resolved='predef::Concurrent.Promise'>Promise</ref> API was inspired by    <url>https://github.com/couchdeveloper/FutureLib</url>.</p>   </text></doc>   <docgroup homogen-name='all' homogen-type='method'><doc><text><p>JavaScript Promise API equivalent of <ref resolved='predef::Concurrent.results'>results()</ref>.</p> - </text><group><seealso/><text><p><ref resolved='predef::Concurrent.results'>results()</ref>, <ref resolved='predef::Concurrent.Promise.depend'>Promise.depend()</ref> + </text><group><note/><text><p>The returned <ref resolved='predef::Concurrent.Future'>Future</ref> does NOT have any state (eg backend) +  propagated from the <ref resolved='predef::Concurrent.all.futures'>futures</ref>. This must be done by hand.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.results'>results()</ref>, <ref resolved='predef::Concurrent.Promise.depend'>Promise.depend()</ref>    <url>https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise</url></p>   </text></group></doc>   <method name='all'><modifiers><local/><variant/></modifiers>   <arguments><argument name='futures'><type><array><valuetype><object resolved='predef::Concurrent.Future'>Future</object></valuetype></array></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>   <method name='all'><modifiers><local/><variant/></modifiers>   <arguments><argument name='futures'><type><varargs><object resolved='predef::Concurrent.Future'>Future</object></varargs></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='first_completed' homogen-type='method'><doc><group><returns/><text><p>A <ref resolved='predef::Concurrent.Future'>Future</ref> that represents the first    of the <expr>futures</expr> that completes.</p> -  + </text></group><group><note/><text><p>The returned <ref resolved='predef::Concurrent.Future'>Future</ref> does NOT have any state (eg backend) +  propagated from the <ref resolved='predef::Concurrent.first_completed.futures'>futures</ref>. This must be done by hand.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.race'>race()</ref>, <ref resolved='predef::Concurrent.Promise.first_completed'>Promise.first_completed()</ref></p>   </text></group></doc>   <method name='first_completed'><modifiers><variant/></modifiers>   <arguments><argument name='futures'><type><array><valuetype><object resolved='predef::Concurrent.Future'>Future</object></valuetype></array></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>   <method name='first_completed'><modifiers><variant/><local/></modifiers>   <arguments><argument name='futures'><type><varargs><object resolved='predef::Concurrent.Future'>Future</object></varargs></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>
autodoc.git/onepage.xml:22480:    applying <ref resolved='predef::Concurrent.fold.fun'>fun</ref> to the results of the <ref resolved='predef::Concurrent.fold.futures'>futures</ref> in turn.</p>   </text><group><param name='initial'/><text><p>Initial value of the accumulator.</p>   </text></group><group><param name='fun'/><text><p>Function to apply. The first argument is the result of    one of the <ref resolved='predef::Concurrent.fold.futures'>futures</ref>, the second the current accumulated    value, and any further from <ref resolved='predef::Concurrent.fold.extra'>extra</ref>.</p>   </text></group><group><note/><text><p>If <ref resolved='predef::Concurrent.fold.fun'>fun</ref> throws an error it will fail the <ref resolved='predef::Concurrent.Future'>Future</ref>.</p>   </text></group><group><note/><text><p><ref resolved='predef::Concurrent.fold.fun'>fun</ref> may be called in any order, and will be called    once for every <ref resolved='predef::Concurrent.Future'>Future</ref> in <ref resolved='predef::Concurrent.fold.futures'>futures</ref>, unless one of    calls fails in which case no further calls will be    performed.</p> + </text></group><group><note/><text><p>The returned <ref resolved='predef::Concurrent.Future'>Future</ref> does NOT have any state (eg backend) +  propagated from the <ref resolved='predef::Concurrent.fold.futures'>futures</ref>. This must be done by hand.</p>   </text></group></doc>   <method name='fold'>   <arguments><argument name='futures'><type><array><valuetype><object resolved='predef::Concurrent.Future'>Future</object></valuetype></array></type></argument><argument name='initial'><type><mixed/></type></argument><argument name='fun'><type><function><argtype><mixed/></argtype><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><mixed/></returntype></function></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>   </docgroup>   <docgroup><doc><text><p>Global failure callback, called when a promise without failure    callback fails. This is useful to log exceptions, so they are not    just silently caught and ignored.</p>   </text></doc>   <method name='on_failure'>   <arguments><argument name='f'><type><function><argtype><mixed/></argtype><returntype><void/></returntype></function></type></argument></arguments>   <returntype><void/></returntype>   </method>   <variable name='global_on_failure'><modifiers><protected/></modifiers><type><function><argtype><mixed/></argtype><returntype><void/></returntype></function></type></variable>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='race' homogen-type='method'><doc><text><p>JavaScript Promise API equivalent of <ref resolved='predef::Concurrent.first_completed'>first_completed()</ref>.</p> - </text><group><seealso/><text><p><ref resolved='predef::Concurrent.first_completed'>first_completed()</ref>, <ref resolved='predef::Concurrent.Promise.first_completed'>Promise.first_completed()</ref> + </text><group><note/><text><p>The returned <ref resolved='predef::Concurrent.Future'>Future</ref> does NOT have any state (eg backend) +  propagated from the <ref resolved='predef::Concurrent.race.futures'>futures</ref>. This must be done by hand.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.first_completed'>first_completed()</ref>, <ref resolved='predef::Concurrent.Promise.first_completed'>Promise.first_completed()</ref>    <url>https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise</url></p>   </text></group></doc>   <method name='race'><modifiers><variant/><local/></modifiers>   <arguments><argument name='futures'><type><array><valuetype><object resolved='predef::Concurrent.Future'>Future</object></valuetype></array></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>   <method name='race'><modifiers><variant/><local/></modifiers>   <arguments><argument name='futures'><type><varargs><object resolved='predef::Concurrent.Future'>Future</object></varargs></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='reject' homogen-type='method'><doc><group><returns/><text><p>A new <ref resolved='predef::Concurrent.Future'>Future</ref> that has already failed for the specified <expr>reason</expr>.</p> -  + </text></group><group><note/><text><p>The returned <ref resolved='predef::Concurrent.Future'>Future</ref> does NOT have a backend set.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.on_failure'>Future.on_failure()</ref>, <ref resolved='predef::Concurrent.Promise.failure'>Promise.failure()</ref>    <url>https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise</url></p>   </text></group></doc>   <method name='reject'>   <arguments><argument name='reason'><type><mixed/></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='resolve' homogen-type='method'><doc><group><returns/><text><p>A new <ref resolved='predef::Concurrent.Future'>Future</ref> that has already been fulfilled with <expr>value</expr>    as result. If <expr>value</expr> is an object which already    has <ref resolved='predef::Concurrent.on_failure'>on_failure</ref> and <ref>on_success</ref> methods, return it unchanged.</p>   </text></group><group><note/><text><p>This function can be used to ensure values are futures.</p> -  + </text></group><group><note/><text><p>The returned <ref resolved='predef::Concurrent.Future'>Future</ref> does NOT have a backend set.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.on_success'>Future.on_success()</ref>, <ref resolved='predef::Concurrent.Promise.success'>Promise.success()</ref>    <url>https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise</url></p>   </text></group></doc>   <method name='resolve'>   <arguments><argument name='value'><type><mixed/></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='results' homogen-type='method'><doc><group><returns/><text><p>A <ref resolved='predef::Concurrent.Future'>Future</ref> that represents the array of all the completed <expr>futures</expr>.</p> -  + </text></group><group><note/><text><p>The returned <ref resolved='predef::Concurrent.Future'>Future</ref> does NOT have any state (eg backend) +  propagated from the <ref resolved='predef::Concurrent.results.futures'>futures</ref>. This must be done by hand.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.all'>all()</ref>, <ref resolved='predef::Concurrent.Promise.depend'>Promise.depend()</ref></p>   </text></group></doc>   <method name='results'><modifiers><variant/></modifiers>   <arguments><argument name='futures'><type><array><valuetype><object resolved='predef::Concurrent.Future'>Future</object></valuetype></array></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>   <method name='results'><modifiers><local/><variant/></modifiers>   <arguments><argument name='futures'><type><varargs><object resolved='predef::Concurrent.Future'>Future</object></varargs></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='traverse' homogen-type='method'><doc><text><p>Return a <ref resolved='predef::Concurrent.Future'>Future</ref> that represents the array of mapping <ref resolved='predef::Concurrent.traverse.fun'>fun</ref>    over the results of the completed <ref resolved='predef::Concurrent.traverse.futures'>futures</ref>.</p> - </text></doc> + </text><group><note/><text><p>The returned <ref resolved='predef::Concurrent.Future'>Future</ref> does NOT have any state (eg backend) +  propagated from the <ref resolved='predef::Concurrent.traverse.futures'>futures</ref>. This must be done by hand.</p> + </text></group></doc>   <method name='traverse'>   <arguments><argument name='futures'><type><array><valuetype><object resolved='predef::Concurrent.Future'>Future</object></valuetype></array></type></argument><argument name='fun'><type><function><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><mixed/></returntype></function></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='use_backend' homogen-type='method'><doc><group><param name='enable'/><text><int><group><value>0</value><text><p>A <expr>false</expr> value causes all <ref resolved='predef::Concurrent'>Concurrent</ref> callbacks    (except for timeouts) to default to being called directly,    without using a backend.</p>   </text></group><group><value>1</value><text><p>A <expr>true</expr> value causes callbacks to default to being    called via <ref resolved='predef::Pike.DefaultBackend'>Pike.DefaultBackend</ref>.</p>