autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2020-04-17' version='Pike v8.1.13'> + <manual time-stamp='2020-04-19' version='Pike v8.1.13'>    <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:117770:   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='Constants' homogen-type='import'>   <import name='Constants'><classname resolved='predef::SSL.Constants'>.Constants</classname></import>   </docgroup>   <docgroup homogen-name='ke' homogen-type='variable'><doc><text><p>The active <ref resolved='predef::SSL.Cipher.KeyExchange'>Cipher.KeyExchange</ref> (if any).</p>   </text></doc>   <variable name='ke'><type><object resolved='predef::SSL.Cipher.KeyExchange'>.Cipher.KeyExchange</object></type></variable>   </docgroup> + <docgroup homogen-name='mark_seq_num' homogen-type='method'><doc><text><p>Mark seqence number <ref resolved='predef::SSL.Connection.mark_seq_num.num'>num</ref> as seen and accepted.</p> + <p> This will cause <ref resolved='predef::SSL.Connection.valid_seq_nump'>valid_seq_nump()</ref> to return <expr>0</expr> for it +  if it shows up again.</p> + </text></doc> + <method name='mark_seq_num'> + <arguments><argument name='num'><type><int/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup>   <docgroup homogen-name='new_cipher_states' homogen-type='method'><doc><text><p>Generate new pending cipher states.</p>   </text></doc>   <method name='new_cipher_states'>   <arguments/>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='query_write_queue_size' homogen-type='method'><doc><text><p>Returns the number of packets queued for writing.</p>   </text><group><returns/><text><p>Returns the number of times <ref resolved='predef::SSL.Connection.to_write'>to_write()</ref> can be called before    it stops returning non-empty strings.</p>
autodoc.git/onepage.xml:117830:   </text></doc>   <method name='send_streaming_data'>   <arguments><argument name='data'><type><string><min>0</min><max>255</max></string></type></argument></arguments>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='sent' homogen-type='variable'><doc><text><p>Number of application data bytes sent by us.</p>   </text></doc>   <variable name='sent'><type><int/></type></variable>   </docgroup> + <docgroup homogen-name='sequence_mask' homogen-type='variable'><doc><text><p>Bitmask representing sequence numbers for accepted +  received packets in the interval +  [<expr>next_seq_num-window_size</expr>..<expr>next_seq_num-2</expr>].</p> + </text><group><note/><text><p>The packet with seqence number <expr>next_seq_num-1</expr> is +  implicitly known to have been received.</p> + </text></group></doc> + <variable name='sequence_mask'><modifiers><private/></modifiers><type><int/></type></variable> + </docgroup>   <docgroup homogen-name='set_alert_callback' homogen-type='method'><doc><text><p>Called with alert object, sequence number of bad packet,    and raw data as arguments, if a bad packet is received.</p>   <p> Can be used to support a fallback redirect https-&gt;http.</p>   </text></doc>   <method name='set_alert_callback'>   <arguments><argument name='callback'><type><function><argtype><object resolved='predef::SSL.Connection.set_alert_callback'/></argtype><argtype><or><int/><object resolved='predef::SSL.Connection.set_alert_callback'/></or></argtype><argtype><string/></argtype><returntype><void/></returntype></function></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='shutdown' homogen-type='method'><doc><text><p>Remove cyclic references as best we can.</p>
autodoc.git/onepage.xml:117861:    written, 0 if there are no pending packets, 1 of the connection is    being closed politely, and -1 if the connection died unexpectedly.</p>   <p> This function is intended to be called from an i/o write callback.</p>   </text><group><seealso/><text><p><ref resolved='predef::SSL.Connection.query_write_queue_size'>query_write_queue_size()</ref>, <ref resolved='predef::SSL.Connection.send_streaming_data'>send_streaming_data()</ref>.</p>   </text></group></doc>   <method name='to_write'>   <arguments><argument name='output'><type><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object></type></argument></arguments>   <returntype><int><min>-1</min><max>2</max></int></returntype>   </method>   </docgroup> + <docgroup homogen-name='valid_seq_nump' homogen-type='method'><doc><text><p>Check whether <ref resolved='predef::SSL.Connection.valid_seq_nump.num'>num</ref> is a valid seqence number for a new packet.</p> + </text></doc> + <method name='valid_seq_nump'> + <arguments><argument name='num'><type><int/></type></argument></arguments> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='window_size' homogen-type='constant'><doc><text><p>Number of passed sequence numbers to keep track of. +  <rfc>4347:4.1.2.5</rfc>: +  A minimum window size of 32 MUST be supported, but a window size +  of 64 is preferred and SHOULD be employed as the default. Another +  window size (larger than the minimum) MAY be chosen by the receiver.</p> + </text></doc> + <constant name='window_size'><modifiers><private/></modifiers><type><int/></type></constant> + </docgroup>   </class>   <module name='Constants'>   <doc><text><p>Protocol constants</p>   </text></doc>   <docgroup homogen-name='AUTHLEVEL_ask' homogen-type='constant'><doc><text><p>As a server, request a certificate, but don't require a response.    This AUTHLEVEL is not relevant for clients.</p>   </text></doc>   <constant name='AUTHLEVEL_ask'><type><int/></type></constant>   </docgroup>   <docgroup homogen-name='AUTHLEVEL_none' homogen-type='constant'><doc><text><p>Don't request nor check any certificate.</p>
autodoc.git/onepage.xml:119145:   </text><group><seealso/><text><p><ref resolved='predef::Standards.X509.get_algorithms'>Standards.X509.get_algorithms()</ref></p>   </text></group></doc>   <variable name='verifier_algorithms'><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Standards.ASN1.Types.Identifier</object></indextype><valuetype><object resolved='predef::Crypto.Hash'>Crypto.Hash</object></valuetype></mapping></type></variable>   </docgroup>   <docgroup homogen-name='verify_certificates' homogen-type='variable'><doc><text><p>Determines whether certificates presented by the peer are    verified, or just accepted as being valid.</p>   </text><group><deprecated><name><ref resolved='predef::SSL.Context.auth_level'>auth_level</ref></name></deprecated></group></doc>   <variable name='verify_certificates'><type><int/></type></variable>   </docgroup>   </class> - <class name='DTLSState'> - <doc><text><p>This state object contains the additional state needed by DTLS.</p> - </text></doc> - <docgroup homogen-name='' homogen-type='import'> - <import name=''><classname resolved='predef::'>predef::</classname></import> - </docgroup> - <docgroup homogen-name='State' homogen-type='inherit'> - <inherit name='State'><classname resolved='predef::SSL.State'>.State</classname></inherit> - </docgroup> - <docgroup homogen-name='mark_seq_num' homogen-type='method'><doc><text><p>Mark seqence number <ref resolved='predef::SSL.DTLSState.mark_seq_num.num'>num</ref> as seen and accepted.</p> - <p> This will cause <ref resolved='predef::SSL.DTLSState.valid_seq_nump'>valid_seq_nump()</ref> to return <expr>0</expr> for it -  if it shows up again.</p> - </text></doc> - <method name='mark_seq_num'> - <arguments><argument name='num'><type><int/></type></argument></arguments> - <returntype><void/></returntype> - </method> - </docgroup> - <docgroup homogen-name='sequence_mask' homogen-type='variable'><doc><text><p>Bitmask representing sequence numbers for accepted -  received packets in the interval -  [<expr>next_seq_num-window_size</expr>..<expr>next_seq_num-2</expr>].</p> - </text><group><note/><text><p>The packet with seqence number <expr>next_seq_num-1</expr> is -  implicitly known to have been received.</p> - </text></group></doc> - <variable name='sequence_mask'><type><int/></type></variable> - </docgroup> - <docgroup homogen-name='valid_seq_nump' homogen-type='method'><doc><text><p>Check whether <ref resolved='predef::SSL.DTLSState.valid_seq_nump.num'>num</ref> is a valid seqence number for a new packet.</p> - </text></doc> - <method name='valid_seq_nump'> - <arguments><argument name='num'><type><int/></type></argument></arguments> - <returntype><int/></returntype> - </method> - </docgroup> - <docgroup homogen-name='window_size' homogen-type='constant'><doc><text><p>Number of passed sequence numbers to keep track of. -  <rfc>4347:4.1.2.5</rfc>: -  A minimum window size of 32 MUST be supported, but a window size -  of 64 is preferred and SHOULD be employed as the default. Another -  window size (larger than the minimum) MAY be chosen by the receiver.</p> - </text></doc> - <constant name='window_size'><modifiers><private/></modifiers><type><int/></type></constant> - </docgroup> - </class> +    <class name='File'>   <doc><text><p>Interface similar to <ref resolved='predef::Stdio.File'>Stdio.File</ref>.</p>   <ul><group><item/><text><p>Handles blocking and nonblocking mode.</p>   </text></group><group><item/><text><p>Handles callback mode in an arbitrary backend (also in blocking mode).</p>   </text></group><group><item/><text><p>Read and write operations may each do both reading and    writing. In callback mode that means that installing either a    read or a write callback may install both internally.</p>   </text></group><group><item/><text><p>In Pike 8.0 and later, blocking read and write in concurrent threads    is supported.</p>   </text></group><group><item/><text><p>Callback changing operations like <ref resolved='predef::SSL.File.set_blocking'>set_blocking</ref> and