autodoc.git / modref.xml

version» Context lines:

autodoc.git/modref.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2017-12-15' version='Pike v8.1.11'> + <manual time-stamp='2017-12-18' version='Pike v8.1.11'>    <dir name='./ignored'>    <file name='./ignored/ignored'>    <chapter number='1' title='ignored'>    <autodoc>   <namespace name=''>   <doc><text><p>Symbols implicitly inherited from the virtual base class.</p>   <p> These symbols exist mainly to simplify implementation of    the corresponding lfuns.</p>   </text><group><seealso/><text><p><ref resolved='lfun::'>lfun::</ref></p>   </text></group></doc>
autodoc.git/modref.xml:1724:   <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='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='7.8::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/modref.xml:25999:   <constant name='default_stable_time'><modifiers><protected/></modifiers><type><int/></type></constant>   </docgroup>   <docgroup homogen-name='file_created' homogen-type='method'><doc><text><p>File creation callback.</p>   </text><group><param name='path'/><text><p>Path of the new file or directory.</p>   </text></group><group><param name='st'/><text><p>Status information for <ref resolved='predef::Filesystem.Monitor.basic.file_created.path'>path</ref> as obtained by <expr>file_stat(path, 1)</expr>.</p>   <p> This function is called when either a monitored path has started    existing, or when a new file or directory has been added to a    monitored directory.</p>   <p> Called by <ref resolved='predef::Filesystem.Monitor.basic.check'>check()</ref> and <ref resolved='predef::Filesystem.Monitor.basic.check_monitor'>check_monitor()</ref>.</p>   <p> Overload this to do something useful.</p> + </text></group><group><note/><text><p>This callback has similar semantics to <ref resolved='predef::Filesystem.Monitor.basic.file_exists'>file_exists()</ref>, but +  is called at run time.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Filesystem.Monitor.basic.file_exists'>file_exists()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.file_deleted'>file_deleted()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.stable_data_change'>stable_data_change()</ref></p>   </text></group></doc>   <method name='file_created'>   <arguments><argument name='path'><type><string/></type></argument><argument name='st'><type><object resolved='predef::Stdio.Stat'>Stdio.Stat</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='file_deleted' homogen-type='method'><doc><text><p>File deletion callback.</p>   </text><group><param name='path'/><text><p>Path of the new file or directory that has been deleted.</p>   <p> This function is called when either a monitored path has stopped    to exist, or when a file or directory has been deleted from a    monitored directory.</p>   <p> Called by <ref resolved='predef::Filesystem.Monitor.basic.check'>check()</ref> and <ref resolved='predef::Filesystem.Monitor.basic.check_monitor'>check_monitor()</ref>.</p>   <p> Overload this to do something useful.</p> -  + </text></group><group><seealso/><text><p><ref resolved='predef::Filesystem.Monitor.basic.file_created'>file_created()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.file_exists'>file_exists()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.stable_data_change'>stable_data_change()</ref></p>   </text></group></doc>   <method name='file_deleted'>   <arguments><argument name='path'><type><string/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='file_exists' homogen-type='method'><doc><text><p>File existance callback.</p>   </text><group><param name='path'/><text><p>Path of the file or directory.</p>   </text></group><group><param name='st'/><text><p>Status information for <ref resolved='predef::Filesystem.Monitor.basic.file_exists.path'>path</ref> as obtained by <expr>file_stat(path, 1)</expr>.</p>   <p> This function is called during initialization for all monitored paths,    and subpaths for monitored directories. It represents the initial state    for the monitor.</p> - </text></group><group><note/><text><p>For directories, <ref resolved='predef::Filesystem.Monitor.basic.file_created'>file_created()</ref> will be called for the subpaths + </text></group><group><note/><text><p>For directories, <ref resolved='predef::Filesystem.Monitor.basic.file_exists'>file_exists()</ref> will be called for the subpaths    before the call for the directory itself. This can be used to detect    when the initialization for a directory is finished.</p>   <p> Called by <ref resolved='predef::Filesystem.Monitor.basic.check'>check()</ref> and <ref resolved='predef::Filesystem.Monitor.basic.check_monitor'>check_monitor()</ref> the first time a monitored    path is checked (and only if it exists).</p>   <p> Overload this to do something useful.</p> -  + </text></group><group><note/><text><p>This callback has similar semantics to <ref resolved='predef::Filesystem.Monitor.basic.file_created'>file_created()</ref>, but +  is called at initialization time.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Filesystem.Monitor.basic.file_created'>file_created()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.file_deleted'>file_deleted()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.stable_data_change'>stable_data_change()</ref></p>   </text></group></doc>   <method name='file_exists'>   <arguments><argument name='path'><type><string/></type></argument><argument name='st'><type><object resolved='predef::Stdio.Stat'>Stdio.Stat</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='inotify_event' homogen-type='method'><doc><text><p>Event callback for Inotify.</p>
autodoc.git/modref.xml:26208:   </docgroup>   <docgroup homogen-name='stable_data_change' homogen-type='method'><doc><text><p>Stable change callback.</p>   </text><group><param name='path'/><text><p>Path of the file or directory that has stopped changing.</p>   </text></group><group><param name='st'/><text><p>Status information for <ref resolved='predef::Filesystem.Monitor.basic.stable_data_change.path'>path</ref> as obtained by <expr>file_stat(path, 1)</expr>.</p>   <p> This function is called when previous changes to <ref resolved='predef::Filesystem.Monitor.basic.stable_data_change.path'>path</ref> are    considered "stable".</p>   <p> "Stable" in this case means that there have been no detected    changes for at lease <ref>stable_time</ref> seconds.</p>   <p> Called by <ref resolved='predef::Filesystem.Monitor.basic.check'>check()</ref> and <ref resolved='predef::Filesystem.Monitor.basic.check_monitor'>check_monitor()</ref>.</p>   <p> Overload this to do something useful.</p> + </text></group><group><note/><text><p>This callback being called does not mean that the contents +  or inode has changed, just that they don't seem to change any +  more. In particular it is called for paths found during +  initialization after <ref>stable_time</ref> seconds have passed.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Filesystem.Monitor.basic.file_created'>file_created()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.file_exists'>file_exists()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.file_deleted'>file_deleted()</ref></p>   </text></group></doc>   <method name='stable_data_change'>   <arguments><argument name='path'><type><string/></type></argument><argument name='st'><type><object resolved='predef::Stdio.Stat'>Stdio.Stat</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <class name='DefaultMonitor'>   <doc><text><p>This symbol evaluates to the <ref resolved='predef::Filesystem.Monitor.basic.Monitor'>Monitor</ref> class used by    the default implementation of <ref resolved='predef::Filesystem.Monitor.basic.monitor_factory'>monitor_factory()</ref>.</p>   <p> It is currently one of the values <ref resolved='predef::Filesystem.Monitor.basic.Monitor'>Monitor</ref>, <ref resolved='predef::Filesystem.Monitor.basic.EventStreamMonitor'>EventStreamMonitor</ref>
autodoc.git/modref.xml:26252:   <modifiers><protected/></modifiers>   <doc><text><p>Monitoring information for a single filesystem path.</p>   </text><group><seealso/><text><p><ref resolved='predef::Filesystem.Monitor.basic.Monitor.monitor'>monitor()</ref></p>   </text></group></doc>   <docgroup homogen-name='attr_changed' homogen-type='method'><doc><text><p>File attribute or content changed callback.</p>   </text><group><param name='st'/><text><p>Status information for <ref resolved='predef::Filesystem.Monitor.basic.Monitor.attr_changed.path'>path</ref> as obtained by    <expr>file_stat(path, 1)</expr>.</p>   <p> This function is called when a change has been detected for an    attribute for a monitored file or directory.</p>   <p> Called by <ref resolved='predef::Filesystem.Monitor.basic.Monitor.check'>check()</ref> and <ref resolved='predef::Filesystem.Monitor.basic.check_monitor'>check_monitor()</ref>.</p> + <p> The default implementation calls <ref>global::attr_changed()</ref> or +  <ref>global::data_changed()</ref> depending on the state.</p>   </text></group><group><note/><text><p>If there is a <ref resolved='predef::Filesystem.Monitor.basic.data_changed'>data_changed()</ref> callback, it may supersede this    callback if the file content also has changed.</p>   </text></group></doc>   <method name='attr_changed'><modifiers><protected/></modifiers>   <arguments><argument name='path'><type><string/></type></argument><argument name='st'><type><object resolved='predef::Stdio.Stat'>Stdio.Stat</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='bump' homogen-type='method'><doc><text><p>Bump the monitor to an earlier scan time.</p>   </text><group><param name='flags'/><text><int><group><value>0</value><text><p>Don't recurse.</p>
autodoc.git/modref.xml:26322:   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='file_created' homogen-type='method'><doc><text><p>File creation callback.</p>   </text><group><param name='st'/><text><p>Status information for <ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_created.path'>path</ref> as obtained by    <expr>file_stat(path, 1)</expr>.</p>   <p> This function is called when either a monitored path has started    existing, or when a new file or directory has been added to a    monitored directory.</p>   <p> Called by <ref resolved='predef::Filesystem.Monitor.basic.Monitor.check'>check()</ref> and <ref resolved='predef::Filesystem.Monitor.basic.check_monitor'>check_monitor()</ref>.</p> + <p> The default implementation registers the path, and +  calls <ref>global::file_deleted()</ref>.</p> + </text></group><group><note/><text><p>This callback has similar semantics to <ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_exists'>file_exists()</ref>, but +  is called at run time.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_exists'>file_exists()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_deleted'>file_deleted()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.Monitor.stable_data_change'>stable_data_change()</ref></p>   </text></group></doc>   <method name='file_created'><modifiers><protected/></modifiers>   <arguments><argument name='path'><type><string/></type></argument><argument name='st'><type><object resolved='predef::Stdio.Stat'>Stdio.Stat</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='file_deleted' homogen-type='method'><doc><text><p>File deletion callback.</p>   </text><group><param name='path'/><text><p>Path of the new file or directory that has been deleted.</p>   </text></group><group><param name='old_st'/><text><p>Stat for the file prior to deletion (if known). Note that    this argument is not passed along to top level function.</p>   <p> This function is called when either a monitored path has stopped    to exist, or when a file or directory has been deleted from a    monitored directory.</p>   <p> Called by <ref resolved='predef::Filesystem.Monitor.basic.Monitor.check'>check()</ref> and <ref resolved='predef::Filesystem.Monitor.basic.check_monitor'>check_monitor()</ref>.</p> -  + <p> The default implementation unregisters the path, and +  calls <ref>global::file_deleted()</ref>.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_created'>file_created()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_exists'>file_exists()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.Monitor.stable_data_change'>stable_data_change()</ref></p>   </text></group></doc>   <method name='file_deleted'><modifiers><protected/></modifiers>   <arguments><argument name='path'><type><string/></type></argument><argument name='old_st'><type><or><object resolved='predef::Stdio.Stat'>Stdio.Stat</object><void/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='file_exists' homogen-type='method'><doc><text><p>File existance callback.</p>   </text><group><param name='st'/><text><p>Status information for <ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_exists.path'>path</ref> as obtained by    <expr>file_stat(path, 1)</expr>.</p>   <p> This function is called during initialization for all monitored paths,    and subpaths for monitored directories. It represents the initial state    for the monitor.</p>   </text></group><group><note/><text><p>For directories, <ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_created'>file_created()</ref> will be called for the subpaths    before the call for the directory itself. This can be used to detect    when the initialization for a directory is finished.</p>   <p> Called by <ref resolved='predef::Filesystem.Monitor.basic.Monitor.check'>check()</ref> and <ref resolved='predef::Filesystem.Monitor.basic.check_monitor'>check_monitor()</ref> the first time a monitored    path is checked (and only if it exists).</p> -  + <p> The default implementation registers the path, and +  calls <ref>global::file_exists()</ref>.</p> + </text></group><group><note/><text><p>This callback has similar semantics to <ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_created'>file_created()</ref>, but +  is called at initialization time.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_created'>file_created()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_deleted'>file_deleted()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.Monitor.stable_data_change'>stable_data_change()</ref></p>   </text></group></doc>   <method name='file_exists'><modifiers><protected/></modifiers>   <arguments><argument name='path'><type><string/></type></argument><argument name='st'><type><object resolved='predef::Stdio.Stat'>Stdio.Stat</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-type='variable'>   <variable name='path'><type><string/></type></variable>   <variable name='flags'><type><object resolved='predef::Filesystem.Monitor.basic.MonitorFlags'>MonitorFlags</object></type></variable>   <variable name='max_dir_check_interval'><type><int/></type></variable>
autodoc.git/modref.xml:26407:   </method>   </docgroup>   <docgroup homogen-name='stable_data_change' homogen-type='method'><doc><text><p>Stable change callback.</p>   </text><group><param name='st'/><text><p>Status information for <ref resolved='predef::Filesystem.Monitor.basic.Monitor.stable_data_change.path'>path</ref> as obtained by    <expr>file_stat(path, 1)</expr>.</p>   <p> This function is called when previous changes to <ref resolved='predef::Filesystem.Monitor.basic.Monitor.stable_data_change.path'>path</ref> are    considered "stable".</p>   <p> "Stable" in this case means that there have been no detected    changes for at lease <ref resolved='predef::Filesystem.Monitor.basic.Monitor.stable_time'>stable_time</ref> seconds.</p>   <p> Called by <ref resolved='predef::Filesystem.Monitor.basic.Monitor.check'>check()</ref> and <ref resolved='predef::Filesystem.Monitor.basic.check_monitor'>check_monitor()</ref>.</p> + <p> The default implementation calls <ref>global::stable_data_change()</ref>.</p> + </text></group><group><note/><text><p>This callback being called does not mean that the contents +  or inode has changed, just that they don't seem to change any +  more. In particular it is called for paths found during +  initialization after <ref resolved='predef::Filesystem.Monitor.basic.Monitor.stable_time'>stable_time</ref> seconds have passed.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_created'>file_created()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_exists'>file_exists()</ref>, <ref resolved='predef::Filesystem.Monitor.basic.Monitor.file_deleted'>file_deleted()</ref></p>   </text></group></doc>   <method name='stable_data_change'><modifiers><protected/></modifiers>   <arguments><argument name='path'><type><string/></type></argument><argument name='st'><type><object resolved='predef::Stdio.Stat'>Stdio.Stat</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='status_change' homogen-type='method'><doc><text><p>Called when the status has changed for an existing file.</p>   </text></doc>   <method name='status_change'><modifiers><protected/></modifiers>   <arguments><argument name='old_st'><type><object resolved='predef::Stdio.Stat'>Stdio.Stat</object></type></argument><argument name='st'><type><object resolved='predef::Stdio.Stat'>Stdio.Stat</object></type></argument><argument name='orig_flags'><type><int/></type></argument><argument name='flags'><type><int/></type></argument></arguments>