autodoc.git / autodoc.xml

version» Context lines:

autodoc.git/autodoc.xml:3005:   <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:3172:   <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:8141:   </method>   </docgroup>      <docgroup homogen-name='decode_value' homogen-type='method'><doc><text><p>Decode a value from the string <ref resolved='predef::decode_value.coded_value'>coded_value</ref>.</p>   <p> This function takes a string created with <ref resolved='predef::encode_value'>encode_value()</ref> or    <ref resolved='predef::encode_value_canonic'>encode_value_canonic()</ref> and converts it back to the value that was    coded.</p>   <p> If <ref resolved='predef::decode_value.codec'>codec</ref> is specified, it's used as the codec for the decode.    If none is specified, then one is instantiated through    <expr>master()-&gt;Decoder()</expr>. As a compatibility fallback, the -  master itself is used if it has no <expr>Decoder</expr> class.</p> - </text><group><seealso/><text><p><ref resolved='predef::encode_value'>encode_value()</ref>, <ref resolved='predef::encode_value_canonic'>encode_value_canonic()</ref></p> +  master itself is used if it has no <expr>Decoder</expr> class. +  If <ref resolved='predef::decode_value.codec'>codec</ref> is the special value <expr>-1</expr>, then decoding of +  types, functions, programs and objects is disabled.</p> + </text><group><note/><text><p>Decoding a <ref resolved='predef::decode_value.coded_value'>coded_value</ref> that you have not generated yourself +  is a <b>security risk</b> that can lead to execution of arbitrary +  code, unless <ref resolved='predef::decode_value.codec'>codec</ref> is specified as <expr>-1</expr>.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::encode_value'>encode_value()</ref>, <ref resolved='predef::encode_value_canonic'>encode_value_canonic()</ref></p>   </text></group></doc>   <method name='decode_value'> - <arguments><argument name='coded_value'><type><string/></type></argument><argument name='codec'><type><or><void/><object resolved='predef::Codec'>Codec</object></or></type></argument></arguments> + <arguments><argument name='coded_value'><type><string/></type></argument><argument name='codec'><type><or><void/><object resolved='predef::Codec'>Codec</object><int><min>-1</min><max>-1</max></int></or></type></argument></arguments>   <returntype><mixed/></returntype>   </method>   </docgroup>      <docgroup homogen-name='delay' homogen-type='method'><doc><text><p>This function makes the program stop for <ref resolved='predef::delay.s'>s</ref> seconds.</p>   <p> Only signal handlers can interrupt the sleep. Other callbacks are    not called during delay. Beware that this function uses busy-waiting    to achieve the highest possible accuracy.</p>   </text><group><seealso/><text><p><ref resolved='predef::signal'>signal()</ref>, <ref resolved='predef::sleep'>sleep()</ref></p>   </text></group></doc>
autodoc.git/autodoc.xml:103150:    the parent class (<ref resolved='predef::Nettle.BlockCipher16'>BlockCipher16</ref>).</p>   <p> This is a so-called authenticated encryption with associated data    (AEAD) algorithm, and in addition to encryption also provides    message digests.</p>   </text><group><note/><text><p>This mode of operation was specified as a reaction to the    limitiations of the <ref resolved='predef::Nettle.BlockCipher16.CCM'>BlockCipher16.CCM</ref> mode.</p>   </text></group><group><note/><text><p>Note that this module is not available in all versions of Nettle.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Nettle.BlockCipher.CBC'>CBC</ref>, <ref resolved='predef::Nettle.BlockCipher.CTR'>CTR</ref>, <ref resolved='predef::Nettle.BlockCipher16.CCM'>BlockCipher16.CCM</ref>, <ref resolved='predef::Nettle.BlockCipher16.GCM'>BlockCipher16.GCM</ref></p>   </text></group></doc>   <docgroup homogen-name='digest_size' homogen-type='method'><doc><text><p>Default digest size.</p> - </text><group><returns/><text><p>Returns <ref resolved='predef::Nettle.Cipher.block_size'>BlockCipher::block_size()</ref>, but overloading via + </text><group><returns/><text><p>Returns <ref resolved='predef::__builtin.Nettle.Cipher.block_size'>BlockCipher::block_size()</ref>, but overloading via    inherit is supported, and may return any positive number    <expr>&lt;= BlockCipher::block_size()</expr>.</p>   </text></group></doc>   <method name='digest_size'>   <arguments/>   <returntype><int><min>1</min><max/></int></returntype>   </method>   </docgroup>   <docgroup homogen-name='AEAD' homogen-type='inherit'>   <inherit name='AEAD'><classname resolved='predef::__builtin.Nettle.AEAD'>__builtin.Nettle.AEAD</classname></inherit>
autodoc.git/autodoc.xml:104850:   </method>   </docgroup>   <class name='odbc'>   <doc><text><p>Low-level connection to an ODBC or DSN database.</p>   </text><group><note/><text><p>You typically don't want to access this module directly, but    instead use the <ref resolved='predef::Sql.odbc'>Sql.odbc</ref> or <ref>Sql.dsn</ref> created by <ref resolved='predef::Sql.Sql'>Sql.Sql()</ref>.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Sql.odbc'>Sql.odbc</ref>, <ref>Sql.dsn</ref></p>   </text></group></doc>   </class>   </module> - <module name='Oracle'> - <doc><text><p>Pike interface to Oracle databases.</p> - </text><group><thanks/><text><p>Original design by Marcus Comstedt.</p> - <p> Re-written for Oracle 8.x and later by Fredrik Hubinette.</p> - <p> Re-structured into a CMOD by Henrik Grubbström.</p> - </text></group></doc> - <class name='oracle'> - <doc><text><p>Connection to an Oracle database server.</p> - </text><group><note/><text><p>You probably don't want to access this class directly, but -  rather via <ref resolved='predef::Sql.Sql'>Sql.Sql</ref>.</p> - </text></group><group><seealso/><text><p><ref resolved='predef::Sql.Sql'>Sql.Sql</ref>, <ref>Sql.oracle</ref></p> - </text></group></doc> - <docgroup homogen-name='Connection' homogen-type='inherit'> - <inherit name='Connection'><classname>__builtin.Sql.Connection</classname></inherit> - </docgroup> -  - <class name='LOB'> - <doc><text><p>Large OBject.</p> - </text></doc> - </class> - <class name='NULL'> - <docgroup homogen-name='Null' homogen-type='inherit'> - <inherit name='Null'><classname resolved='predef::Val.Null'>Val.Null</classname></inherit> - </docgroup> - <docgroup homogen-name='is_oracle_null' homogen-type='constant'> - <constant name='is_oracle_null'/> - </docgroup> - </class> - <class name='compile_query'> - <class name='TypedResult'> - <docgroup homogen-name='Result' homogen-type='inherit'> - <inherit name='Result'><classname>__builtin.Sql.Result</classname></inherit> - </docgroup> - </class> -  - </class> - </class> - </module> +    <module name='PDF'>   <docgroup homogen-type='constant'>   <constant name='a0_width'/>   <constant name='a0_height'/>   <constant name='a1_width'/>   <constant name='a1_height'/>   <constant name='a2_width'/>   <constant name='a2_height'/>   <constant name='a3_width'/>   <constant name='a3_height'/>
autodoc.git/autodoc.xml:126727:   </text></group><group><note/><text><p>In versions of Pike prior to 7.2 it was possible to leave out the    dbtype, but that has been deprecated, since it never worked well.</p>   </text></group><group><note/><text><p>Exactly which databases are supported by pike depends on the    installed set of client libraries when pike was compiled.</p>   <p> The possible ones are</p>   <dl><group><item name='mysql'/><text><p>libmysql based mysql connection</p>   </text></group><group><item name='mysqls'/><text><p>libmysql based mysql connection, using SSL</p>   </text></group><group><item name='dsn'/><text><p><ref>ODBC</ref> based connection</p>   </text></group><group><item name='msql'/><text><p><ref resolved='predef::Msql'>Msql</ref></p>   </text></group><group><item name='odbc'/><text><p><ref>ODBC</ref> based connection</p> - </text></group><group><item name='oracle'/><text><p><ref resolved='predef::Oracle'>Oracle</ref> using oracle libraries</p> + </text></group><group><item name='oracle'/><text><p><ref>Oracle</ref> using oracle libraries</p>   </text></group><group><item name='pgsql'/><text><p>PostgreSQL direct network access.    This module is independent of any external libraries.</p>   </text></group><group><item name='postgres'/><text><p>PostgreSQL libray access. Uses the <ref resolved='predef::Postgres'>Postgres</ref> module.</p>   </text></group><group><item name='rsql'/><text><p>Remote SQL api, requires a rsql server running on another host.    This is an API that uses sockets to communicate with a remote pike    running pike -x rsqld on another host.</p>   </text></group><group><item name='sqlite'/><text><p>In-process SQLite database, uses the <ref>SQLite</ref> module</p>   </text></group><group><item name='sybase'/><text><p>Uses the <ref>sybase</ref> module to access sybase</p>   </text></group><group><item name='tds'/><text><p>Sybase and Microsoft SQL direct network access using the TDS protocol.    This module is independent of any external libraries.</p>
autodoc.git/autodoc.xml:132407:   <method name='get_module_xml'>   <arguments><argument name='dir'><type><object>Directory</object></type></argument><argument name='id'><type><string/></type></argument><argument name='version'><type><string/></type></argument><argument name='manufacturer'><type><or><string/><void/></or></type></argument><argument name='description'><type><or><string/><void/></or></type></argument><argument name='guid'><type><or><string/><void/></or></type></argument><argument name='comments'><type><or><string/><void/></or></type></argument><argument name='installer_version'><type><or><string/><void/></or></type></argument></arguments>   <returntype><object>WixNode</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   </module>   </module> - <module name='_BSON'> - <docgroup homogen-name='decode' homogen-type='method'> - <method name='decode'> - <arguments><argument name='document'><type><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object></type></argument></arguments> - <returntype><mapping/></returntype> - </method> - </docgroup> - <docgroup homogen-name='decode' homogen-type='method'> - <method name='decode'> - <arguments><argument name='document'><type><string><min>0</min><max>255</max></string></type></argument></arguments> - <returntype><mapping/></returntype> - </method> - </docgroup> +    </module> - </module> +    <module name='Stdio'>   <docgroup homogen-name='DATA_CHUNK_SIZE' homogen-type='constant'><doc><text><p>Size used in various places to divide incoming or outgoing data    into chunks.</p>   </text></doc>   <constant name='DATA_CHUNK_SIZE'><modifiers><final/></modifiers><type><int/></type></constant>   </docgroup>   <docgroup homogen-name='NOTE_ATTRIB' homogen-type='constant'>   <constant name='NOTE_ATTRIB'><type><int/></type></constant>   </docgroup>   <docgroup homogen-name='NOTE_DELETE' homogen-type='constant'>
autodoc.git/autodoc.xml:138083:   <method name='create'>   <arguments><argument name='buffer'><type><string/></type></argument><argument name='split_set'><type><or><int/><array><valuetype><int/></valuetype></array><multiset><indextype><int/></indextype></multiset></or></type></argument><argument name='flags'><type><or><int/><void/></or></type></argument><argument name='feed'><type><or><function><returntype><string/></returntype></function><void/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='predef::Iterator' homogen-type='inherit'>   <inherit name='predef::Iterator'><classname resolved='predef::Iterator'>predef::Iterator</classname></inherit>   </docgroup>   </class>   </module> - <module name='Sybase'> - <class name='sybase'> - <docgroup homogen-name='Connection' homogen-type='inherit'> - <inherit name='Connection'><classname>__builtin.Sql.Connection</classname></inherit> - </docgroup> - </class> - </module> +    <module name='System'>   <doc><text><p>This module embodies common operating system calls, making them    available to the Pike programmer.</p>   </text></doc>   <docgroup homogen-name='AllocConsole' homogen-type='method'><doc><text><p>Allocates a new console for the calling process.</p>   </text><group><note/><text><p>Only available on certain Windows systems.</p>   </text></group><group><returns/><text><p>0 on success, non-zero otherwise.</p>   </text></group></doc>   <method name='AllocConsole'>   <arguments/>
autodoc.git/autodoc.xml:149589:   <docgroup homogen-name='Session' homogen-type='inherit'>   <inherit name='Session'><classname>Configuration::Session</classname></inherit>   </docgroup>   <docgroup homogen-name='session_id' homogen-type='variable'><doc><text><p>Session id (if any).</p>   </text></doc>   <variable name='session_id'><type><string><min>0</min><max>255</max></string></type></variable>   </docgroup>   </class>   </class>   </module> - <module name='_Charset'> - <doc><text><p>Low-level tables and code for the <ref resolved='predef::Charset'>Charset</ref> module.</p> - <p> This is probably not the module you want; try the <ref resolved='predef::Charset'>Charset</ref> module.</p> - </text><group><seealso/><text><p><ref resolved='predef::Charset'>Charset</ref></p> - </text></group></doc> - <docgroup homogen-name='rfc1345' homogen-type='method'><doc><text><p>Low-level charset codec factory.</p> - </text><group><param name='charset'/><text><p>Canonical name of character set to look up.</p> - </text></group><group><param name='encoder'/><text><p>Flag indicating that an encoder and not a decoder is wanted.</p> - </text></group><group><param name='rep'/><text><p>String to use for characters not representable in the <ref resolved='predef::_Charset.rfc1345.charset'>charset</ref>. -  Only used for encoders.</p> - </text></group><group><param name='repcb'/><text><p>Function to call for characters not representable in the <ref resolved='predef::_Charset.rfc1345.charset'>charset</ref>. -  Only used for encoders.</p> - <p> This is the main entrypoint into the low-level <ref resolved='predef::_Charset'>_Charset</ref> module.</p> - </text></group><group><returns/><text><p>Returns a suitable encoder or decoder on success and <expr>0</expr> -  (zero) on failure.</p> - </text></group><group><seealso/><text><p><ref resolved='predef::Charset.encoder'>Charset.encoder()</ref>, <ref resolved='predef::Charset.decoder'>Charset.decoder()</ref></p> - </text></group></doc> - <method name='rfc1345'> - <arguments><argument name='charset'><type><string/></type></argument><argument name='encoder'><type><or><int><min>0</min><max>1</max></int><void/></or></type></argument><argument name='rep'><type><or><string/><void/></or></type></argument><argument name='repcb'><type><or><function><argtype><string/></argtype><returntype><string/></returntype></function><void/></or></type></argument></arguments> - <returntype><object resolved='predef::_Charset.rfc1345'/></returntype> - </method> - </docgroup> - </module> +    <module name='_Ffmpeg'>   <docgroup homogen-type='constant'><doc><text><p>Various audio and video codecs.</p>   </text><group><note/><text><p>The list of supported codecs depends on Ffmpeg library.</p>   </text></group></doc>   <constant name='CODEC_ID_NONE'/>   <constant name='CODEC_ID_AC3'/>   <constant name='CODEC_ID_ADPCM_IMA_QT'/>   <constant name='CODEC_ID_ADPCM_IMA_WAV'/>   <constant name='CODEC_ID_ADPCM_MS'/>   <constant name='CODEC_ID_H263'/>