autodoc.git / traditional.xml

version» Context lines:

autodoc.git/traditional.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2020-04-19' version='Pike v8.1.13'> + <manual time-stamp='2020-04-24' version='Pike v8.1.13'>    <dir name='./traditional_manual'>    <file name='./traditional_manual/index.html'>    <chapter title='Table of Contents' unnumbered='1'>    <dl><dt><url href='index.html'>Table of Contents</url></dt>   <dt><url href='chapter_1.html'>1. Introduction</url></dt>   <dd><url href='chapter_1.html#1.1'>1.1. Overview</url></dd>   <dd><url href='chapter_1.html#1.2'>1.2. The history of Pike</url></dd>   <dd><url href='chapter_1.html#1.3'>1.3. A comparison with other languages</url></dd>   <dd><url href='chapter_1.html#1.4'>1.4. What is Pike</url></dd>   <dd><url href='chapter_1.html#1.5'>1.5. Pike License</url></dd>
autodoc.git/traditional.xml:8625:   <returntype><object resolved='predef::Pike.Backend'>Pike.Backend</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='query_fd' homogen-type='method'><doc><text><p>Gets the file descriptor for this UDP port.</p>   </text></doc>   <method name='query_fd'>   <arguments/>   <returntype><int/></returntype>   </method>   </docgroup> + <docgroup homogen-name='query_mtu' homogen-type='method'><doc><text><p>Get the Max Transfer Unit for the object (if any).</p> + </text><group><returns/><text><int><group><value>-1</value><text><p>Returns <expr>-1</expr> if the object is not a socket or +  if the mtu is unknown.</p> + </text></group><group><value><minvalue>1</minvalue></value><text><p>Returns a positive value with the mtu on success.</p> + </text></group></int></text></group></doc> + <method name='query_mtu'> + <arguments/> + <returntype><int/></returntype> + </method> + </docgroup>   <docgroup homogen-name='read' homogen-type='method'><doc><text><p>Read from the UDP socket.</p>   <p> Flag <ref resolved='predef::Stdio.UDP.read.flag'>flag</ref> is a bitfield, 1 for out of band data and 2 for peek</p>   </text><group><returns/><text><p>mapping(string:int|string) in the form    ([    "data" : string received data    "ip" : string received from this ip    "port" : int ...and this port    ])</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Stdio.UDP.set_read_callback'>set_read_callback()</ref>, <ref resolved='predef::Stdio.UDP.MSG_OOB'>MSG_OOB</ref>, <ref resolved='predef::Stdio.UDP.MSG_PEEK'>MSG_PEEK</ref></p>   </text></group></doc>
autodoc.git/traditional.xml:11871:   <returntype><object resolved='predef::Pike.Backend'>Pike.Backend</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='query_fd' homogen-type='method'><doc><text><p>Returns the file descriptor number associated with this object.</p>   </text></doc>   <method name='query_fd'>   <arguments/>   <returntype><int/></returntype>   </method>   </docgroup> + <docgroup homogen-name='query_mtu' homogen-type='method'><doc><text><p>Get the Max Transfer Unit for the object (if any).</p> + </text><group><returns/><text><int><group><value>-1</value><text><p>Returns <expr>-1</expr> if the object is not a socket or +  if the mtu is unknown.</p> + </text></group><group><value><minvalue>1</minvalue></value><text><p>Returns a positive value with the mtu on success.</p> + </text></group></int></text></group></doc> + <method name='query_mtu'> + <arguments/> + <returntype><int/></returntype> + </method> + </docgroup>   <docgroup homogen-name='read' homogen-type='method'><doc><text><p>Read data from a file or a stream.</p>   <p> Attempts to read <ref resolved='predef::Stdio.Fd.read.len'>len</ref> bytes from the file, and return it as a    string. Less than <ref resolved='predef::Stdio.Fd.read.len'>len</ref> bytes can be returned if:</p>   <ul><group><item/><text><p>end-of-file is encountered for a normal file, or</p>   </text></group><group><item/><text><p>it's a stream that has been closed from the other end, or</p>   </text></group><group><item/><text><p>it's a stream in nonblocking mode, or</p>   </text></group><group><item/><text><p>it's a stream and <ref resolved='predef::Stdio.Fd.read.not_all'>not_all</ref> is set, or</p>   </text></group><group><item/><text><p><ref resolved='predef::Stdio.Fd.read.not_all'>not_all</ref> isn't set and an error occurred (see below).</p>   </text></group></ul><p>If <ref resolved='predef::Stdio.Fd.read.not_all'>not_all</ref> is nonzero, <ref resolved='predef::Stdio.Fd.read'>read()</ref> does not try its best to read    as many bytes as you have asked for, but merely returns as much as
autodoc.git/traditional.xml:35893:   </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 name='HandshakeFragment'> + <modifiers><private/></modifiers> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='mt'><type><int/></type></argument><argument name='len'><type><int/></type></argument><argument name='offset'><type><int/></type></argument><argument name='data'><type><string><min>0</min><max>255</max></string></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-type='variable'> + <variable name='mt'><type><int/></type></variable> + <variable name='len'><type><int/></type></variable> + <variable name='offset'><type><int/></type></variable> + <variable name='data'><type><string><min>0</min><max>255</max></string></type></variable> + </docgroup>   </class> -  + </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>   </text></doc>