Diff of autodoc.git/traditional_manual/chapter_21.html (20927729647c2d2e1496411608a571efa70abf63 » 4a0b9db1be9d5bce435ade162c31139e19da1a8e)

autodoc.git/traditional_manual/chapter_21.html:262: and thus does not affect the run-time. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>cpp::static_assert</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + __automap__ + </dt> + <dd><code><code class='datatype'>array</code> __automap__(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>fun</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Automap execution function. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>fun</code></dt> + <dd></dd><dd class='body--doc'>Function to call for each of the mapped arguments. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>args</code></dt> + <dd></dd><dd class='body--doc'>Arguments for <code>fun</code>. Either + <table class='box'><tr><td><code><code class='object unresolved'>Builtin.automap_marker</code></code></td><td>Wrapper for an array to loop over. All of the + arrays will be looped over in parallel. + </td></tr> + <tr><td><code><code class='datatype'>mixed</code></code></td><td>All other arguments will be held constant during + the automap, and sent as is to <code>fun</code>. + </td></tr> + </table> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function is used by the compiler to implement the + automap syntax, and should in normal circumstances never + be used directly. + It may however show up during module dumping and in + backtraces. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>It is an error not to have any <code>Builtin.automap_marker</code>s + in <code>args</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Builtin.automap_marker</code>, <code>map()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method __empty_program </dt> <dd><code><code class='datatype'>program</code> __empty_program(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>line</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>file</code>)</code></dd> </dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method __handle_sprintf_format
autodoc.git/traditional_manual/chapter_21.html:2458: <dt class='head--doc'>Description</dt> <dd class='body--doc'>Check if a path <code>p</code> is fully qualified (ie not relative). </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Returns 1 if the path is absolute, 0 otherwise. </dd></dl> <hr /> <dl class='group--doc'> + <dt class='head--type'>Constant + is_sql_null + </dt> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> <code class='constant'>is_sql_null</code></code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>SQL Null marker. + </dd> + <dt class='head--doc'>Deprecated</dt> + <dd class='body--doc'>Replaced by <code>is_val_null</code>. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Constant + is_val_null + </dt> + <dd><code><code class='datatype'>constant</code> <code class='datatype'>int</code> <code class='constant'>is_val_null</code></code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Nonzero recognition constant. + </dd></dl> + + + <hr /> + <dl class='group--doc'> <dt class='head--type'>Method kill </dt> <dd><code><code class='datatype'>bool</code> kill(<code class='datatype'>int</code> <code class='argument'>pid</code>, <code class='datatype'>int</code> <code class='argument'>signal</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Send a signal to another process. Some signals and their supposed purpose: <table class='box'><tr><td><code><code class='key'>SIGHUP</code></code></td><td>Hang-up, sent to process when user logs out. </td></tr>
autodoc.git/traditional_manual/chapter_21.html:4949: <hr /> <dl class='group--doc'> <dt class='head--type'>Constant false Constant true </dt> <dd><code><code class='datatype'>constant</code> <code class='constant'>false</code></code> <code><code class='datatype'>constant</code> <code class='constant'>true</code></code></dd> </dl> - </dd></dl><dl><dt><h2 class='header'>Class Bootstring</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This class implements the "Bootstring" string transcoder described in - <a href='ftp://ftp.rfc-editor.org/in-notes/rfc3492.txt'>ftp://ftp.rfc-editor.org/in-notes/rfc3492.txt</a>. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>Bootstring Bootstring(<code class='datatype'>int</code> <code class='argument'>base</code>, <code class='datatype'>int</code> <code class='argument'>tmin</code>, <code class='datatype'>int</code> <code class='argument'>tmax</code>, <code class='datatype'>int</code> <code class='argument'>skew</code>, <code class='datatype'>int</code> <code class='argument'>damp</code>, <code class='datatype'>int</code> <code class='argument'>initial_bias</code>, <code class='datatype'>int</code> <code class='argument'>initial_n</code>, <code class='datatype'>int</code> <code class='argument'>delim</code>, <code class='datatype'>string</code> <code class='argument'>digits</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Creates a Bootstring transcoder instance using the specified parameters. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>base</code></dt> - <dd></dd><dd class='body--doc'>The base used by the variable-length integers. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>tmin</code></dt> - <dd></dd><dd class='body--doc'>The minimum threshold digit value for the variable-length integers. - Must be >=0 and <= tmax. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>tmax</code></dt> - <dd></dd><dd class='body--doc'>The maximum threshold digit value for the variable-length integers. - Must be <= base-1. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>skew</code></dt> - <dd></dd><dd class='body--doc'>The skew term for the bias adapation. Must be >= 1. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>damp</code></dt> - <dd></dd><dd class='body--doc'>The damping factor for the bias adaption. Must be >= 2. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>initial_bias</code></dt> - <dd></dd><dd class='body--doc'>The initial bias for the variable-length integer thresholding. - initial_bias % base must be <= base - tmin. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>initial_n</code></dt> - <dd></dd><dd class='body--doc'>The first code point outside the "basic" set of code points. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>delim</code></dt> - <dd></dd><dd class='body--doc'>The "basic" code point used as the delimiter. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>digits</code></dt> - <dd></dd><dd class='body--doc'>The "basic" code points used as digits. The length of the string - should be the same as the base parameter. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - decode - </dt> - <dd><code><code class='datatype'>string</code> decode(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Decodes a Bootstring encoded string of "basic" code points back - to the original string space. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - encode - </dt> - <dd><code><code class='datatype'>string</code> encode(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Encodes a string using Bootstring encoding into a string constisting - only of "basic" code points (< initial_n). - </dd></dl> + </dd></dl><dl><dt><h2 class='header'>Class Codec</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'>An <code>Encoder</code> and a <code>Decoder</code> lumped into a single instance which can be used for both encoding and decoding. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Inherit
autodoc.git/traditional_manual/chapter_21.html:8889: <dd><code><code class='datatype'>string(8bit)</code> random_string(<code class='datatype'>int(0..)</code> <code class='argument'>len</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Return a string of random data from the system randomness pool. On POSIX platforms this reads random data from <tt>/dev/urandom</tt> on other platforms it may use other methods. </dd> <dt class='head--doc'>Throws</dt> <dd class='body--doc'>May throw errors on unexpected state. </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class Replace</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This is a "compiled" version of the <code>replace</code> function applied on - a string, with more than one replace string. The replace strings - are given to the create method as a from and to array - and are then analyzed. The <code class='expr'>`()</code> is then called with a - string and the replace rules in the Replace object will be - applied. The Replace object is used internally by the Pike - optimizer and need not be used manually. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - _decode - </dt> - <dd><code>Replace decode_value(string(8bit) data)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - _encode - </dt> - <dd><code>string(8bit) encode_value(Replace data)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - `() - </dt> - <dd><code><code class='datatype'>string</code> res = <code class='class'>Replace()</code>()</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>Replace Replace()</code> - <code>Replace Replace(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>))</code> - <code>Replace Replace(<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>from</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>string</code> <code class='argument'>to</code>)</code></dd> - </dl> + </dd></dl><dl><dt><h2 class='header'>Class Reporter</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'>API for reporting parse errors and similar. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method report
autodoc.git/traditional_manual/chapter_21.html:9016: Constant ERROR Constant FATAL </dt> <dd><code><code class='datatype'>constant</code> Reporter.<code class='constant'>NOTICE</code></code> <code><code class='datatype'>constant</code> Reporter.<code class='constant'>WARNING</code></code> <code><code class='datatype'>constant</code> Reporter.<code class='constant'>ERROR</code></code> <code><code class='datatype'>constant</code> Reporter.<code class='constant'>FATAL</code></code></dd> </dl> - </dd></dl></dd></dl><dl><dt><h2 class='header'>Class SingleReplace</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This is a "compiled" version of the <code>replace</code> function applied on - a string, with just one replace string. The replace strings are - given to the create method as a from and tom string and - are then analyzed. The <code class='expr'>`()</code> is then called with a string - and the replace rule in the Replace object will be applied. The - Replace object is used internally by the Pike optimizer and need - not be used manually. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - _decode - </dt> - <dd><code>SingleReplace decode_value(string(8bit) data)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - _encode - </dt> - <dd><code>string(8bit) encode_value(SingleReplace data)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - `() - </dt> - <dd><code><code class='datatype'>string</code> res = <code class='class'>SingleReplace()</code>()</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>SingleReplace SingleReplace(<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>from</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>to</code>)</code></dd> - - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>May be called with either zero or two arguments. - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class __dirnode</h2> + </dd></dl></dd></dl><dl><dt><h2 class='header'>Class __dirnode</h2> </dt><dd> <hr /> <dl class='group--doc'> <dt class='head--type'>Inherit dirnode </dt> <dd><code>inherit MasterObject.dirnode : dirnode</code></dd> </dl> </dd></dl><dl><dt><h2 class='header'>Class __joinnode</h2>
autodoc.git/traditional_manual/chapter_21.html:9855: ANY </dt> <dd><code>inherit .module.ANY : ANY</code></dd> </dl> </dd></dl></dd></dl></dd></dl><dl><dt><h2 class='header'>Module Builtin</h2> </dt><dd> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + _get_setter + </dt> + <dd><code><code class='datatype'>function</code>(<code class='object unresolved'>mixed_void</code>:<code class='datatype void'>void</code>) _get_setter(<code class='datatype'>object</code> <code class='argument'>o</code>, <code class='datatype'>string</code> <code class='argument'>varname</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Get a setter for the variable named <code>varname</code> in object <code>o</code>. + </dd> + <dt class='head--doc'>Returns</dt> + <dd class='body--doc'>Returns a <code>Setter()->`()()</code> for the variable if it exists, + and <code class='expr'>UNDEFINED</code> otherwise. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>object_variablep()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method _take_over_initial_predefines </dt> <dd><code><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>mixed</code>) _take_over_initial_predefines()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Returns a mapping containing the set of predefined macros. These are typically the macros defined via the <tt>-D</tt> option when starting Pike. This function is typically called by the <code>MasterObject</code> at initialization, and may only be called once. After it has been called, <code>cpp()</code> will start calling <code>CompilationHandler->get_predefines()</code> to retrieve the set of predefined macros. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'>[cpp()], <code>CompilationHandler->get_predefines()</code> </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Module Cache</h2> + <dl><dt><h2 class='header'>Class Builtin.Null</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - + <dd class='body--doc'>This class is used to implement the low-level aspects of <code>Val.Null</code>. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This class should typically not be used directly. Use + <code>Val.Null</code> instead. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This class was previously available as <code>Sql.Null</code>. Any such use + should be replaced with <code>Val.Null</code>. + </dd> + <dt class='head--doc'>Deprecated</dt> + <dd class='body--doc'>Replaced by <code>Val.Null</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Val.Null</code>, <code>Val.null</code> + </dd></dl> + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + encode_json + </dt> + <dd><code><code class='datatype'>string</code> encode_json()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Defined for use with <code>Standards.JSON.encode</code>, so that it + formats NULL as <code class='expr'>null</code>. + </dd></dl> + </dd></dl><dl><dt><h2 class='header'>Class Builtin.Setter</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Internal class for implementing setters. + This class is used by <code>_get_setter()</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>_get_setter()</code> + </dd></dl> + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + `() + </dt> + <dd><code><code class='datatype'>void</code> res = <code class='class'>Builtin.Setter()</code>()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Set the variable for the setter to <code>val</code>. + This is the function returned by <code>_get_setter()</code>. + </dd></dl> + </dd></dl><dl><dt><h2 class='header'>Class Builtin.automap_marker</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This is an internal class used by <code>__automap__()</code>. + It may show up during module dumping or in backtraces + and the like. + It should in normal circumstances never be used directly. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>__automap__()</code>, <code>map()</code> + </dd></dl> + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + create + </dt> + <dd><code>Builtin.automap_marker Builtin.automap_marker(<code class='datatype'>array</code> <code class='argument'>arr</code>, <code class='datatype'>int</code> <code class='argument'>depth</code>)</code></dd> + + <dt class='head--doc'>Parameter <code class='parameter'>arr</code></dt> + <dd></dd><dd class='body--doc'>Array that <code>__automap__()</code> is to loop over. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>depth</code></dt> + <dd></dd><dd class='body--doc'>Recursion depth of <code>arr</code> where the loop will be. + </dd></dl> + </dd></dl></dd></dl><dl><dt><h2 class='header'>Module Cache</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> <dd class='body--doc'>Common Caching implementation This module serves as a front-end to different kinds of caching systems. It uses two helper objects to actually store data, and to determine expiration policies. To create a new cache, do <code>Cache.cache</code>( <code>Cache.Storage.Base</code> storage_type, <code>Cache.Policy.Base</code> expiration_policy ) The cache store instances of <code>Cache.Data</code>. </dd></dl><dl><dt><h2 class='header'>Class Cache.Data</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Base stored object for the cache system.
autodoc.git/traditional_manual/chapter_21.html:32061: <hr /> <dl class='group--doc'> <dt class='head--type'>Method `[] </dt> <dd><code><code class='datatype'>mixed</code> res = <code class='class'>Pike.LiveBacktraceFrame()</code>[ <code class='class'>index</code> ]</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>The BacktraceFrame object can be indexed as an array. </dd></dl> + </dd></dl><dl><dt><h2 class='header'>Class Pike.MasterCodec</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This is a bare-bones codec that is used when loading a dumped master. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Codec</code> + </dd></dl> + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + decode_object + </dt> + <dd><code><code class='datatype'>object</code> decode_object(<code class='datatype'>object</code> <code class='argument'>obj</code>, <code class='datatype'>mixed</code> <code class='argument'>data</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Calls <code class='expr'>obj->_decode(<code>data</code>)</code>. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + functionof + </dt> + <dd><code><code class='datatype'>mixed</code> functionof(<code class='datatype'>mixed</code> <code class='argument'>symbol</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Look up a function in <code>all_constants()</code>. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + objectof + </dt> + <dd><code><code class='datatype'>mixed</code> objectof(<code class='datatype'>mixed</code> <code class='argument'>symbol</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Look up an object in <code>all_constants()</code>. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + programof + </dt> + <dd><code><code class='datatype'>mixed</code> programof(<code class='datatype'>mixed</code> <code class='argument'>symbol</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Look up a program in <code>all_constants()</code>. + </dd></dl> </dd></dl><dl><dt><h2 class='header'>Class Pike.PollBackend</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'><code>Backend</code> implemented with <tt>poll(2)</tt> (SVr4, POSIX). </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>Backend</code> </dd></dl> <hr />
autodoc.git/traditional_manual/chapter_21.html:40881: </dd></dl></dd></dl></dd></dl><dl><dt><h2 class='header'>Module Serializer</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Serialization interface. This module contains APIs to simplify serialization and deserialization of objects. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>serialize()</code>, <code>deserialize()</code> - </dd></dl><dl><dt><h2 class='header'>Class Serializer.Encodeable</h2> + </dd></dl> + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + deserialize + </dt> + <dd><code><code class='datatype'>void</code> deserialize(<code class='datatype'>object</code> <code class='argument'>o</code>, <code class='datatype'>function</code>(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>), <code class='datatype'>string</code>, <code class='type'>type</code>:<code class='datatype'>void</code>) <code class='argument'>deserializer</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Call <code>lfun::_deserialize()</code> in <code>o</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>serialize()</code>, <code>lfun::_deserialize()</code>, + <code>Serializable()->_deserialize()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + serialize + </dt> + <dd><code><code class='datatype'>void</code> serialize(<code class='datatype'>object</code> <code class='argument'>o</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>, <code class='type'>type</code>:<code class='datatype'>void</code>) <code class='argument'>serializer</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Call <code>lfun::_serialize()</code> in <code>o</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>deserialize()</code>, <code>lfun::_serialize()</code>, + <code>Serializable()->_serialize()</code> + </dd></dl> + <dl><dt><h2 class='header'>Class Serializer.Encodeable</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Simple base for an object that can be serialized by encode_value. Also supports decoding. Uses <code>Serializable</code> as it's base. Simply inherit this class in the classes you want to have encoded and decoded. Note that it's not automatically recursive, objects assigned to variables in this object have to be Encodeable on their own for encode to work.
autodoc.git/traditional_manual/chapter_21.html:40934: </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Inherit Serializable </dt> <dd><code>inherit Serializable : Serializable</code></dd> </dl> + </dd></dl><dl><dt><h2 class='header'>Class Serializer.Serializable</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>The base class for serializable objects. + Inherit this class in classes that need to be serializable. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Serializer.serialize()</code>, <code>Serializer.deserialize()</code> + </dd></dl> + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + _deserialize + </dt> + <dd><code><code class='modifier'>protected</code> <code class='datatype'>void</code> _deserialize(<code class='datatype'>object</code> <code class='argument'>o</code>, <code class='datatype'>function</code>(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>), <code class='datatype'>string</code>, <code class='type'>type</code>:<code class='datatype'>void</code>) <code class='argument'>deserializer</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Dispatch function for deserialization. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>o</code></dt> + <dd></dd><dd class='body--doc'>Object to serialize. Always a context of the current object. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>deserializer</code></dt> + <dd></dd><dd class='body--doc'>Function to typically be called once for every variable + in the inheriting class. + This function calls <code>_deserialize_variable()</code> once + for every variable in the inheriting class, which + in turn will call <code>deserializer</code> with the arguments: + <dl class='group--doc'><dt>Argument 1</dt> + <dd>The setter for the variable. + </dd> + <dt>Argument 2</dt> + <dd>The name of the variable. + </dd> + <dt>Argument 3</dt> + <dd>The declared type of the variable. + </dd> + </dl> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The symbols will be listed in the order they were defined + in the class. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function is typically called via <code>Serializer.deserialize()</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Serializer.deserialize()</code>, <code>_deserialize_variable()</code>, + <code>_serialize()</code>, <code>Builtin.Setter</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + _deserialize_variable + </dt> + <dd><code><code class='modifier'>protected</code> <code class='datatype'>void</code> _deserialize_variable(<code class='datatype'>function</code>(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>), <code class='datatype'>string</code>, <code class='type'>type</code>:<code class='datatype'>void</code>) <code class='argument'>deserializer</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>void</code>) <code class='argument'>setter</code>, <code class='datatype'>string</code> <code class='argument'>symbol</code>, <code class='type'>type</code> <code class='argument'>symbol_type</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Default deserialization function for variables. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>deserializer</code></dt> + <dd></dd><dd class='body--doc'>Function to be called in turn. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>setter</code></dt> + <dd></dd><dd class='body--doc'>Function that sets the value of the variable. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>symbol</code></dt> + <dd></dd><dd class='body--doc'>Variable name. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>symbol_type</code></dt> + <dd></dd><dd class='body--doc'>Type of the variable. + This function is typically called from <code>_deserialize()</code>, and does + something like: + <pre><code>if (object_typep(symbol_type)) { + program p = program_from_type(symbol_type); + if (p && !needs_parent(p) && is_deserializable(p)) { + object value = p(); + setter(value); + Serializer.deserialize(value, deserializer); + return; + } + } + deserializer(setter, symbol, symbol_type); + </code></pre> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The above takes care of the most common cases, but + <ul> + <li>Does not support anonymous object types. + </li><li>Does not support objects needing a parent. + </li><li>Does not support non-serializable objects. + </li><li>Selects one of the object types in case of a complex + <code>symbol_type</code>. The selected type is NOT deterministic + in case there are multiple choices that satisfy the above. + </li><li>Is likely to throw errors if <tt>p()</tt> requires arguments. + </li></ul>These issues can all be solved by overloading this function. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>_deserialize()</code>, <code>_serialize_variable()</code>, <code>Builtin.Setter</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + _serialize + </dt> + <dd><code><code class='modifier'>protected</code> <code class='datatype'>void</code> _serialize(<code class='datatype'>object</code> <code class='argument'>o</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>, <code class='type'>type</code>:<code class='datatype'>void</code>) <code class='argument'>serializer</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Dispatch function for serialization. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>o</code></dt> + <dd></dd><dd class='body--doc'>Object to serialize. Always a context of the current object. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>serializer</code></dt> + <dd></dd><dd class='body--doc'>Function to typically be called once for every variable + in the inheriting class. + This function calls <code>_serialize_variable()</code> once + for every variable in the inheriting class, which + in turn will call <code>serializer</code> with the arguments: + <dl class='group--doc'><dt>Argument 1</dt> + <dd>The value of the variable. + </dd> + <dt>Argument 2</dt> + <dd>The name of the variable. + </dd> + <dt>Argument 3</dt> + <dd>The declared type of the variable. + </dd> + </dl> + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>The symbols will be listed in the order they were defined + in the class. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This function is typically called via <code>Serializer.serialize()</code>. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>Serializer.serialize()</code>, <code>_serialize_variable()</code>, + <code>_deserialize()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + _serialize_variable + </dt> + <dd><code><code class='modifier'>protected</code> <code class='datatype'>void</code> _serialize_variable(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>, <code class='type'>type</code>:<code class='datatype'>void</code>) <code class='argument'>serializer</code>, <code class='datatype'>mixed</code> <code class='argument'>value</code>, <code class='datatype'>string</code> <code class='argument'>symbol</code>, <code class='type'>type</code> <code class='argument'>symbol_type</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Default serialization function for variables. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>serializer</code></dt> + <dd></dd><dd class='body--doc'>Function to be called in turn. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>value</code></dt> + <dd></dd><dd class='body--doc'>Value of the variable. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>symbol</code></dt> + <dd></dd><dd class='body--doc'>Variable name. + </dd> + <dt class='head--doc'>Parameter <code class='parameter'>symbol_type</code></dt> + <dd></dd><dd class='body--doc'>Type of the variable. + This function is typically called from <code>_serialize()</code>, and just does + <pre><code>serializer(value, symbol, symbol_type);</code></pre>It is provided for overloading for eg filtering or validation purposes. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>_serialize()</code>, <code>_deserialize_variable()</code> + </dd></dl> </dd></dl></dd></dl><dl><dt><h2 class='header'>Module Shuffler</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Module implementing sending to and from nonblocking streams and other sources. Most useful when implementing sending of data from strings, files and other sources to a network connection. The module also supports generic bandwidth throttling. Multiple <code>Shuffler</code> object can be created, each optionally with their own backend. This makes it easier to use more than one CPU for pure data
autodoc.git/traditional_manual/chapter_21.html:50590: <hr /> <dl class='group--doc'> <dt class='head--type'>Variable zone </dt> <dd><code><code class='datatype'>string</code> System.TM.zone</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>The timezone of this structure </dd></dl> + </dd></dl><dl><dt><h2 class='header'>Class System.Time</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>The current time as a structure containing a sec and a usec + member. + </dd></dl> + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + create + </dt> + <dd><code>System.Time System.Time(<code class='datatype'>int</code> <code class='argument'>fast</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>If <code>fast</code> is true, do not request a new time from the system, + instead use the global current time variable. + This will only work in callbacks, but can save significant amounts + of CPU. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Variable + sec + Variable + usec + </dt> + <dd><code><code class='datatype'>int</code> System.Time.sec</code> + <code><code class='datatype'>int</code> System.Time.usec</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>The number of seconds and microseconds since the epoch and the + last whole second, respectively. (See also <code>predef::time()</code>) + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Please note that these variables will continually update when + they are requested, there is no need to create new Time() + objects. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Variable + usec_full + </dt> + <dd><code><code class='datatype'>int</code> System.Time.usec_full</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>The number of microseconds since the epoch. Please note that + pike needs to have been compiled with bignum support for this + variable to contain sensible values. + </dd></dl> + </dd></dl><dl><dt><h2 class='header'>Class System.Timer</h2> + </dt><dd> + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + create + </dt> + <dd><code>System.Timer System.Timer(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>fast</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Create a new timer object. The timer keeps track of relative time + with sub-second precision. + If <code>fast</code> is specified, the timer will not do system calls to get + the current time but instead use the one maintained by pike. This + will result in faster but more or less inexact timekeeping. + The pike maintained time is only updated when a <code>Pike.Backend</code> + object stops waiting and starts executing code. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + get + </dt> + <dd><code><code class='datatype'>float</code> get()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return the time in seconds since the last time get was called. + The first time this method is called the time since the object + was created is returned instead. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + peek + </dt> + <dd><code><code class='datatype'>float</code> peek()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return the time in seconds since the last time <code>get</code> was called. + </dd></dl> </dd></dl><dl><dt><h2 class='header'>Module System.FSEvents</h2> </dt><dd> <hr /> <dl class='group--doc'> <dt class='head--type'>Method describe_event_flag </dt> <dd><code><code class='datatype'>string</code> describe_event_flag(<code class='datatype'>int</code> <code class='argument'>mask</code>)</code></dd>
autodoc.git/traditional_manual/chapter_21.html:68964: <dd></dd><dd class='body--doc'>The name of parameter. One of <code class='expr'>"sample_rate"</code>, <code class='expr'>"bit_rate"</code>, <code class='expr'>"channels"</code>. </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'>Returns 1 on success, 0 otherwise (parameter not known). </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>get_codec_params()</code> </dd></dl> </dd></dl></dd></dl><dl><dt><h2 class='header'>Module __builtin</h2> - </dt><dd><dl><dt><h2 class='header'>Module __builtin.Nettle</h2> + </dt><dd><dl><dt><h2 class='header'>Class __builtin.Stack</h2> + </dt><dd><dl class='group--doc'> + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This class implements a simple stack. Instead of adding and removing + elements to an array, and thus making it vary in size for every push + and pop operation, this stack tries to keep the stack size constant. + If however the stack risks to overflow, it will allocate double its + current size, i.e. pushing an element on an full 32 slot stack will + result in a 64 slot stack with 33 elements. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>This class is usually accessed as <code>ADT.LowLevelStack</code>. + </dd></dl> + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + _search + </dt> + <dd><code><code class='datatype'>int</code> search(__builtin.Stack from, <code class='datatype'>mixed</code> <code class='argument'>item</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Return the stack-depth to <code>item</code>. + This function makes it possible to use + eg <code>search()</code> and <code>has_value()</code> on the stack. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + _sizeof + </dt> + <dd><code><code class='datatype'>int</code> sizeof( __builtin.Stack arg )</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><code>sizeof</code> on a stack returns the number of entries + in the stack. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + _values + </dt> + <dd><code><code class='datatype'>array</code> values( __builtin.Stack arg )</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><code>values</code> on a stack returns all the entries in + the stack, in order. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + `+ + </dt> + <dd><code><code class='object unresolved'>this_program</code> res = <code class='class'>__builtin.Stack()</code> + <code class='class'>s</code></code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>A stack added with another stack yields a new + stack with all the elements from both stacks, + and the elements from the second stack at the + top of the new stack. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + create + </dt> + <dd><code>__builtin.Stack __builtin.Stack(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>initial_size</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>An initial stack size can be given when + a stack is cloned. The default value is + 32. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + pop + </dt> + <dd><code><code class='datatype'>mixed</code> pop(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>val</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Pops and returns entry <code>val</code> from the stack, counting + from the top. If no value is given the top element is + popped and returned. All popped entries are freed from + the stack. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>quick_pop()</code>, <code>pop_to()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + pop_to + </dt> + <dd><code><code class='datatype'>void</code> pop_to(<code class='datatype'>int</code> <code class='argument'>depth</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Pops entries from the stack until it reaches the specified depth. + The popped entries are not returned. + </dd> + <dt class='head--doc'>Throws</dt> + <dd class='body--doc'>Throws an error if there are fewer than <code>depth</code> elements + on the stack. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>pop()</code>, <code>quick_pop()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + push + </dt> + <dd><code><code class='datatype'>void</code> push(<code class='datatype'>mixed</code> <code class='argument'>val</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Push an element on the top of the stack. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + quick_pop + </dt> + <dd><code><code class='datatype'>void</code> quick_pop(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>val</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Pops <code>val</code> entries from the stack, or one entry + if no value is given. The popped entries are not + returned. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>pop()</code>, <code>pop_to()</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + reset + </dt> + <dd><code><code class='datatype'>void</code> reset(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>initial_size</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Empties the stack, resets the stack pointer + and shrinks the stack size to the given value + or 32 if none is given. + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><code>create</code> + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + set_stack + </dt> + <dd><code><code class='datatype'>void</code> set_stack(<code class='datatype'>array</code> <code class='argument'>stack</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Sets the stacks content to the provided array. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method + top + </dt> + <dd><code><code class='datatype'>mixed</code> top()</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Returns the top element from the stack, without + popping it. + </dd> + <dt class='head--doc'>Throws</dt> + <dd class='body--doc'>Throws an error if called on an empty stack. + </dd></dl> + </dd></dl><dl><dt><h2 class='header'>Module __builtin.Nettle</h2> </dt><dd><dl><dt><h2 class='header'>Class __builtin.Nettle.AE</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Base class for AE (Authenticated Encryption) algorithms. AE algorithms behave like a combination of a <code>Cipher</code> and a HMAC. Note that no actual AE algorithm is implemented in the base class. They are implemented in classes that inherit this class. </dd>

autodoc.git / traditional_manual / chapter_21.html