autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2017-09-25' version='Pike v8.1.11'> + <manual time-stamp='2017-09-29' version='Pike v8.1.11'>    <dir name='./onepage'>    <file name='./onepage/manual.html'>    <chapter number='1' title='Control Structures'>      <p>In this chapter all the control structures in Pike will be   explained. Control structures are used to control the flow of the   program execution. Note that functions that make the program pause and   simple function calls are not qualified as control structures.</p>      <section number='1' title='Conditions'>
autodoc.git/onepage.xml:3286:   <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='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='predef::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/onepage.xml:6817:   <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/onepage.xml:6918:   </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/onepage.xml:24630:   <docgroup homogen-name='jwa' homogen-type='method'><doc><text><p>Get the JWS algorithm identifier for a hash.</p>   </text><group><param name='hash'/><text><p>Hash algorithm; ignored for Ed25519.</p>   </text></group><group><returns/><text><p>Returns <expr>0</expr> (zero) on failure.</p>   </text></group><group><seealso/><text><p><rfc>7518:3.1</rfc></p>   </text></group></doc>   <method name='jwa'>   <arguments><argument name='hash'><type><or><object resolved='predef::Crypto.Hash'>.Hash</object><void/></or></type></argument></arguments>   <returntype><string><min>0</min><max>127</max></string></returntype>   </method>   </docgroup> + <docgroup homogen-name='jwk' homogen-type='method'><doc><text><p>Generate a JWK-style mapping of the object.</p> + </text><group><param name='private_key'/><text><p>If true, include the private key in the result.</p> + </text></group><group><returns/><text><p>Returns a JWK-style mapping on success, and <expr>0</expr> (zero) +  on failure.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::__builtin.Nettle.ECC_Curve.Point.create'>create()</ref>, <ref resolved='predef::Web.encode_jwk'>Web.encode_jwk()</ref>, <rfc>8037</rfc></p> + </text></group></doc> + <method name='jwk'> + <arguments><argument name='private_key'><type><or><int><min>0</min><max>1</max></int><void/></or></type></argument></arguments> + <returntype><mapping><indextype><string><min>0</min><max>127</max></string></indextype><valuetype><string><min>0</min><max>127</max></string></valuetype></mapping></returntype> + </method> + </docgroup>   <docgroup homogen-name='key_size' homogen-type='method'><doc><text><p>Return the size of the private key in bits.</p>   </text></doc>   <method name='key_size'>   <arguments/>   <returntype><int><min>0</min><max/></int></returntype>   </method>   </docgroup>   <docgroup homogen-name='pkcs_algorithm_identifier' homogen-type='method'><doc><text><p>Returns the AlgorithmIdentifier as defined in    <rfc>5480:2.1.1</rfc> including the EdDSA parameters.</p>   </text></doc>