autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2017-06-25' version='Pike v8.1.9'> + <manual time-stamp='2017-06-26' version='Pike v8.1.9'>    <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:2593:   </docgroup>   </class>   <class name='DES3'>   <docgroup homogen-name='CBC' homogen-type='inherit'>   <inherit name='CBC'><classname resolved='8.0::Crypto.CBC'>Crypto.CBC</classname></inherit>   </docgroup>   </class>   <class name='DHKeyExchange'>   <doc><text><p>Implements Diffie-Hellman key-exchange.</p>   <p> The following key exchange methods are implemented here: -  <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p> +  <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p>   </text></doc>   <docgroup homogen-name='create' homogen-type='method'>   <method name='create'><modifiers><protected/></modifiers>   <arguments><argument name='p'><type><object resolved='7.8::SSL.Cipher.DHParameters'>DHParameters</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='DHParameters'>   <doc><text><p>Diffie-Hellman parameters.</p>
autodoc.git/onepage.xml:3210:   <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='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='predef::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/onepage.xml:3377:   <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='7.8::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='predef::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/onepage.xml:129884:   <p> This module is designed for use in asynchronous, or backend mode. That    is, rather than polling for changes, a function you specify will be    called when events of interest occur.</p>   </text><group><note/><text><p>This module requires the presence and use of a CFRunLoop based Backend    object, otherwise this module will not receive events from the OS.    CFRunLoop based backends are avilable on Mac OS X 10.5 and higher.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Pike.PollDeviceBackend.enable_core_foundation'>Pike.PollDeviceBackend.enable_core_foundation</ref></p>   </text></group></doc>   <inherit name='_FSEvents'><classname>System._FSEvents</classname></inherit>   </docgroup> - <class name='BlockingEventStream'> - <doc><text><p>A variation of <ref resolved='predef::System.FSEvents.EventStream'>EventStream</ref> that provides a blocking interface.</p> - </text><group><note/><text><p>A quirk of the underlying IO subsystem in CoreFoundation is that -  there is exactly one runloop per thread. Because FSEvents uses -  CoreFoundation, this means that there's no meaningful way to -  specify which backend should process these events. Therefore, -  always make sure that the thread you create the EventStream -  object is the same one you read events from, otherwise -  <ref resolved='predef::System.FSEvents.BlockingEventStream.read_event'>read_event</ref> will run not run the EventLoop that this -  EventStream is registered with, resulting in events never being -  delivered.</p> - </text></group></doc> - <docgroup homogen-name='create' homogen-type='method'> - <method name='create'><modifiers><protected/></modifiers> - <arguments><argument name='paths'><type><array><valuetype><string/></valuetype></array></type></argument><argument name='latency'><type><float/></type></argument><argument name='since_when'><type><or><int/><void/></or></type></argument><argument name='flags'><type><or><int/><void/></or></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='EventStream' homogen-type='inherit'> - <inherit name='EventStream'><classname resolved='predef::System.FSEvents.EventStream'>.EventStream</classname></inherit> - </docgroup> - <docgroup homogen-name='read_event' homogen-type='method'><doc><text><p>wait for an event to be received, and return it.</p> - </text><group><param name='timeout'/><text><p>an optional limit to the amount of time we're willing to wait</p> - </text></group></doc> - <method name='read_event'> - <arguments><argument name='timeout'><type><or><void/><float/></or></type></argument></arguments> - <returntype><mixed/></returntype> - </method> - </docgroup> - </class> - <class name='EventStream'> - <docgroup homogen-name='add_path' homogen-type='method'><doc><text><p>Add a path to the monitor list.</p> - </text><group><param name='path'/></group><group><note/><text><p>this can only be called when the monitor is stopped.</p> - </text></group></doc> - <method name='add_path'> - <arguments><argument name='path'><type><string/></type></argument></arguments> - <returntype><void/></returntype> - </method> - </docgroup> - <docgroup homogen-name='create' homogen-type='method'><doc><text><p>Creates a new Public.System.FSEvents.EventStream object</p> - </text><group><param name='paths'/><text><p>An array with each element containing a path to a directory, signifying the root of a -  filesystem hierarchy to be watched for modifications.</p> - <p> Additional paths may be added later using <ref resolved='predef::System.FSEvents.EventStream.add_path'>add_path()</ref>, though only if the stream is stopped.</p> - </text></group><group><param name='latency'/><text><p>The number of seconds the service should wait after hearing about an event from the kernel -  before passing it along to the client via its callback. Specifying a larger value may -  result in more effective temporal coalescing, resulting in fewer callbacks and greater -  overall efficiency.</p> - </text></group><group><param name='since_when'/><text><p>The service will supply events that have happened after the given event ID. To ask for events -  "since now" pass the constant kFSEventStreamEventIdSinceNow. Do not pass zero for this value -  unless you want to receive events for the requested directories "since the beginning of time".</p> - </text></group><group><param name='flags'/><text><p>Flags that modify the behavior of the stream being created. See Apple's FSEvents documentation -  for details of the various flags available.</p> - </text></group></doc> - <method name='create'> - <arguments><argument name='paths'><type><array><valuetype><string/></valuetype></array></type></argument><argument name='latency'><type><float/></type></argument><argument name='since_when'><type><or><int/><void/></or></type></argument><argument name='flags'><type><or><int/><void/></or></type></argument></arguments> - <returntype><void/></returntype> - </method> - </docgroup> - <docgroup homogen-name='flush_async' homogen-type='method'><doc><text><p>Requests that the FS Events service to flush out any events that have occurred but have not yet been -  delivered, due to the latency parameter that was supplied when the stream was created.</p> - <p> This flushing occurs asynchronously -- events most likely will not have been delivered -  by the time this call returns.</p> - </text><group><note/><text><p>Only call this function after the stream has been started, via start().</p> - </text></group></doc> - <method name='flush_async'> - <arguments/> - <returntype><void/></returntype> - </method> - </docgroup> - <docgroup homogen-name='flush_sync' homogen-type='method'><doc><text><p>Requests that the FS Events service to flush out any events that have occurred but have not yet been -  delivered, due to the latency parameter that was supplied when the stream was created.</p> - <p> Flushing synchronously when using this method; clients will have received all the callbacks by -  the time this call returns to them.</p> - </text><group><note/><text><p>Only call this function after the stream has been started, via start().</p> - </text></group></doc> - <method name='flush_sync'> - <arguments/> - <returntype><void/></returntype> - </method> - </docgroup> - <docgroup homogen-name='is_started' homogen-type='method'><doc><text><p>Has start() been called?</p> - </text></doc> - <method name='is_started'> - <arguments/> - <returntype><int/></returntype> - </method> - </docgroup> +    <docgroup homogen-name='kFSEventStreamCreateFlagFileEvents' homogen-type='constant'><doc><text><p>Available in MacOS X 10.7 and newer.</p>   </text></doc>   <constant name='kFSEventStreamCreateFlagFileEvents'/>   </docgroup>   <docgroup homogen-name='kFSEventStreamCreateFlagIgnoreSelf' homogen-type='constant'><doc><text><p>Available in MacOS X 10.6 and newer.</p>   </text></doc>   <constant name='kFSEventStreamCreateFlagIgnoreSelf'/>   </docgroup>   <docgroup homogen-name='kFSEventStreamCreateFlagNoDefer' homogen-type='constant'>   <constant name='kFSEventStreamCreateFlagNoDefer'/>
autodoc.git/onepage.xml:130065:   <docgroup homogen-name='kFSEventStreamEventFlagUserDropped' homogen-type='constant'>   <constant name='kFSEventStreamEventFlagUserDropped'/>   </docgroup>   <docgroup homogen-name='kFSEventStreamEventFlagXattrMod' homogen-type='constant'><doc><text><p>Available in MacOS X 10.7 and newer.</p>   </text></doc>   <constant name='kFSEventStreamEventFlagXattrMod'/>   </docgroup>   <docgroup homogen-name='kFSEventStreamEventIdSinceNow' homogen-type='constant'>   <constant name='kFSEventStreamEventIdSinceNow'/>   </docgroup> + <class name='BlockingEventStream'> + <doc><text><p>A variation of <ref resolved='predef::System.FSEvents.EventStream'>EventStream</ref> that provides a blocking interface.</p> + </text><group><note/><text><p>A quirk of the underlying IO subsystem in CoreFoundation is that +  there is exactly one runloop per thread. Because FSEvents uses +  CoreFoundation, this means that there's no meaningful way to +  specify which backend should process these events. Therefore, +  always make sure that the thread you create the EventStream +  object is the same one you read events from, otherwise +  <ref resolved='predef::System.FSEvents.BlockingEventStream.read_event'>read_event</ref> will run not run the EventLoop that this +  EventStream is registered with, resulting in events never being +  delivered.</p> + </text></group></doc> + <docgroup homogen-name='create' homogen-type='method'> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='paths'><type><array><valuetype><string/></valuetype></array></type></argument><argument name='latency'><type><float/></type></argument><argument name='since_when'><type><or><int/><void/></or></type></argument><argument name='flags'><type><or><int/><void/></or></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='EventStream' homogen-type='inherit'> + <inherit name='EventStream'><classname resolved='predef::System.FSEvents.EventStream'>.EventStream</classname></inherit> + </docgroup> + <docgroup homogen-name='read_event' homogen-type='method'><doc><text><p>wait for an event to be received, and return it.</p> + </text><group><param name='timeout'/><text><p>an optional limit to the amount of time we're willing to wait</p> + </text></group></doc> + <method name='read_event'> + <arguments><argument name='timeout'><type><or><void/><float/></or></type></argument></arguments> + <returntype><mixed/></returntype> + </method> + </docgroup> + </class> + <class name='EventStream'> + <docgroup homogen-name='add_path' homogen-type='method'><doc><text><p>Add a path to the monitor list.</p> + </text><group><param name='path'/></group><group><note/><text><p>this can only be called when the monitor is stopped.</p> + </text></group></doc> + <method name='add_path'> + <arguments><argument name='path'><type><string/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='create' homogen-type='method'><doc><text><p>Creates a new Public.System.FSEvents.EventStream object</p> + </text><group><param name='paths'/><text><p>An array with each element containing a path to a directory, signifying the root of a +  filesystem hierarchy to be watched for modifications.</p> + <p> Additional paths may be added later using <ref resolved='predef::System.FSEvents.EventStream.add_path'>add_path()</ref>, though only if the stream is stopped.</p> + </text></group><group><param name='latency'/><text><p>The number of seconds the service should wait after hearing about an event from the kernel +  before passing it along to the client via its callback. Specifying a larger value may +  result in more effective temporal coalescing, resulting in fewer callbacks and greater +  overall efficiency.</p> + </text></group><group><param name='since_when'/><text><p>The service will supply events that have happened after the given event ID. To ask for events +  "since now" pass the constant kFSEventStreamEventIdSinceNow. Do not pass zero for this value +  unless you want to receive events for the requested directories "since the beginning of time".</p> + </text></group><group><param name='flags'/><text><p>Flags that modify the behavior of the stream being created. See Apple's FSEvents documentation +  for details of the various flags available.</p> + </text></group></doc> + <method name='create'> + <arguments><argument name='paths'><type><array><valuetype><string/></valuetype></array></type></argument><argument name='latency'><type><float/></type></argument><argument name='since_when'><type><or><int/><void/></or></type></argument><argument name='flags'><type><or><int/><void/></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='flush_async' homogen-type='method'><doc><text><p>Requests that the FS Events service to flush out any events that have occurred but have not yet been +  delivered, due to the latency parameter that was supplied when the stream was created.</p> + <p> This flushing occurs asynchronously -- events most likely will not have been delivered +  by the time this call returns.</p> + </text><group><note/><text><p>Only call this function after the stream has been started, via start().</p> + </text></group></doc> + <method name='flush_async'> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='flush_sync' homogen-type='method'><doc><text><p>Requests that the FS Events service to flush out any events that have occurred but have not yet been +  delivered, due to the latency parameter that was supplied when the stream was created.</p> + <p> Flushing synchronously when using this method; clients will have received all the callbacks by +  the time this call returns to them.</p> + </text><group><note/><text><p>Only call this function after the stream has been started, via start().</p> + </text></group></doc> + <method name='flush_sync'> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='is_started' homogen-type='method'><doc><text><p>Has start() been called?</p> + </text></doc> + <method name='is_started'> + <arguments/> + <returntype><int/></returntype> + </method> + </docgroup>   <docgroup homogen-name='set_callback' homogen-type='method'><doc><text><p>Sets the function that will be called when a file notification event is received.</p>   <p> The method signature for the callback is:</p>   <p> void event_callback(string path, int flags, int event_id)</p>   </text></doc>   <method name='set_callback'>   <arguments><argument name='callback'><type><function/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='start' homogen-type='method'><doc><text><p>Requests that new events be delivered to this EventStream.</p>