autodoc.git / autodoc.xml

version» Context lines:

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><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/autodoc.xml:8897:   </method>   </docgroup>   <docgroup homogen-name='error' homogen-type='method'><doc><text><p>Throws an error. A more readable version of the code    <expr>throw( ({ sprintf(f, @args), backtrace() }) )</expr>.</p>   </text></doc>   <method name='error'>   <arguments><argument name='f'><type><object resolved='predef::.sprintf_format'>sprintf_format</object></type></argument><argument name='args'><type><varargs><object resolved='predef::.sprintf_args'>sprintf_args</object></varargs></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup> + <docgroup homogen-type='constant'><doc><text><p>Object recognition constants.</p> + </text></doc> + <constant name='is_gssapi_error'><type><int/></type></constant> + <constant name='error_type'><type><string/></type></constant> + </docgroup> + <docgroup homogen-type='constant'><doc><text><p>Object recognition constants.</p> + </text></doc> + <constant name='is_gssapi_missing_services_error'><type><int/></type></constant> + <constant name='error_type'><type><string/></type></constant> + </docgroup>   <docgroup homogen-name='exece' homogen-type='method'><doc><text><p>This function transforms the Pike process into a process running    the program specified in the argument <ref resolved='predef::exece.file'>file</ref> with the arguments <ref resolved='predef::exece.args'>args</ref>.</p>   <p> If the mapping <ref resolved='predef::exece.env'>env</ref> is present, it will completely replace all    environment variables before the new program is executed.</p>   </text><group><returns/><text><p>This function only returns if something went wrong during <tt>exece(2)</tt>,    and in that case it returns <expr>0</expr> (zero).</p>   </text></group><group><note/><text><p>The Pike driver _dies_ when this function is called. You must either    use <ref resolved='predef::fork'>fork()</ref> or <ref resolved='predef::Process.create_process'>Process.create_process()</ref> if you wish to execute a    program and still run the Pike runtime.</p>   <p> This function is not available on all platforms.</p>
autodoc.git/autodoc.xml:41554:   <doc><text><p>This is pike glue for GSS-API ver 2 as specified in <rfc>2743</rfc>.</p>   <p> GSS-API is used to authenticate users and servers, and optionally    also to encrypt communication between them. The API is generic and    can be used without any knowledge of the actual implementation of    these security services, which is typically provided by the    operating system.</p>   <p> The most common implementation at the time of writing is Kerberos,    which means that the main benefit of this API is to allow clients    and servers to authenticate each other using Kerberos, thereby    making single sign-on possible in a Kerberized environment.</p> - <p> All functions in this module that wraps GSS-API routines might throw -  <ref resolved='predef::GSSAPI.Error'>GSSAPI.Error</ref>, and by default they do for all such errors. Only in + <p> All functions in this module that wrap GSS-API routines may throw +  <ref resolved='predef::GSSAPI.Error'>GSSAPI.Error</ref>, and by default they do so for all such errors. Only in    some special cases do they return when a GSS-API error has happened, -  and that is noted in the documentation.</p> +  and this is then noted in the documentation.</p>   </text></doc>   <docgroup homogen-type='constant'><doc><text><p>Flags for indicating how a <ref resolved='predef::GSSAPI.Cred'>GSSAPI.Cred</ref> object may be used:</p>   <dl><group><item name='INITIATE'/><text><p>The credential can only be used to initiate security contexts    (i.e. using <ref resolved='predef::GSSAPI.InitContext'>GSSAPI.InitContext</ref>).</p>   </text></group><group><item name='ACCEPT'/><text><p>The credential can only be used to accept security contexts    (i.e. using <ref resolved='predef::GSSAPI.AcceptContext'>GSSAPI.AcceptContext</ref>).</p>   </text></group><group><item name='BOTH'/><text><p>The credential may be used both to initiate or accept security    contexts.</p>   </text></group></dl></text></doc>   <constant name='INITIATE'><type><int/></type></constant>
autodoc.git/autodoc.xml:42379:    <ref resolved='predef::GSSAPI.Error.major_status'>major_status</ref> and/or <ref resolved='predef::GSSAPI.Error.minor_status'>minor_status</ref>. <expr>": "</expr> is inserted    in between.</p>   </text></group><group><param name='backtrace'/><text><p>Backtrace. The current backtrace for the calling function is    used if left out.</p>   </text></group></doc>   <method name='create'><modifiers><protected/></modifiers>   <arguments><argument name='major'><type><or><void/><int/></or></type></argument><argument name='minor'><type><or><void/><int/></or></type></argument><argument name='mech'><type><or><void/><string/></or></type></argument><argument name='message'><type><or><void/><string/></or></type></argument><argument name='backtrace'><type><or><void/><array/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup> - <docgroup homogen-type='constant'><doc><text><p>Object recognition constants.</p> - </text></doc> - <constant name='is_gssapi_error'><type><int/></type></constant> - <constant name='error_type'><type><string/></type></constant> + <docgroup homogen-name='Generic' homogen-type='inherit'> + <inherit name='Generic'><classname resolved='predef::Error.Generic'>Error.Generic</classname></inherit>   </docgroup> - <docgroup homogen-name='Error.Generic' homogen-type='inherit'> - <inherit name='Error.Generic'><classname resolved='predef::Error.Generic'>Error.Generic</classname></inherit> - </docgroup> +    <docgroup homogen-name='major_status' homogen-type='variable'><doc><text><p>The major status code. This is a bitwise OR of one routine error    code and zero or more supplementary error info bits.</p>   <p> See <rfc>2743:1.2.1.1</rfc> and <rfc>2744:3.9.1</rfc>. Note that the    calling errors mentioned in <rfc>2744</rfc> are never thrown.</p>   </text><group><seealso/><text><p><ref resolved='predef::GSSAPI.Error.major_status_messages'>major_status_messages</ref></p>   </text></group></doc>   <variable name='major_status'><type><int/></type></variable>   </docgroup>   <docgroup homogen-name='major_status_messages' homogen-type='method'><doc><text><p>Returns an array containing messages for all the status values in    <ref resolved='predef::GSSAPI.Error.major_status'>major_status</ref>. See <ref resolved='predef::GSSAPI.major_status_messages'>GSSAPI.major_status_messages</ref> for further
autodoc.git/autodoc.xml:42519:   <doc><text><p>Error object used when one or more required services are missing    in a <ref resolved='predef::GSSAPI.Context'>GSSAPI.Context</ref> object.</p>   </text></doc>   <docgroup homogen-name='create' homogen-type='method'><doc><group><param name='missing_services'/><text><p>Initial value for <ref resolved='predef::GSSAPI.MissingServicesError.services'>services</ref>.</p>   </text></group></doc>   <method name='create'><modifiers><protected/></modifiers>   <arguments><argument name='missing_services'><type><or><void/><int/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup> - <docgroup homogen-type='constant'><doc><text><p>Object recognition constants.</p> - </text></doc> - <constant name='is_gssapi_missing_services_error'><type><int/></type></constant> - <constant name='error_type'><type><string/></type></constant> + <docgroup homogen-name='Generic' homogen-type='inherit'> + <inherit name='Generic'><classname resolved='predef::Error.Generic'>Error.Generic</classname></inherit>   </docgroup> - <docgroup homogen-name='Error.Generic' homogen-type='inherit'> - <inherit name='Error.Generic'><classname resolved='predef::Error.Generic'>Error.Generic</classname></inherit> - </docgroup> +    <docgroup homogen-name='services' homogen-type='variable'><doc><text><p>Bitfield of <tt>GSSAPI.*_FLAG</tt> flags for the missing services    that caused the error.</p>   </text><group><seealso/><text><p><ref resolved='predef::GSSAPI.describe_services'>GSSAPI.describe_services</ref></p>   </text></group></doc>   <variable name='services'><type><int/></type></variable>   </docgroup>   </class>   <class name='Name'>   <doc><text><p>An object of this class contains a name on the internal form which    is required by the GSS-API functions. See <rfc>2743:1.1.5</rfc>.</p>