autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:3286:   <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:23389:   </docgroup>   <docgroup homogen-name='recover' homogen-type='method'><doc><text><p>This specifies a callback that is only called on failure, and    allows you to alter the future into a success.</p>   </text><group><param name='fun'/><text><p>Function to be called. The first argument will be the    <b>failure</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 callbacks returns a regular value (i.e. + </text></group><group><note/><text><p>This method is used if your callbacks return a regular value (i.e.    <b>not</b> a <ref resolved='predef::Concurrent.Future'>Future</ref>).</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.recover_with'>recover_with()</ref>, <ref resolved='predef::Concurrent.Future.map'>map()</ref>, <ref resolved='predef::Concurrent.Future.transform'>transform()</ref></p>   </text></group></doc>   <method name='recover'>   <arguments><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'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='recover_with' homogen-type='method'><doc><text><p>This specifies a callback that is only called on failure, and    allows you to alter the future into a success.</p>   </text><group><param name='fun'/><text><p>Function to be called. The first argument will be the    <b>failure</b> result of <b>this</b> <ref resolved='predef::Concurrent.Future'>Future</ref>.    The return value must be a <ref resolved='predef::Concurrent.Future'>Future</ref> that promises    the new success result.</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 callbacks returns a <ref resolved='predef::Concurrent.Future'>Future</ref> again.</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='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
autodoc.git/onepage.xml:23467:   </method>   </docgroup>   <docgroup homogen-name='timeout' homogen-type='method'><doc><text><p>Return a <ref resolved='predef::Concurrent.Future'>Future</ref> that will either be fulfilled with the fulfilled    result of this <ref resolved='predef::Concurrent.Future'>Future</ref>, or be failed after <ref resolved='predef::Concurrent.Future.timeout.seconds'>seconds</ref> have expired.</p>   </text></doc>   <method name='timeout'>   <arguments><argument name='seconds'><type><or><int/><float/></or></type></argument></arguments>   <returntype><object resolved='predef::Concurrent.Future'>this_program</object></returntype>   </method>   </docgroup> - <docgroup homogen-name='transform' homogen-type='method'><doc><text><p>Return a <ref resolved='predef::Concurrent.Future'>Future</ref> that will be fulfilled with either -  the result of applying <ref resolved='predef::Concurrent.Future.transform.success'>success</ref> with the fulfilled result -  followed by <ref resolved='predef::Concurrent.Future.transform.extra'>extra</ref>, or the result of applying <ref resolved='predef::Concurrent.Future.transform.failure'>failure</ref> -  with the failed result followed by <ref resolved='predef::Concurrent.Future.transform.extra'>extra</ref>.</p> - <p> <ref resolved='predef::Concurrent.Future.transform.failure'>failure</ref> defaults to <ref resolved='predef::Concurrent.Future.transform.success'>success</ref>.</p> - </text><group><note/><text><p>This method is used if your callbacks returns a regular value (i.e. + <docgroup homogen-name='transform' homogen-type='method'><doc><text><p>This specifies callbacks that allows you to alter the future.</p> + </text><group><param name='success'/><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='failure'/><text><p>Function to be called. The first argument will be the +  <b>failure</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>. +  If this callback is omitted, it will default to the same callback as +  <expr>success</expr>.</p> + </text></group><group><param name='extra'/><text><p>Any extra context needed for +  <expr>success</expr> and <expr>failure</expr>. They will be provided +  as arguments two and onwards when the callbacks are 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 regular value (i.e.    <b>not</b> a <ref resolved='predef::Concurrent.Future'>Future</ref>).</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Concurrent.Future.transform_with'>transform_with()</ref>, <ref resolved='predef::Concurrent.Future.map'>map()</ref>, <ref resolved='predef::Concurrent.Future.recover'>recover()</ref></p>   </text></group></doc>   <method name='transform'>   <arguments><argument name='success'><type><function><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><mixed/></returntype></function></type></argument><argument name='failure'><type><or><function><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><mixed/></returntype></function><void/></or></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='transform_with' homogen-type='method'><doc><text><p>Return a <ref resolved='predef::Concurrent.Future'>Future</ref> that will be fulfilled with either -  the fulfilled result of applying <ref resolved='predef::Concurrent.Future.transform_with.success'>success</ref> with the fulfilled result -  followed by <ref resolved='predef::Concurrent.Future.transform_with.extra'>extra</ref>, or the fulfilled result of applying <ref resolved='predef::Concurrent.Future.transform_with.failure'>failure</ref> -  with the failed result followed by <ref resolved='predef::Concurrent.Future.transform_with.extra'>extra</ref>.</p> - <p> <ref resolved='predef::Concurrent.Future.transform_with.failure'>failure</ref> defaults to <ref resolved='predef::Concurrent.Future.transform_with.success'>success</ref>.</p> - </text><group><note/><text><p>This method is used if your callbacks returns a <ref resolved='predef::Concurrent.Future'>Future</ref> again.</p> + <docgroup homogen-name='transform_with' homogen-type='method'><doc><text><p>This specifies callbacks that allows you to alter the future.</p> + </text><group><param name='success'/><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 must be a <ref resolved='predef::Concurrent.Future'>Future</ref> that promises +  the new result.</p> + </text></group><group><param name='failure'/><text><p>Function to be called. The first argument will be the +  <b>failure</b> result of <b>this</b> <ref resolved='predef::Concurrent.Future'>Future</ref>. +  The return value must be a <ref resolved='predef::Concurrent.Future'>Future</ref> that promises +  the new success result. +  If this callback is omitted, it will default to the same callback as +  <expr>success</expr>.</p> + </text></group><group><param name='extra'/><text><p>Any extra context needed for +  <expr>success</expr> and <expr>failure</expr>. They will be provided +  as arguments two and onwards when the callbacks are 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.transform'>transform()</ref>, <ref resolved='predef::Concurrent.Future.map_with'>map_with()</ref>, <ref resolved='predef::Concurrent.Future.recover_with'>recover_with</ref></p>   </text></group></doc>   <method name='transform_with'>   <arguments><argument name='success'><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='failure'><type><or><function><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><object resolved='predef::Concurrent.Future'>this_program</object></returntype></function><void/></or></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='zip' homogen-type='method'><doc><group><param name='others'/><text><p>The other futures (results) you want to append.</p>   </text></group><group><returns/><text><p>A new <ref resolved='predef::Concurrent.Future'>Future</ref> that will be fulfilled with an    array of the fulfilled result of this object followed