autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2018-01-12' version='Pike v8.0.529'> + <manual time-stamp='2018-01-18' version='Pike v8.0.533'>    <dir name='./onepage'>    <file name='./onepage/manual.html'>    <chapter number='1' title='Control Structures'>      <p>In this chapter all the control structures in Pike will be   explained. Control structures are used to control the flow of the   program execution. Note that functions that make the program pause and   simple function calls are not qualified as control structures.</p>      <section number='1' title='Conditions'>
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='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:4662:   <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/onepage.xml:9986:    in them.</p>   </text></group></dl>   </text><group><note/><text><p>The function is never destructive on <ref resolved='predef::filter.arr'>arr</ref>.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::map'>map()</ref>, <ref>foreach()</ref></p>   </text></group></doc>   <method name='filter'>   <arguments><argument name='arr'><type><mixed/></type></argument><argument name='fun'><type><or><void/><mixed/></or></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   </docgroup> + <docgroup homogen-name='find_all_clones' homogen-type='method'><doc><text><p>Return an array with all objects that are clones of <ref resolved='predef::find_all_clones.p'>p</ref>.</p> + </text><group><param name='p'/><text><p>Program that the objects should be a clone of.</p> + </text></group><group><param name='include_subclasses'/><text><p>If true, include also objects that are clones of programs +  that have inherited <ref resolved='predef::find_all_clones.p'>p</ref>. Note that this adds significant +  overhead.</p> + <p> This function is only intended to be used for debug purposes.</p> + </text></group><group><seealso/><text><p><ref>map_all_objects()</ref></p> + </text></group></doc> + <method name='find_all_clones'> + <arguments><argument name='p'><type><program/></type></argument><argument name='include_subclasses'><type><or><int><min>0</min><max>1</max></int><void/></or></type></argument></arguments> + <returntype><array><valuetype><object resolved='predef::find_all_clones'/></valuetype></array></returntype> + </method> + </docgroup>   <docgroup homogen-name='floatp' homogen-type='method'><doc><text><p>Returns <expr>1</expr> if <ref resolved='predef::floatp.arg'>arg</ref> is a float, <expr>0</expr> (zero) otherwise.</p>   </text><group><seealso/><text><p><ref resolved='predef::intp'>intp()</ref>, <ref resolved='predef::programp'>programp()</ref>, <ref resolved='predef::arrayp'>arrayp()</ref>, <ref resolved='predef::multisetp'>multisetp()</ref>, <ref resolved='predef::objectp'>objectp()</ref>,    <ref resolved='predef::mappingp'>mappingp()</ref>, <ref resolved='predef::stringp'>stringp()</ref>, <ref resolved='predef::functionp'>functionp()</ref></p>   </text></group></doc>   <method name='floatp'>   <arguments><argument name='arg'><type><mixed/></type></argument></arguments>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='floor' homogen-type='method'><doc><text><p>Return the closest integer value less or equal to <ref resolved='predef::floor.f'>f</ref>.</p>
autodoc.git/onepage.xml:25271:   <arguments><argument name='o'><type><or><string/><array/><mapping/><multiset/><function/><object resolved='predef::Debug.locate_references'/><program/><type><mixed/></type></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='map_all_objects' homogen-type='method'><doc><text><p>Call cb for all objects that currently exist. The callback will    not be called with destructed objects as it's argument.</p>   <p> Objects might be missed if <ref resolved='predef::Debug.map_all_objects.cb'>cb</ref> creates new objects or destroys    old ones.</p>   <p> This function is only intended to be used for debug purposes.</p>   </text><group><returns/><text><p>The total number of objects</p> - </text></group><group><seealso/><text><p><ref resolved='predef::next_object'>next_object()</ref></p> + </text></group><group><seealso/><text><p><ref resolved='predef::next_object'>next_object()</ref>, <ref resolved='predef::find_all_clones'>find_all_clones()</ref></p>   </text></group></doc>   <method name='map_all_objects'>   <arguments><argument name='cb'><type><function><argtype><object resolved='predef::Debug.map_all_objects'/></argtype><returntype><void/></returntype></function></type></argument></arguments>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='memory_usage' homogen-type='method'><doc><text><p>Check memory usage.</p>   <p> This function is mostly intended for debugging. It delivers a mapping    with information about how many arrays/mappings/strings etc. there    are currently allocated and how much memory they use.</p>