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='2017-
10
-
31
' version='Pike v8.0.507'>
+
<manual time-stamp='2017-
11
-
01
' version='Pike v8.0.507'>
<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:3176:
<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/modref.xml:10480:
by overlying functions.</p> </text><group><seealso/><text><p><ref>catch</ref></p> </text></group></doc> <method name='throw'> <arguments><argument name='value'><type><mixed/></type></argument></arguments> <returntype><or><mixed/><void/></or></returntype> </method> </docgroup> <docgroup homogen-name='time' homogen-type='method'><doc><text><p>This function returns the number of seconds since 00:00:00 UTC, 1 Jan 1970.</p> <p> The second syntax does not query the system for the current
-
time
.
Instead
the
latest
done
by the pike process is returned
-
again.
That's
slightly faster but can be wildly inaccurate. Pike
+
time
,
instead
the
last
time
value used
by the pike process is returned
+
again.
It
avoids a system call, and thus is
slightly faster
,
+
but can be wildly inaccurate. Pike
queries the time internally when a thread has waited for something, typically in <ref resolved='predef::sleep'>sleep</ref> or in a backend (see <ref resolved='predef::Pike.Backend'>Pike.Backend</ref>).</p>
-
<p> The third syntax can be used to measure time more
preciely
than one
-
second. It
return
how many seconds
has
passed since <ref resolved='predef::time.t'>t</ref>. The precision
+
<p> The third syntax can be used to measure time more
precisely
than one
+
second. It
returns
how many seconds
have
passed since <ref resolved='predef::time.t'>t</ref>. The precision
of this function varies from system to system.</p> </text><group><seealso/><text><p><ref resolved='predef::ctime'>ctime()</ref>, <ref resolved='predef::localtime'>localtime()</ref>, <ref resolved='predef::mktime'>mktime()</ref>, <ref resolved='predef::gmtime'>gmtime()</ref>, <ref resolved='predef::System.gettimeofday'>System.gettimeofday</ref>, <ref resolved='predef::gethrtime'>gethrtime</ref></p> </text></group></doc> <method name='time'> <arguments/> <returntype><int/></returntype> </method> <method name='time'> <arguments><argument name='one'><type><int><min>1</min><max>1</max></int></type></argument></arguments>
autodoc.git/modref.xml:105718:
<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
.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><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
.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><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
autodoc.git/modref.xml:130484:
public keys must be set.</p> </text></group><group><param name='name'/><text><p>The distinguished name for the certificate.</p> </text></group><group><param name='attributes'/><text><p>Attributes from PKCS #9 to add to the certificate.</p> </text></group><group><param name='hash'/><text><p>Hash algoritm to use for the CSR signature. Defaults to <ref resolved='predef::Crypto.SHA256'>Crypto.SHA256</ref>.</p> </text></group><group><note/><text><p>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>.</p> </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><p>Sign a <ref resolved='predef::Standards.PKCS.CSR.CRI'>CRI</ref> to generate a Certificate Signing Request.</p>
autodoc.git/modref.xml:130928:
<p>Setting</p> <p> The signature.</p> </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><p>Getting</p> <p> ASN.1 structure that has been signed.</p> <p>Setting</p> <p> ASN.1 structure that has been signed.</p> </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><p>A mapping between country TLDs and the name of the country.</p> </text></doc> <constant name='cc'/> </docgroup> <docgroup homogen-name='generic' homogen-type='variable'><doc><text><p>A multiset containing the generic TLDs, such as "com" and "info".</p>
autodoc.git/modref.xml:131436:
<method name='load_authorities'> <arguments><argument name='root_cert_dirs'><type><or><string/><array><valuetype><string/></valuetype></array><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><p>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.</p> </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><p>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>.</p> </text><group><param name='c'/><text><p>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.</p>
autodoc.git/modref.xml:131735:
<variable name='ext_keyUsage'><type><object>keyUsage</object></type></variable> </docgroup> <docgroup homogen-name='ext_subjectKeyIdentifier' homogen-type='variable'><doc><text><p>Set to the value of the SubjectKeyIdentifier if the certificate contains the subjectKeyIdentifier extension. RFC3280 4.2.1.2.</p> </text></doc> <variable name='ext_subjectKeyIdentifier'><type><string/></type></variable> </docgroup> <docgroup homogen-name='extensions' homogen-type='variable'><doc><group><note/><text><p>optional</p> </text></group><group><note/><text><p>Read only</p> </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='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><p>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>.</p> </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><p>optional</p> </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><p>optional</p> </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><p>Certificate issuer.</p> </text></doc> <variable name='issuer'><type><void/></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><void/></type></variable> </docgroup> <docgroup homogen-name='issuer_str' homogen-type='method'><doc><text><p>Return the issuer of the certificate as a human readable string.
autodoc.git/modref.xml:142744:
<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='predef::Tools.X509.make_time.t'>t</ref>.</p> </text></doc> <method name='make_time'> <arguments><argument name='t'><type><int/></type></argument></arguments> <returntype><attribute><prefix/><attribute>"deprecated"</attribute><subtype><object resolved='predef::Standards.ASN1.Types.UTC'>UTC</object></subtype></attribute></returntype> </method> </docgroup> <docgroup homogen-name='make_verifier' homogen-type='method'> <method name='make_verifier'>
-
<arguments><argument name='_keyinfo'><type><object resolved='predef::
Standards.ASN1.Types.
Object'>Object</object></type></argument></arguments>
+
<arguments><argument name='_keyinfo'><type><object resolved='predef::Object'>Object</object></type></argument></arguments>
<returntype><attribute><prefix/><attribute>"deprecated"</attribute><subtype><object>Verifier</object></subtype></attribute></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><attribute><prefix/><attribute>"deprecated"</attribute><subtype><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping></subtype></attribute></returntype> </method>
autodoc.git/modref.xml:142845:
</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='predef::Tools.X509.TBSCertificate'/></type></variable> </docgroup> <docgroup homogen-name='init' homogen-type='method'> <method name='init'>
-
<arguments><argument name='asn1'><type><object resolved='predef::
Standards.ASN1.Types.
Object'>Object</object></type></argument></arguments>
+
<arguments><argument name='asn1'><type><object resolved='predef::Object'>Object</object></type></argument></arguments>
<returntype><object resolved='predef::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>