Diff of autodoc.git/autodoc.xml (c44a38f02a70626f3b5151339dcb3831c2aaf69d » c99d6c2749cae6ed0d932453db17e6ecaea4bf5f)

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>Random cookies, sent and received with the hello-messages. </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>Whether this is the server end of the connection or not. </text></group><group><param name='ctx'/><text>The context for the connection. </text></group><group><param name='min_version'/><text>Minimum version of SSL to support. - Defaults to <ref resolved='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>. + Defaults to <ref resolved='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>. </text></group><group><param name='max_version'/><text>Maximum version of SSL to support. Defaults to <ref resolved='7.8::SSL.Constants.PROTOCOL_minor'>Constants.PROTOCOL_minor</ref>. </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>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>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>. </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>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>Sets the compression method. Currently only <ref resolved='7.8::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is supported. </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>Interface similar to <ref resolved='7.8::Stdio.File'>Stdio.File</ref>.
autodoc.git/autodoc.xml:8141: </method> </docgroup> <docgroup homogen-name='decode_value' homogen-type='method'><doc><text>Decode a value from the string <ref resolved='predef::decode_value.coded_value'>coded_value</ref>. 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. 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()->Decoder()</expr>. As a compatibility fallback, the - master itself is used if it has no <expr>Decoder</expr> class. - </text><group><seealso/><text><ref resolved='predef::encode_value'>encode_value()</ref>, <ref resolved='predef::encode_value_canonic'>encode_value_canonic()</ref> + 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. + </text><group><note/><text>Decoding a <ref resolved='predef::decode_value.coded_value'>coded_value</ref> that you have not generated yourself + is a security risk that can lead to execution of arbitrary + code, unless <ref resolved='predef::decode_value.codec'>codec</ref> is specified as <expr>-1</expr>. + </text></group><group><seealso/><text><ref resolved='predef::encode_value'>encode_value()</ref>, <ref resolved='predef::encode_value_canonic'>encode_value_canonic()</ref> </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>This function makes the program stop for <ref resolved='predef::delay.s'>s</ref> seconds. 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. </text><group><seealso/><text><ref resolved='predef::signal'>signal()</ref>, <ref resolved='predef::sleep'>sleep()</ref> </text></group></doc>
autodoc.git/autodoc.xml:103150: the parent class (<ref resolved='predef::Nettle.BlockCipher16'>BlockCipher16</ref>). This is a so-called authenticated encryption with associated data (AEAD) algorithm, and in addition to encryption also provides message digests. </text><group><note/><text>This mode of operation was specified as a reaction to the limitiations of the <ref resolved='predef::Nettle.BlockCipher16.CCM'>BlockCipher16.CCM</ref> mode. </text></group><group><note/><text>Note that this module is not available in all versions of Nettle. </text></group><group><seealso/><text><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> </text></group></doc> <docgroup homogen-name='digest_size' homogen-type='method'><doc><text>Default digest size. - </text><group><returns/><text>Returns <ref resolved='predef::Nettle.Cipher.block_size'>BlockCipher::block_size()</ref>, but overloading via + </text><group><returns/><text>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><= BlockCipher::block_size()</expr>. </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>Low-level connection to an ODBC or DSN database. </text><group><note/><text>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>. </text></group><group><seealso/><text><ref resolved='predef::Sql.odbc'>Sql.odbc</ref>, <ref>Sql.dsn</ref> </text></group></doc> </class> </module> - <module name='Oracle'> - <doc><text>Pike interface to Oracle databases. - </text><group><thanks/><text>Original design by Marcus Comstedt. - Re-written for Oracle 8.x and later by Fredrik Hubinette. - Re-structured into a CMOD by Henrik Grubbström. - </text></group></doc> - <class name='oracle'> - <doc><text>Connection to an Oracle database server. - </text><group><note/><text>You probably don't want to access this class directly, but - rather via <ref resolved='predef::Sql.Sql'>Sql.Sql</ref>. - </text></group><group><seealso/><text><ref resolved='predef::Sql.Sql'>Sql.Sql</ref>, <ref>Sql.oracle</ref> - </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>Large OBject. - </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>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. </text></group><group><note/><text>Exactly which databases are supported by pike depends on the installed set of client libraries when pike was compiled. The possible ones are <dl><group><item name='mysql'/><text>libmysql based mysql connection </text></group><group><item name='mysqls'/><text>libmysql based mysql connection, using SSL </text></group><group><item name='dsn'/><text><ref>ODBC</ref> based connection </text></group><group><item name='msql'/><text><ref resolved='predef::Msql'>Msql</ref> </text></group><group><item name='odbc'/><text><ref>ODBC</ref> based connection - </text></group><group><item name='oracle'/><text><ref resolved='predef::Oracle'>Oracle</ref> using oracle libraries + </text></group><group><item name='oracle'/><text><ref>Oracle</ref> using oracle libraries </text></group><group><item name='pgsql'/><text>PostgreSQL direct network access. This module is independent of any external libraries. </text></group><group><item name='postgres'/><text>PostgreSQL libray access. Uses the <ref resolved='predef::Postgres'>Postgres</ref> module. </text></group><group><item name='rsql'/><text>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. </text></group><group><item name='sqlite'/><text>In-process SQLite database, uses the <ref>SQLite</ref> module </text></group><group><item name='sybase'/><text>Uses the <ref>sybase</ref> module to access sybase </text></group><group><item name='tds'/><text>Sybase and Microsoft SQL direct network access using the TDS protocol. This module is independent of any external libraries.
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>Size used in various places to divide incoming or outgoing data into chunks. </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>This module embodies common operating system calls, making them available to the Pike programmer. </text></doc> <docgroup homogen-name='AllocConsole' homogen-type='method'><doc><text>Allocates a new console for the calling process. </text><group><note/><text>Only available on certain Windows systems. </text></group><group><returns/><text>0 on success, non-zero otherwise. </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>Session id (if any). </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>Low-level tables and code for the <ref resolved='predef::Charset'>Charset</ref> module. - This is probably not the module you want; try the <ref resolved='predef::Charset'>Charset</ref> module. - </text><group><seealso/><text><ref resolved='predef::Charset'>Charset</ref> - </text></group></doc> - <docgroup homogen-name='rfc1345' homogen-type='method'><doc><text>Low-level charset codec factory. - </text><group><param name='charset'/><text>Canonical name of character set to look up. - </text></group><group><param name='encoder'/><text>Flag indicating that an encoder and not a decoder is wanted. - </text></group><group><param name='rep'/><text>String to use for characters not representable in the <ref resolved='predef::_Charset.rfc1345.charset'>charset</ref>. - Only used for encoders. - </text></group><group><param name='repcb'/><text>Function to call for characters not representable in the <ref resolved='predef::_Charset.rfc1345.charset'>charset</ref>. - Only used for encoders. - This is the main entrypoint into the low-level <ref resolved='predef::_Charset'>_Charset</ref> module. - </text></group><group><returns/><text>Returns a suitable encoder or decoder on success and <expr>0</expr> - (zero) on failure. - </text></group><group><seealso/><text><ref resolved='predef::Charset.encoder'>Charset.encoder()</ref>, <ref resolved='predef::Charset.decoder'>Charset.decoder()</ref> - </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>Various audio and video codecs. </text><group><note/><text>The list of supported codecs depends on Ffmpeg library. </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'/>

autodoc.git / autodoc.xml