autodoc.git / autodoc.xml

autodoc.git/autodoc.xml:1720:   <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/autodoc.xml:1887:   <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='predef::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='7.8::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/autodoc.xml:24990:   </text></doc>   <method name='get_prof_info'>   <arguments><argument name='include'><type><or><string/><array><valuetype><string/></valuetype></array><void/></or></type></argument><argument name='exclude'><type><or><string/><array><valuetype><string/></valuetype></array><void/></or></type></argument></arguments>   <returntype><array><valuetype><array><valuetype><or><string/><float/><int/></or></valuetype></array></valuetype></array></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   </module> - <module name='Rapidlog'> + <class name='Rapidlog'>   <doc><text><p>Allows for rapid collection of logdata, which is then fed to the    real werror() at idle moments.    This allows for logging to occur with minimal timing interference.</p>   </text></doc>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='werror' homogen-type='method'><doc><text><p>Overloads the <ref resolved='predef::werror'>predef::werror()</ref> function    to allow floods of logentries while introducing minimal latency.    Logs are buffered, and periodically flushed from another thread.
autodoc.git/autodoc.xml:25028:   </text></group><group><param name='maxbufentries'/><text><p>Maximum number of buffered logrecords which have not been flushed to stderr    yet. If this number is exceeded, the oldest <expr>maxbufentries/2</expr> entries    will be skipped; a notice to that effect is logged to stderr.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Debug.Rapidlog.werror'>werror()</ref></p>   </text></group></doc>   <method name='werror_options'>   <arguments><argument name='options'><type><int/></type></argument><argument name='pollinterval'><type><or><void/><int/></or></type></argument><argument name='drainrate'><type><or><void/><int/></or></type></argument><argument name='maxbufentries'><type><or><void/><int/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup> - </module> + </class>   <class name='Subject'>   <doc><text><p>This is a probe subject which you can send in somewhere to    get probed (not to be confused with a probe object, which    does some active probing). All calls to LFUNs will be printed    to stderr. It is possible to name the subject by passing a    string as the first and only argument when creating the subject    object.</p>   </text><group><example/><text><p>&gt; object s = Debug.Subject();    create()    &gt; random(s);
autodoc.git/autodoc.xml:118588:   <string><group><value>idle</value><value>intransaction</value><value>infailedtransaction</value></group></string>   </text></group><group><note/><text><p>This function is PostgreSQL-specific.</p>   </text></group></doc>   <method name='status_commit'><modifiers><final/></modifiers>   <arguments/>   <returntype><string/></returntype>   </method>   </docgroup>   <docgroup homogen-name='streaming_query' homogen-type='method'><doc><text><p>This is an alias for <ref resolved='predef::Sql.pgsql.big_query'>big_query()</ref>, since <ref resolved='predef::Sql.pgsql.big_query'>big_query()</ref> already supports    streaming of multiple simultaneous queries through the same connection.</p> - </text><group><seealso/><text><p><ref resolved='predef::Sql.pgsql.big_query'>big_query()</ref>, <ref resolved='predef::Sql.pgsql.big_typed_query'>big_typed_query()</ref>, <ref resolved='predef::Sql.Connection'>Sql.Connection</ref>, <ref resolved='predef::Sql.Result'>Sql.Result</ref></p> + </text><group><seealso/><text><p><ref resolved='predef::Sql.pgsql.big_query'>big_query()</ref>, <ref resolved='predef::Sql.pgsql.big_typed_query'>big_typed_query()</ref>, <ref resolved='predef::Sql.pgsql.streaming_typed_query'>streaming_typed_query()</ref>, +  <ref resolved='predef::Sql.Connection'>Sql.Connection</ref>, <ref resolved='predef::Sql.Result'>Sql.Result</ref></p>   </text></group></doc>   <method name='streaming_query'><modifiers><final/><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></arguments>   <returntype><object resolved='predef::Sql.pgsql_util.Result'>.pgsql_util.Result</object></returntype>   </method>   </docgroup> -  + <docgroup homogen-name='streaming_typed_query' homogen-type='method'><doc><text><p>This function returns an object that allows streaming and typed +  results.</p> + </text><group><seealso/><text><p><ref resolved='predef::Sql.pgsql.big_query'>big_query()</ref>, <ref resolved='predef::Sql.Connection'>Sql.Connection</ref>, <ref resolved='predef::Sql.Result'>Sql.Result</ref></p> + </text></group></doc> + <method name='streaming_typed_query'><modifiers><final/><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></arguments> + <returntype><object resolved='predef::Sql.pgsql_util.Result'>.pgsql_util.Result</object></returntype> + </method> + </docgroup>   </class>   <module name='pgsql_util'>   <doc><text><p>The pgsql backend, shared between all connection instances.    It runs even in non-callback mode in a separate thread and makes sure    that communication with the database is real-time and event driven    at all times.</p>   </text><group><note/><text><p>Callbacks running from this backend directly determine the latency    in reacting to communication with the database server; so it    would be prudent not to block in these callbacks.</p>   </text></group></doc>