autodoc.git
/
modref.xml
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/modref.xml:1107:
</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='
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/modref.xml:1724:
<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/modref.xml:1891:
<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:143508:
</text></group></doc> <method name='ping'> <arguments/> <returntype><int/></returntype> </method> </docgroup> <docgroup homogen-name='promise_query' homogen-type='method'><doc><text><p>Sends a typed query to the database asynchronously.</p> </text><group><returns/><text><p>An <ref resolved='predef::Sql.Promise'>Sql.Promise</ref> object which can be used to obtain an <ref resolved='predef::Sql.FutureResult'>Sql.FutureResult</ref> object to evaluate the query.</p> </text></group><group><seealso/><text><p><ref resolved='predef::__builtin.Sql.Connection.big_typed_query'>big_typed_query()</ref>, <ref resolved='predef::Sql.Promise'>Sql.Promise</ref>, <ref resolved='predef::Sql.FutureResult'>Sql.FutureResult</ref></p>
+
</text></group><group><param name='map_cb'/><text><p>Callback function which is called for every row returned.
+
First parameter is the row, second parameter is the result object
+
being processed, and the third parameter is the array of result rows
+
already collected so far. The function should return the modified
+
version of the row that needs to be stored, or it should return
+
<expr>0</expr> to discard the row.</p>
</text></group><group><example/><text><code><text><p>Sql.Connection db = Sql.Connection("..."); Sql.Promise q1 = db->promise_query("SELECT 42")->max_records(10); Sql.Promise q2 = db->promise_query("SELECT :foo::INT", (["foo":2]));</p> <p> array(Concurrent.Future) all = ({ q1, q2 })->future();</p> <p> // To get a callback for each of the requests</p> <p> all->on_success(lambda (Sql.FutureResult resp) { werror("Got result %O from %O\n", resp->get(), resp->query); }); all->on_failure(lambda (Sql.FutureResult resp) { werror("Request %O failed: %O\n", resp->query,
autodoc.git/modref.xml:143532:
<p> Concurrent.Future all2 = Concurrent.results(all);</p> <p> all2->on_success(lambda (array(Sql.FutureResult) resp) { werror("All requests were successful: %O\n", resp); }); all->on_failure(lambda (Sql.FutureResult resp) { werror("Requests %O failed with %O.\n", resp->query, resp->status_command_complete); });</p> </text></code> </text></group></doc>
-
<method name='promise_query'><modifiers><public/></modifiers>
-
<arguments><argument name='q'><type><string/></type></argument><argument name='bindings'><type><or><void/><mapping><indextype><or><string/><int/></or></indextype><valuetype><mixed/></valuetype></mapping></or></type></argument></arguments>
+
<method name='promise_query'><modifiers><public/><
variant
/
></
modifiers>
+
<arguments><argument name='q'><type><string/></type></argument><argument name='bindings'><type><or><void/><mapping><indextype><or><string/><int/></or></indextype><valuetype><mixed/></valuetype></mapping></or></type></argument><
argument name='map_cb'><type><or><void
/
><function><argtype><array/></argtype><argtype><object resolved='predef::__builtin.Sql.Result'>.Result</object></argtype><argtype><array/></argtype><returntype><array/></returntype></function></or></type></argument></
arguments>
<returntype><object resolved='predef::__builtin.Sql.Promise'>.Promise</object></returntype> </method>
-
+
<method name='promise_query'><modifiers><public/><variant/></modifiers>
+
<arguments><argument name='q'><type><string/></type></argument><argument name='map_cb'><type><function><argtype><array/></argtype><argtype><object resolved='predef::__builtin.Sql.Result'>.Result</object></argtype><argtype><array/></argtype><returntype><array/></returntype></function></type></argument></arguments>
+
<returntype><object resolved='predef::__builtin.Sql.Promise'>.Promise</object></returntype>
+
</method>
</docgroup> <docgroup homogen-name='query' homogen-type='method'><doc><text><p>Send an SQL query synchronously to the SQL-server and return the results in untyped mode.</p> <p> For the arguments, please see the <ref resolved='predef::__builtin.Sql.Connection.big_query'>big_query()</ref> function.</p> </text><group><returns/><text><p>Returns one of the following on success:</p> <mixed><group><type><array><valuetype><mapping><indextype><string/></indextype><valuetype><string/></valuetype></mapping></valuetype></array></type><text><p>The result as an array of mappings indexed on the name of the columns. The values are either strings with the display representations or zero for the SQL NULL value.</p> </text></group><group><type><zero/></type><text><p>The value <expr>0</expr> (zero) if the query didn't return any result (eg <tt>INSERT</tt> or similar).</p>