autodoc.git / modref.xml

autodoc.git/modref.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2020-04-27' version='Pike v8.1.13'> + <manual time-stamp='2020-04-28' version='Pike v8.1.13'>    <dir name='./ignored'>    <file name='./ignored/ignored'>    <chapter number='1' title='ignored'>    <autodoc>   <namespace name=''>   <doc><text><p>Symbols implicitly inherited from the virtual base class.</p>   <p> These symbols exist mainly to simplify implementation of    the corresponding lfuns.</p>   </text><group><seealso/><text><p><ref resolved='lfun::'>lfun::</ref></p>   </text></group></doc>
autodoc.git/modref.xml:1126:   </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:1910:   <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:131728:    and IPPROTO_IPV6 IPV6_LEAVE_GROUP.</p>   </text></group><group><note/><text><p>The <ref resolved='predef::Stdio.UDP.drop_membership.address'>address</ref> parameter is currently not supported for IPv6.</p>   </text></group><group><note/><text><p>This function did not support IPv6 in Pike 7.8 and earlier.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.UDP.add_membership'>add_membership()</ref></p>   </text></group></doc>   <method name='drop_membership'>   <arguments><argument name='group'><type><string/></type></argument><argument name='address'><type><or><void/><string/></or></type></argument></arguments>   <returntype><int/></returntype>   </method>   </docgroup> + <docgroup homogen-name='dup' homogen-type='method'><doc><text><p>Duplicate the udp socket.</p> + </text><group><seealso/><text><p><ref resolved='predef::Stdio.UDP.fd_factory'>fd_factory()</ref></p> + </text></group></doc> + <method name='dup'> + <arguments/> + <returntype><object resolved='predef::Stdio.UDP'>Stdio.UDP</object></returntype> + </method> + </docgroup>   <docgroup homogen-name='enable_broadcast' homogen-type='method'><doc><text><p>Set the broadcast flag.    If enabled then sockets receive packets sent to a broadcast    address and they are allowed to send packets to a    broadcast address.</p>   </text><group><returns/><text><p>Returns <expr>1</expr> on success, <expr>0</expr> (zero) otherwise.</p>   </text></group><group><note/><text><p>This is normally only avalable to root users.</p>   </text></group></doc>   <method name='enable_broadcast'>   <arguments/>   <returntype><int><min>0</min><max>1</max></int></returntype>
autodoc.git/modref.xml:131759:   </method>   </docgroup>   <docgroup homogen-name='errno' homogen-type='method'><doc><text><p>Returns the error code for the last command on this object.    Error code is normally cleared when a command is successful.</p>   </text></doc>   <method name='errno'>   <arguments/>   <returntype><int/></returntype>   </method>   </docgroup> + <docgroup homogen-name='fd_factory' homogen-type='method'><doc><text><p>Factory creating <ref resolved='predef::Stdio.UDP'>Stdio.UDP</ref> objects.</p> + <p> This function is called by <ref resolved='predef::Stdio.UDP.dup'>dup()</ref> +  and other functions creating new UDP objects.</p> + <p> The default implementation calls <expr>object_program(this_object())()</expr> +  to create the new object, and returns the <ref resolved='predef::Stdio.UDP'>UDP</ref> inherit in it.</p> + </text><group><note/><text><p>Note that this function must return the <ref resolved='predef::Stdio.UDP'>UDP</ref> inherit in the object.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.UDP.dup'>dup()</ref>, <ref resolved='predef::Stdio.Fd.fd_factory'>Stdio.File()-&gt;fd_factory()</ref></p> + </text></group></doc> + <method name='fd_factory'> + <arguments/> + <returntype><object resolved='predef::Stdio.UDP'>UDP</object></returntype> + </method> + </docgroup>   <docgroup homogen-name='get_type' homogen-type='method'><doc><text><p>Returns socket type and protocol family.</p>   </text></doc>   <method name='get_type'>   <arguments/>   <returntype><array><valuetype><int/></valuetype></array></returntype>   </method>   </docgroup>   <docgroup homogen-name='UDP' homogen-type='inherit'>   <inherit name='UDP'><classname>_Stdio.UDP</classname></inherit>   </docgroup>