autodoc.git / onepage.xml

version» Context lines:

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:3305:   <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/onepage.xml:23747:   </method>   </docgroup>   <docgroup homogen-name='use_backend' homogen-type='method'><doc><group><param name='enable'/><text><p>Setting this to <expr>false</expr> causes all <ref resolved='predef::Concurrent'>Concurrent</ref> callbacks    (except for timeouts)    to be called directly, without using a backend.</p>   </text></group><group><note/><text><p>As long as the backend hasn't started, it will default to <expr>false</expr>.    Upon startup of the backend, it will change to <expr>true</expr> unless you    explicitly called <ref resolved='predef::Concurrent.use_backend'>use_backend()</ref> before that.</p>   </text></group><group><note/><text><p>(Un)setting this typically alters the order in which some callbacks    are called (depending on what happens in a callback).</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.set_backend'>Future()-&gt;set_backend()</ref>, <ref resolved='predef::Concurrent.Future.call_callback'>Future()-&gt;call_callback()</ref></p>   </text></group></doc>   <method name='use_backend'><modifiers><final/></modifiers>   <arguments><argument name='enable'><type><int/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <class name='Future'>   <doc><text><p>Value that will be provided asynchronously    sometime in the future.</p>   </text><group><seealso/><text><p><ref resolved='predef::Concurrent.Promise'>Promise</ref></p>
autodoc.git/onepage.xml:23794:    and update <ref resolved='predef::Concurrent.Future.apply_smart.p'>p</ref> with the eventual result.</p>   </text></doc>   <method name='apply_smart'><modifiers><protected/></modifiers>   <arguments><argument name='val'><type><mixed/></type></argument><argument name='p'><type><object resolved='predef::Concurrent.Promise'>Promise</object></type></argument><argument name='fun'><type><function><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><or><mixed/><object resolved='predef::Concurrent.Future'>Future</object></or></returntype></function></type></argument><argument name='ctx'><type><array><valuetype><mixed/></valuetype></array></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='call_callback' homogen-type='method'><doc><text><p>Call a callback function.</p>   </text><group><param name='cb'/><text><p>Callback function to call.</p>   </text></group><group><param name='args'/><text><p>Arguments to call <ref resolved='predef::Concurrent.Future.call_callback.cb'>cb</ref> with.</p> + <p> The default implementation calls <ref resolved='predef::Concurrent.Future.call_callback.cb'>cb</ref> via the +  backend set via <ref resolved='predef::Concurrent.Future.set_backend'>set_backend()</ref> (if any), and +  otherwise falls back the the mode set by +  <ref resolved='predef::Concurrent.use_backend'>use_backend()</ref>.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.set_backend'>set_backend()</ref>, <ref resolved='predef::Concurrent.use_backend'>use_backend()</ref></p>   </text></group></doc>   <method name='call_callback'><modifiers><protected/></modifiers>   <arguments><argument name='cb'><type><function/></type></argument><argument name='args'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='filter' homogen-type='method'><doc><text><p>This specifies a callback that is only called on success, and    allows you to selectively alter the future into a failure.</p>   </text><group><param name='fun'/><text><p>Function to be called. The first argument will be the    <b>success</b> result of <b>this</b> <ref resolved='predef::Concurrent.Future'>Future</ref>.
autodoc.git/onepage.xml:23835:   </method>   </docgroup>   <docgroup homogen-name='get' homogen-type='method'><doc><text><p>Wait for fulfillment and return the value.</p>   </text><group><throws/><text><p>Throws on rejection.</p>   </text></group></doc>   <method name='get'>   <arguments/>   <returntype><mixed/></returntype>   </method>   </docgroup> + <docgroup homogen-name='get_backend' homogen-type='method'><doc><text><p>Get the backend (if any) used to call any callbacks.</p> + <p> This returns the value set by <ref resolved='predef::Concurrent.Future.set_backend'>set_backend()</ref>.</p> + </text><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.set_backend'>set_backend()</ref></p> + </text></group></doc> + <method name='get_backend'> + <arguments/> + <returntype><object resolved='predef::Pike.Backend'>Pike.Backend</object></returntype> + </method> + </docgroup>   <docgroup homogen-name='map' homogen-type='method'><doc><text><p>This specifies a callback that is only called on success, and    allows you to alter the future.</p>   </text><group><param name='fun'/><text><p>Function to be called. The first argument will be the    <b>success</b> result of <b>this</b> <ref resolved='predef::Concurrent.Future'>Future</ref>.    The return value will be the success result of the new <ref resolved='predef::Concurrent.Future'>Future</ref>.</p>   </text></group><group><param name='extra'/><text><p>Any extra context needed for    <expr>fun</expr>. They will be provided    as arguments two and onwards when the callback is called.</p>   </text></group><group><returns/><text><p>The new <ref resolved='predef::Concurrent.Future'>Future</ref>.</p>   </text></group><group><note/><text><p>This method is used if your <ref resolved='predef::Concurrent.Future.map.fun'>fun</ref> returns a regular value (i.e.
autodoc.git/onepage.xml:23933:    as arguments two and onwards when the callback is called.</p>   </text></group><group><returns/><text><p>The new <ref resolved='predef::Concurrent.Future'>Future</ref>.</p>   </text></group><group><note/><text><p>This method is used if your callbacks return a <ref resolved='predef::Concurrent.Future'>Future</ref> again.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.recover'>recover()</ref>, <ref resolved='predef::Concurrent.Future.map_with'>map_with()</ref>, <ref resolved='predef::Concurrent.Future.transform_with'>transform_with()</ref></p>   </text></group></doc>   <method name='recover_with'>   <arguments><argument name='fun'><type><function><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><object resolved='predef::Concurrent.Future'>this_program</object></returntype></function></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>this_program</object></returntype>   </method>   </docgroup> + <docgroup homogen-name='set_backend' homogen-type='method'><doc><text><p>Set the backend to use for calling any callbacks.</p> + </text><group><note/><text><p>This overides the mode set by <ref resolved='predef::Concurrent.use_backend'>use_backend()</ref>.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.get_backend'>get_backend()</ref>, <ref resolved='predef::Concurrent.use_backend'>use_backend()</ref></p> + </text></group></doc> + <method name='set_backend'> + <arguments><argument name='backend'><type><object resolved='predef::Pike.Backend'>Pike.Backend</object></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup>   <docgroup homogen-name='then' homogen-type='method'><doc><text><p>JavaScript Promise API close but not identical equivalent    of a combined <ref resolved='predef::Concurrent.Future.transform'>transform()</ref> and <ref resolved='predef::Concurrent.Future.transform_with'>transform_with()</ref>.</p>   </text><group><param name='onfulfilled'/><text><p>Function to be called on fulfillment. The first argument will be the    result of <b>this</b> <ref resolved='predef::Concurrent.Future'>Future</ref>.    The return value will be the result of the new <ref resolved='predef::Concurrent.Future'>Future</ref>.    If the return value already is a <ref resolved='predef::Concurrent.Future'>Future</ref>, pass it as-is.</p>   </text></group><group><param name='onrejected'/><text><p>Function to be called on failure. The first argument will be the    failure result of <b>this</b> <ref resolved='predef::Concurrent.Future'>Future</ref>.    The return value will be the failure result of the new <ref resolved='predef::Concurrent.Future'>Future</ref>.    If the return value already is a <ref resolved='predef::Concurrent.Future'>Future</ref>, pass it as-is.</p>