autodoc.git
/
modref.xml
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/modref.xml:1:
<?xml version='1.0' encoding='utf-8'?>
-
<manual time-stamp='2018-05-
17
' version='Pike v8.1.13'>
+
<manual time-stamp='2018-05-
18
' 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:1107:
</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:1724:
<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/modref.xml:1891:
<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/modref.xml:5255:
<docgroup homogen-name='make_time' homogen-type='method'><doc><text><p>Creates a <ref resolved='predef::Standards.ASN1.Types.UTC'>Standards.ASN1.Types.UTC</ref> object from the posix time <ref resolved='8.0::Tools.X509.make_time.t'>t</ref>.</p> </text></doc> <method name='make_time'> <arguments><argument name='t'><type><int/></type></argument></arguments> <returntype><object resolved='predef::Standards.ASN1.Types.UTC'>UTC</object></returntype> </method> </docgroup> <docgroup homogen-name='make_verifier' homogen-type='method'> <method name='make_verifier'>
-
<arguments><argument name='_keyinfo'><type><object resolved='predef::Object'>Object</object></type></argument></arguments>
+
<arguments><argument name='_keyinfo'><type><object resolved='predef::
Standards.ASN1.Types.
Object'>Object</object></type></argument></arguments>
<returntype><object>Verifier</object></returntype> </method> </docgroup> <docgroup homogen-name='parse_time' homogen-type='method'><doc><text><p>Returns a mapping similar to that returned by gmtime</p> </text><group><returns/><text><mapping><group><member><type><int/></type><index>"year"</index></member><member><type><int/></type><index>"mon"</index></member><member><type><int/></type><index>"mday"</index></member><member><type><int/></type><index>"hour"</index></member><member><type><int/></type><index>"min"</index></member><member><type><int/></type><index>"sec"</index></member></group></mapping> </text></group></doc> <method name='parse_time'> <arguments><argument name='asn1'><type><object resolved='predef::Standards.ASN1.Types.UTC'>UTC</object></type></argument></arguments> <returntype><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping></returntype> </method>
autodoc.git/modref.xml:5356:
</docgroup> <docgroup homogen-name='der' homogen-type='variable'> <variable name='der'><type><string/></type></variable> </docgroup> <docgroup homogen-name='extensions' homogen-type='variable'><doc><group><note/><text><p>optional</p> </text></group></doc> <variable name='extensions'><type><object resolved='8.0::Tools.X509.TBSCertificate'/></type></variable> </docgroup> <docgroup homogen-name='init' homogen-type='method'> <method name='init'>
-
<arguments><argument name='asn1'><type><object resolved='predef::Object'>Object</object></type></argument></arguments>
+
<arguments><argument name='asn1'><type><object resolved='predef::
Standards.ASN1.Types.
Object'>Object</object></type></argument></arguments>
<returntype><object resolved='8.0::Tools.X509.TBSCertificate'>this_program</object></returntype> </method> </docgroup> <docgroup homogen-name='issuer' homogen-type='variable'> <variable name='issuer'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></variable> </docgroup> <docgroup homogen-name='issuer_id' homogen-type='variable'><doc><group><note/><text><p>optional</p> </text></group></doc> <variable name='issuer_id'><type><object resolved='predef::Standards.ASN1.Types.BitString'>BitString</object></type></variable> </docgroup>
autodoc.git/modref.xml:10873:
<returntype><string/></returntype> </method> <method name='utf8_to_string'> <arguments><argument name='s'><type><object>utf8_string</object></type></argument><argument name='extended'><type><int/></type></argument></arguments> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='validate_utf8' homogen-type='method'><doc><text><p>Checks whether a string is a valid UTF-8 byte-stream.</p> </text><group><param name='s'/><text><p>String of UTF-8 encoded data to validate.</p> </text></group><group><param name='extended'/><text><p>Bitmask with extension options.</p>
-
<int><group><value>1</value><text><p>Accept the extension used by <ref resolved='predef::string_to_utf8'>string_to_utf8()</ref>.</p>
+
<int><group><value>1</value><text><p>Accept the extension used by <ref resolved='predef::string_to_utf8'>string_to_utf8()</ref>
, including
+
lone UTF-16 surrogates
.</p>
</text></group><group><value>2</value><text><p>Accept UTF-8 encoded UTF-16 (ie accept valid surrogate-pairs).</p>
-
</text></group><group><value>4</value><text><p>Accept UTF-8 encoded invalid UTF-16 (ie accept lone surrogates).</p>
+
</text></group></int> </text></group><group><returns/><text><p>Returns <expr>0</expr> (zero) if the stream is not a legal UTF-8 byte-stream, and <expr>1</expr> if it is.</p> </text></group><group><note/><text><p>In conformance with <rfc>3629</rfc> and Unicode 3.1 and later, non-shortest forms are considered invalid.</p> </text></group><group><seealso/><text><p><ref resolved='predef::Charset.encoder'>Charset.encoder()</ref>, <ref resolved='predef::string_to_unicode'>string_to_unicode()</ref>, <ref resolved='predef::string_to_utf8'>string_to_utf8()</ref>, <ref resolved='predef::unicode_to_string'>unicode_to_string()</ref>, <ref resolved='predef::utf8_to_string'>utf8_to_string()</ref></p> </text></group></doc> <method name='validate_utf8'> <arguments><argument name='s'><type><object>utf8_string</object></type></argument></arguments>
autodoc.git/modref.xml:95039:
<variable name='lr_error'><type><int/></type></variable> </docgroup> <docgroup homogen-name='make_parser' homogen-type='method'><doc><text><p>Compiles the parser-specification given in the first argument. Named actions are taken from the object if available, otherwise left as is.</p> </text><group><bugs/><text><p>Returns error-code in both GrammarParser.error and return_value->lr_error.</p> </text></group></doc> <method name='make_parser'> <arguments><argument name='str'><type><string/></type></argument><argument name='m'><type><or><object resolved='predef::Parser.LR.GrammarParser.make_parser'/><void/></or></type></argument></arguments>
-
<returntype><object resolved='predef::Parser'>Parser</object></returntype>
+
<returntype><object resolved='predef::Parser
.LR.Parser
'>Parser</object></returntype>
</method> </docgroup> <docgroup homogen-name='make_parser_from_file' homogen-type='method'><doc><text><p>Compiles the file specified in the first argument into an LR parser.</p> </text><group><seealso/><text><p><ref resolved='predef::Parser.LR.GrammarParser.make_parser'>make_parser</ref></p> </text></group></doc> <method name='make_parser_from_file'> <arguments><argument name='fname'><type><string/></type></argument><argument name='m'><type><or><object resolved='predef::Parser.LR.GrammarParser.make_parser_from_file'/><void/></or></type></argument></arguments>
-
<returntype><or><int/><object resolved='predef::Parser'>Parser</object></or></returntype>
+
<returntype><or><int/><object resolved='predef::Parser
.LR.Parser
'>Parser</object></or></returntype>
</method> </docgroup> </module> <class name='Parser'> <doc><text><p>This object implements an LALR(1) parser and compiler.</p> <p> Normal use of this object would be:</p> <p> <pre> set_error_handler {add_rule, set_priority, set_associativity}* set_symbol_to_string