Diff of autodoc.git/autodoc.xml (8c7162c07731eb17f40ac3fa1b00427eb673e375 » cb7bba6fedf6d5f4b51a5f67cef11242c2dd0e3e)

autodoc.git/autodoc.xml:84: </text></group><group><value>1</value><text>See protected symbols as well. </text></group></int>This function indexes the current object with the string <ref resolved='::`->.index'>index</ref>. This is useful when the arrow operator has been overloaded. </text></group><group><seealso/><text><ref resolved='::`->='>::`->=()</ref> </text></group></doc> <method name='`->'> <arguments><argument name='index'><type><string/></type></argument><argument name='context'><type><or><object resolved='::`->'/><void/></or></type></argument><argument name='access'><type><or><int/><void/></or></type></argument></arguments> <returntype><mixed/></returntype> </method> </docgroup> - <docgroup homogen-name='`->=' homogen-type='method'><doc><text>Builtin arrow set operator. + <docgroup homogen-name='`->=' homogen-type='method'><doc><text>Builtin atomic arrow get and set operator. </text><group><param name='index'/><text>Symbol in <ref resolved='::`->=.context'>context</ref> to change the value of. </text></group><group><param name='value'/><text>The new value. </text></group><group><param name='context'/><text>Context in the current object to start the search from. If <expr>UNDEFINED</expr> or left out, <expr>this_program::this</expr> will be used (ie start at the current context and ignore any overloaded symbols). </text></group><group><param name='access'/><text>Access permission override. One of the following: <int><group><value>0</value><value>UNDEFINED</value><text>See only public symbols. </text></group><group><value>1</value><text>See protected symbols as well. </text></group></int>This function indexes the current object with the string <ref resolved='::`->=.index'>index</ref>, and sets it to <ref resolved='::`->=.value'>value</ref>. This is useful when the arrow set operator has been overloaded. - + </text></group><group><returns/><text>Returns the previous value at index <ref resolved='::`->=.index'>index</ref> of the current object. </text></group><group><seealso/><text><ref resolved='::`->'>::`->()</ref> </text></group></doc> <method name='`->='> <arguments><argument name='index'><type><string/></type></argument><argument name='value'><type><mixed/></type></argument><argument name='context'><type><or><object resolved='::`->='/><void/></or></type></argument><argument name='access'><type><or><int/><void/></or></type></argument></arguments> - <returntype><void/></returntype> + <returntype><mixed/></returntype> </method> </docgroup> </namespace> <namespace name='7.8'> <doc><text>Pike 7.8 compatibility. The symbols in this namespace will appear in programs that use <tt>#pike 7.8</tt> or lower. </text></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='8.0::'>7.9::</classname></import>
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>Implements Diffie-Hellman key-exchange. 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>. + <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>. </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>Diffie-Hellman parameters.
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>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:6399: </text></group><group><returns/><text>Returns the value at <ref resolved='lfun::`->.index'>index</ref> if it exists, and <expr>UNDEFINED</expr> otherwise. </text></group><group><note/><text>It's assumed that this function is side-effect free. </text></group><group><seealso/><text><ref resolved='predef::`->'>predef::`->()</ref>, <ref resolved='::`->'>::`->()</ref> </text></group></doc> <method name='`->'> <arguments><argument name='index'><type><string/></type></argument><argument name='context'><type><or><object resolved='lfun::`->'/><void/></or></type></argument><argument name='access'><type><or><int/><void/></or></type></argument></arguments> <returntype><mixed/></returntype> </method> </docgroup> - <docgroup homogen-name='`->=' homogen-type='method'><doc><text>Arrow index assignment callback. + <docgroup homogen-name='`->=' homogen-type='method'><doc><text>Atomic get and set arrow index callback. </text><group><param name='index'/><text>Symbol in <ref resolved='lfun::`->=.context'>context</ref> to change the value of. </text></group><group><param name='value'/><text>The new value. </text></group><group><param name='context'/><text>Context in the current object to index. If <expr>UNDEFINED</expr> or left out, <expr>this_program::this</expr> is to be used (ie start at the current context and ignore any overloaded symbols). </text></group><group><param name='access'/><text>Access permission override. One of the following: <int><group><value>0</value><value>UNDEFINED</value><text>See only public symbols. </text></group><group><value>1</value><text>See protected symbols as well. </text></group></int>This function is to set the value at symbol <ref resolved='lfun::`->=.index'>index</ref> of the current object to <ref resolved='lfun::`->=.value'>value</ref>. - + </text></group><group><returns/><text>Returns the previous value at symbol <ref resolved='lfun::`->=.index'>index</ref> of the current object. </text></group><group><seealso/><text><ref resolved='predef::`->='>predef::`->=()</ref>, <ref resolved='::`->='>::`->=()</ref>, <ref resolved='lfun::`[]='>lfun::`[]=()</ref>, <ref resolved='lfun::_atomic_get_set'>lfun::_atomic_get_set()</ref> </text></group></doc> <method name='`->='> <arguments><argument name='index'><type><string/></type></argument><argument name='value'><type><zero/></type></argument><argument name='context'><type><or><object resolved='lfun::`->='/><void/></or></type></argument><argument name='access'><type><or><int/><void/></or></type></argument></arguments> - <returntype><void/></returntype> + <returntype><mixed/></returntype> </method> </docgroup> <docgroup homogen-name='`/' homogen-type='method'><doc><text>Left side division/split callback. </text><group><note/><text>It's assumed that this function is side-effect free. </text></group><group><seealso/><text><ref resolved='lfun::``/'>lfun::``/()</ref>, <ref resolved='predef::`/'>predef::`/()</ref> </text></group></doc> <method name='`/'> <arguments><argument name='args'><type><varargs><zero/></varargs></type></argument></arguments> <returntype><mixed/></returntype> </method>
autodoc.git/autodoc.xml:6507: there is a <ref resolved='lfun::`[..]'>`[..]</ref> in the class. See <ref resolved='predef::`[..]'>predef::`[..]</ref> for details. </text><group><note/><text>It's assumed that this function is side-effect free. </text></group><group><seealso/><text><ref resolved='predef::`[]'>predef::`[]()</ref>, <ref resolved='predef::`[..]'>predef::`[..]</ref> </text></group></doc> <method name='`[]'> <arguments><argument name='arg1'><type><zero/></type></argument><argument name='arg2'><type><or><zero/><void/></or></type></argument></arguments> <returntype><mixed/></returntype> </method> </docgroup> - <docgroup homogen-name='`[]=' homogen-type='method'><doc><text>Index assignment callback. + <docgroup homogen-name='`[]=' homogen-type='method'><doc><text>Atomic get and set index callback. </text><group><param name='index'/><text>Index to change the value of. </text></group><group><param name='value'/><text>The new value. </text></group><group><param name='context'/><text>Context in the current object to index. If <expr>UNDEFINED</expr> or left out, <expr>this_program::this</expr> is to be used (ie start at the current context and ignore any overloaded symbols). </text></group><group><param name='access'/><text>Access permission override. One of the following: <int><group><value>0</value><value>UNDEFINED</value><text>See only public symbols. </text></group><group><value>1</value><text>See protected symbols as well. </text></group></int>This function is to set the value at index <ref resolved='lfun::`[]=.index'>index</ref> of the current object to <ref resolved='lfun::`[]=.value'>value</ref>. - + </text></group><group><returns/><text>Returns the previous value at index <ref resolved='lfun::`[]=.index'>index</ref> of the current object. </text></group><group><seealso/><text><ref resolved='predef::`[]='>predef::`[]=()</ref>, <ref resolved='lfun::`->='>lfun::`->=()</ref>, <ref resolved='lfun::_atomic_get_set'>lfun::_atomic_get_set()</ref> </text></group></doc> <method name='`[]='> <arguments><argument name='index'><type><zero/></type></argument><argument name='value'><type><zero/></type></argument><argument name='context'><type><or><object resolved='lfun::`[]='/><void/></or></type></argument><argument name='access'><type><or><int/><void/></or></type></argument></arguments> - <returntype><void/></returntype> + <returntype><mixed/></returntype> </method> </docgroup> <docgroup homogen-name='`^' homogen-type='method'><doc><text>Left side exclusive or callback. </text><group><note/><text>It's assumed that this function is side-effect free. </text></group><group><seealso/><text><ref resolved='lfun::``^'>lfun::``^()</ref>, <ref resolved='predef::`^'>predef::`^()</ref> </text></group></doc> <method name='`^'> <arguments><argument name='args'><type><varargs><zero/></varargs></type></argument></arguments> <returntype><mixed/></returntype> </method>
autodoc.git/autodoc.xml:97263: <variable name='lr_error'><type><int/></type></variable> </docgroup> <docgroup homogen-name='make_parser' homogen-type='method'><doc><text>Compiles the parser-specification given in the first argument. Named actions are taken from the object if available, otherwise left as is. </text><group><bugs/><text>Returns error-code in both GrammarParser.error and return_value->lr_error. </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.LR.Parser'>Parser</object></returntype> + <returntype><object resolved='predef::Parser'>Parser</object></returntype> </method> </docgroup> <docgroup homogen-name='make_parser_from_file' homogen-type='method'><doc><text>Compiles the file specified in the first argument into an LR parser. </text><group><seealso/><text><ref resolved='predef::Parser.LR.GrammarParser.make_parser'>make_parser</ref> </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.LR.Parser'>Parser</object></or></returntype> + <returntype><or><int/><object resolved='predef::Parser'>Parser</object></or></returntype> </method> </docgroup> </module> <class name='Parser'> <doc><text>This object implements an LALR(1) parser and compiler. Normal use of this object would be: <pre> set_error_handler {add_rule, set_priority, set_associativity}* set_symbol_to_string
autodoc.git/autodoc.xml:125446: public keys must be set. </text></group><group><param name='name'/><text>The distinguished name for the certificate. </text></group><group><param name='attributes'/><text>Attributes from PKCS #9 to add to the certificate. </text></group><group><param name='hash'/><text>Hash algoritm to use for the CSR signature. Defaults to <ref resolved='predef::Crypto.SHA256'>Crypto.SHA256</ref>. </text></group><group><note/><text>Prior to Pike 8.0 this function only supported signing with <ref resolved='predef::Crypto.RSA'>Crypto.RSA</ref> and the default (and only) hash was <ref resolved='predef::Crypto.MD5'>Crypto.MD5</ref>. </text></group></doc> <method name='build_csr'> - <arguments><argument name='sign'><type><object resolved='predef::Crypto.Sign'>Crypto.Sign</object></type></argument><argument name='name'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></argument><argument name='attributes'><type><mapping><indextype><string/></indextype><valuetype><array><valuetype><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></valuetype></array></valuetype></mapping></type></argument><argument name='hash'><type><or><object resolved='predef::Crypto.Hash'>Crypto.Hash</object><void/></or></type></argument></arguments> + <arguments><argument name='sign'><type><object resolved='predef::Crypto.Sign'>Crypto.Sign</object></type></argument><argument name='name'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></argument><argument name='attributes'><type><mapping><indextype><string/></indextype><valuetype><array><valuetype><object resolved='predef::Object'>Object</object></valuetype></array></valuetype></mapping></type></argument><argument name='hash'><type><or><object resolved='predef::Crypto.Hash'>Crypto.Hash</object><void/></or></type></argument></arguments> <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> <docgroup homogen-name='Types' homogen-type='import'> <import name='Types'><classname resolved='predef::Standards.ASN1.Types'>Standards.ASN1.Types</classname></import> </docgroup> <docgroup homogen-name='sign_cri' homogen-type='method'><doc><text>Sign a <ref resolved='predef::Standards.PKCS.CSR.CRI'>CRI</ref> to generate a Certificate Signing Request.
autodoc.git/autodoc.xml:125896: Setting The signature. </text></doc> <variable name='signature'><type><object resolved='predef::Standards.ASN1.Types.BitString'>BitString</object></type></variable> </docgroup> <docgroup homogen-name='tbs' homogen-type='variable'><doc><text>Getting ASN.1 structure that has been signed. Setting ASN.1 structure that has been signed. </text></doc> - <variable name='tbs'><type><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></type></variable> + <variable name='tbs'><type><object resolved='predef::Object'>Object</object></type></variable> </docgroup> </class> </module> </module> <module name='TLD'> <docgroup homogen-name='cc' homogen-type='constant'><doc><text>A mapping between country TLDs and the name of the country. </text></doc> <constant name='cc'/> </docgroup> <docgroup homogen-name='generic' homogen-type='variable'><doc><text>A multiset containing the generic TLDs, such as "com" and "info".
autodoc.git/autodoc.xml:126417: <method name='load_authorities'> <arguments><argument name='root_cert_dirs'><type><or><string/><array><valuetype><string/></valuetype></array><void/></or></type></argument><argument name='cache'><type><or><int><min>0</min><max>1</max></int><void/></or></type></argument></arguments> <returntype><mapping><indextype><string/></indextype><valuetype><array><valuetype><object resolved='predef::Standards.X509.Verifier'>Verifier</object></valuetype></array></valuetype></mapping></returntype> </method> </docgroup> <docgroup homogen-name='make_extension' homogen-type='method'><doc><text>Creates a certificate extension with the <ref resolved='predef::Standards.X509.make_extension.id'>id</ref> as identifier and <ref resolved='predef::Standards.X509.make_extension.ext'>ext</ref> as the extension payload. If the <ref resolved='predef::Standards.X509.make_extension.critical'>critical</ref> flag is set the extension will be marked as critical. </text></doc> <method name='make_extension'> - <arguments><argument name='id'><type><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></type></argument><argument name='ext'><type><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></type></argument><argument name='critical'><type><or><void/><int/></or></type></argument></arguments> + <arguments><argument name='id'><type><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></type></argument><argument name='ext'><type><object resolved='predef::Object'>Object</object></type></argument><argument name='critical'><type><or><void/><int/></or></type></argument></arguments> <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype> </method> </docgroup> <docgroup homogen-name='make_selfsigned_certificate' homogen-type='method'><doc><text>Creates a selfsigned certificate, i.e. where issuer and subject are the same entity. This entity is derived from the list of pairs in <ref resolved='predef::Standards.X509.make_selfsigned_certificate.name'>name</ref>, which is encoded into an distinguished_name by <ref resolved='predef::Standards.PKCS.Certificate.build_distinguished_name'>Standards.PKCS.Certificate.build_distinguished_name</ref>. </text><group><param name='c'/><text>The public key cipher used for the certificate, <ref resolved='predef::Crypto.RSA'>Crypto.RSA</ref>, <ref resolved='predef::Crypto.DSA'>Crypto.DSA</ref> or <ref resolved='predef::Crypto.ECC.Curve.ECDSA'>Crypto.ECC.Curve.ECDSA</ref>. The object should be initialized with both public and private keys.
autodoc.git/autodoc.xml:126727: </docgroup> <docgroup homogen-name='ext_subjectKeyIdentifier' homogen-type='variable'><doc><text>Set to the value of the SubjectKeyIdentifier if the certificate contains the subjectKeyIdentifier extension. <rfc>3280:4.2.1.2</rfc>. </text></doc> <variable name='ext_subjectKeyIdentifier'><type><string/></type></variable> </docgroup> <docgroup homogen-name='extensions' homogen-type='variable'><doc><group><note/><text>optional </text></group><group><note/><text>Read only </text></group></doc> - <variable name='extensions'><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></indextype><valuetype><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></valuetype></mapping></type></variable> + <variable name='extensions'><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></indextype><valuetype><object resolved='predef::Object'>Object</object></valuetype></mapping></type></variable> </docgroup> <docgroup homogen-name='hash' homogen-type='variable'><doc><text>Algorithm hash if known and supported. Otherwise <ref resolved='predef::.UNDEFINED'>UNDEFINED</ref>. </text><group><note/><text>Read only </text></group></doc> <variable name='hash'><type><object resolved='predef::Crypto.Hash'>Crypto.Hash</object></type></variable> </docgroup> <docgroup homogen-name='Sequence' homogen-type='inherit'> <inherit name='Sequence'><classname resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</classname></inherit> </docgroup> <docgroup homogen-name='init' homogen-type='method'><doc><text>Populates the object from a certificate decoded into an ASN.1 Object. Returns the object on success, otherwise <expr>0</expr>. You probably want to call <ref resolved='predef::Standards.X509.decode_certificate'>decode_certificate</ref> or even <ref resolved='predef::Standards.X509.verify_certificate'>verify_certificate</ref>. </text></doc> <method name='init'> - <arguments><argument name='asn1'><type><or><array/><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></or></type></argument></arguments> + <arguments><argument name='asn1'><type><or><array/><object resolved='predef::Object'>Object</object></or></type></argument></arguments> <returntype><object resolved='predef::Standards.X509.TBSCertificate'>this_program</object></returntype> </method> </docgroup> <docgroup homogen-name='internal_critical' homogen-type='variable'><doc><group><note/><text>optional </text></group></doc> <variable name='internal_critical'><modifiers><protected/></modifiers><type><multiset/></type></variable> </docgroup> <docgroup homogen-name='internal_extensions' homogen-type='variable'><doc><group><note/><text>optional </text></group></doc> - <variable name='internal_extensions'><modifiers><protected/></modifiers><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></indextype><valuetype><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></valuetype></mapping></type></variable> + <variable name='internal_extensions'><modifiers><protected/></modifiers><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></indextype><valuetype><object resolved='predef::Object'>Object</object></valuetype></mapping></type></variable> </docgroup> <docgroup homogen-name='issuer' homogen-type='variable'><doc><text>Certificate issuer. </text></doc> <variable name='issuer'><type><void/></type></variable> </docgroup> <docgroup homogen-name='issuer_id' homogen-type='variable'><doc><group><note/><text>optional </text></group></doc> <variable name='issuer_id'><type><void/></type></variable> </docgroup> <docgroup homogen-name='issuer_str' homogen-type='method'><doc><text>Return the issuer of the certificate as a human readable string.

autodoc.git / autodoc.xml