autodoc.git / autodoc.xml

version» Context lines:

autodoc.git/autodoc.xml:1122:   </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/autodoc.xml:1739:   <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:1906:   <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/autodoc.xml:22106:   </docgroup>   <docgroup homogen-name='get_default_module' homogen-type='method'><doc><text><p>Get the default module for the current compatibility level    (ie typically the value returned by <ref resolved='predef::all_constants'>predef::all_constants()</ref>).</p>   <p> The default implementation calls the corresponding function    in the master object.</p>   </text><group><returns/><text><mixed><group><type><or><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping><object resolved='predef::CompilerEnvironment.get_default_module'/></or></type><text><p>Constant table to use.</p>   </text></group><group><type><int><min>0</min><max>0</max></int></type><text><p>Use the builtin constant table.</p>   </text></group></mixed>   </text></group><group><note/><text><p>This function is typically called by    <ref>Pike_compiler()-&gt;get_default_module()</ref>.</p> - </text></group><group><seealso/><text><p><ref resolved='predef::MasterObject.CompatResolver.get_default_module'>MasterObject()-&gt;get_default_module()</ref>.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::CompilationHandler.get_default_module'>MasterObject()-&gt;get_default_module()</ref>.</p>   </text></group></doc>   <method name='get_default_module'>   <arguments/>   <returntype><or><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping><object resolved='predef::CompilerEnvironment.get_default_module'/></or></returntype>   </method>   </docgroup>   <docgroup homogen-name='handle_import' homogen-type='method'><doc><text><p>Look up an import <ref resolved='predef::CompilerEnvironment.handle_import.module'>module</ref>.</p>   <p> The default implementation calls the corresponding function    in the master object.</p>   </text><group><seealso/><text><p><ref resolved='predef::CompilationHandler.handle_import'>MasterObject()-&gt;handle_import()</ref>.</p>
autodoc.git/autodoc.xml:26086:   <method name='create'>   <arguments><argument name='card_number'><type><int/></type></argument></arguments>   <returntype><void/></returntype>   </method>   <method name='create'>   <arguments/>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='mixer' homogen-type='method'><doc><text><p>Sets output level on DVB audio device.</p> - </text></doc> + </text><group><seealso/><text><p><ref resolved='predef::DVB.Audio.mute'>mute()</ref></p> + </text></group></doc>   <method name='mixer'>   <arguments><argument name='left'><type><int/></type></argument><argument name='right'><type><int/></type></argument></arguments>   <returntype><int/></returntype>   </method>   <method name='mixer'>   <arguments><argument name='both'><type><int/></type></argument></arguments>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='mute' homogen-type='method'><doc><text><p>Mute or unmute audio device.</p> - </text></doc> + </text><group><seealso/><text><p><ref resolved='predef::DVB.Audio.mixer'>mixer()</ref></p> + </text></group></doc>   <method name='mute'>   <arguments><argument name='mute'><type><int/></type></argument></arguments>   <returntype><int/></returntype>   </method>   <method name='mute'>   <arguments/>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='status' homogen-type='method'><doc><text><p>Returns mapping of current audio device status.</p>
autodoc.git/autodoc.xml:26143:   </docgroup>   <docgroup homogen-name='read' homogen-type='method'><doc><text><p>Read data from a stream. It reads up to read buffer size data.</p>   </text><group><note/><text><p>Read buffer size is 4096 by default.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::DVB.dvb.stream'>DVB.dvb()-&gt;stream()</ref>, <ref resolved='predef::DVB.Stream.close'>close()</ref></p>   </text></group></doc>   <method name='read'>   <arguments/>   <returntype><or><string/><int/></or></returntype>   </method>   </docgroup> + <docgroup homogen-name='set_buffer' homogen-type='method'><doc><text><p>Sets stream's internal buffer.</p> + </text><group><note/><text><p>The size is 4096 by default.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::DVB.Stream.read'>read()</ref></p> + </text></group></doc> + <method name='set_buffer'> + <arguments><argument name='len'><type><int/></type></argument></arguments> + <returntype><int/></returntype> + </method> + </docgroup>   </class>   <class name='dvb'>   <doc><text><p>Main class.</p>   </text></doc>   <docgroup homogen-name='analyze_pat' homogen-type='method'><doc><text><p>Return mapping of all PMT.</p>   <p> sid:prognum</p>   </text></doc>   <method name='analyze_pat'>   <arguments/>   <returntype><mapping/></returntype>