Diff of autodoc.git/modref.xml (516c477e750e45f3b780a20fd8ff492dc3de4e92 » 7944745e027a9332cb5ce2c2d3a7e393a6dca171)

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>Random cookies, sent and received with the hello-messages. </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>Whether this is the server end of the connection or not. </text></group><group><param name='ctx'/><text>The context for the connection. </text></group><group><param name='min_version'/><text>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>. + Defaults to <ref resolved='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>. </text></group><group><param name='max_version'/><text>Maximum version of SSL to support. Defaults to <ref resolved='7.8::SSL.Constants.PROTOCOL_minor'>Constants.PROTOCOL_minor</ref>. </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>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:1891: <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>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>. </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>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>Sets the compression method. Currently only <ref resolved='predef::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is supported. </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>Interface similar to <ref resolved='7.8::Stdio.File'>Stdio.File</ref>.
autodoc.git/modref.xml:15807: <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a new cache object. Required are a storage manager, and an expiration policy object. </text></doc> <method name='create'> <arguments><argument name='storage_mgr'><type><object resolved='predef::Cache.Storage.Base'>Cache.Storage.Base</object></type></argument><argument name='policy_mgr'><type><object resolved='predef::Cache.Policy.Base'>Cache.Policy.Base</object></type></argument><argument name='cleanup_cycle_delay'><type><or><void/><int/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='delete' homogen-type='method'><doc><text>Forcibly removes some key. If the 'hard' parameter is supplied and true, deleted objects will also - have their <ref>lfun::destroy</ref> method called upon removal by some + have their <ref resolved='lfun::_destruct'>lfun::_destruct</ref> method called upon removal by some backends (i.e. memory) </text></doc> <method name='delete'> <arguments><argument name='key'><type><string/></type></argument><argument name='hard'><type><or><void/><int><min>0</min><max>1</max></int></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup>
autodoc.git/modref.xml:24164: > random(s); _random() (1) Result: 0 > abs(s); `<(0) _sprintf(79, ([ ])) (2) Result: Debug.Subject > abs(class { inherit Debug.Subject; int `<(mixed ... args) { return 1; } }()); create() `-() - destroy() + _destruct() (3) Result: 0 > pow(s,2); `[]("pow") Attempt to call the NULL-value Unknown program: 0(2) </text></group></doc> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> </class> <class name='Tracer'> <doc><text>A class that when instatiated will turn on trace, and when it's destroyed will turn it off again. </text></doc> <docgroup homogen-name='create' homogen-type='method'><doc><text>Sets the level of debug trace to <ref resolved='predef::Debug.Tracer.create.level'>level</ref>. </text></doc> - <method name='create'> + <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='level'><type><int/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import> </docgroup> </class> <class name='Wrapper'> <doc><text>This wrapper can be placed around another object to get
autodoc.git/modref.xml:36752: <method name='create'> <arguments><argument name='args'><type><varargs><mixed/></varargs></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> </class> <class name='BaseTexture'> <doc><text>The texture base class. Using e.g. <ref resolved='predef::GLUE.Texture'>Texture</ref> might be more convenient. </text></doc> + <docgroup homogen-name='_destruct' homogen-type='method'><doc><text>Properly deallocates the texture. + </text></doc> + <method name='_destruct'><modifiers><protected/></modifiers> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> <docgroup homogen-name='_sizeof' homogen-type='method'><doc><text>Returns the size of memory allocated by the texture. </text></doc> <method name='_sizeof'> <arguments/> <returntype><int/></returntype> </method> </docgroup> <docgroup homogen-name='`>' homogen-type='method'><doc><text>Textures can be sorted according to texture id. </text></doc> <method name='`>'><modifiers><protected/></modifiers>
autodoc.git/modref.xml:36828: </text></group></doc> <method name='create_texture'> <arguments><argument name='imgs'><type><or><mapping/><void/></or></type></argument><argument name='flags'><type><or><int><min>0</min><max>3</max></int><void/></or></type></argument><argument name='width'><type><or><int/><void/></or></type></argument><argument name='height'><type><or><int/><void/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='debug' homogen-type='variable'><doc><text>A string to identify the texture. </text></doc> <variable name='debug'><type><string/></type></variable> </docgroup> - <docgroup homogen-name='destroy' homogen-type='method'><doc><text>Properly deallocates the texture. - </text></doc> - <method name='destroy'><modifiers><protected/></modifiers> - <arguments/> - <returntype><void/></returntype> - </method> - </docgroup> + <docgroup homogen-name='draw' homogen-type='method'><doc><text>Draw the texture at <ref resolved='predef::GLUE.BaseTexture.draw.x'>x</ref>,<ref resolved='predef::GLUE.BaseTexture.draw.y'>y</ref>,<ref resolved='predef::GLUE.BaseTexture.draw.z'>z</ref> with dimensions <ref resolved='predef::GLUE.BaseTexture.draw.w'>w</ref>*<ref resolved='predef::GLUE.BaseTexture.draw.h'>h</ref>. </text></doc> <method name='draw'> <arguments><argument name='x'><type><float/></type></argument><argument name='y'><type><float/></type></argument><argument name='z'><type><float/></type></argument><argument name='w'><type><float/></type></argument><argument name='h'><type><float/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='draw_region' homogen-type='method'><doc><text>Draw texture region <ref resolved='predef::GLUE.BaseTexture.draw_region.s0'>s0</ref>,<ref resolved='predef::GLUE.BaseTexture.draw_region.q0'>q0</ref> - <ref resolved='predef::GLUE.BaseTexture.draw_region.ss'>ss</ref>,<ref resolved='predef::GLUE.BaseTexture.draw_region.qs'>qs</ref> at <ref resolved='predef::GLUE.BaseTexture.draw_region.x'>x</ref>,<ref resolved='predef::GLUE.BaseTexture.draw_region.y'>y</ref>,<ref resolved='predef::GLUE.BaseTexture.draw_region.z'>z</ref> with dimensions <ref resolved='predef::GLUE.BaseTexture.draw_region.w'>w</ref>*<ref resolved='predef::GLUE.BaseTexture.draw_region.h'>h</ref>. </text></doc>
autodoc.git/modref.xml:37291: <returntype><void/></returntype> </method> </docgroup> </class> </class> <class name='List'> <doc><text>A display list abstraction. Automatically allocates a display list id upon creation and correctly deallocate it upon destruction. </text><group><seealso/><text><ref resolved='predef::GLUE.DynList'>DynList</ref> </text></group></doc> + <docgroup homogen-name='_destruct' homogen-type='method'><doc><text>Deletes this list and frees the list id from the id pool. + </text></doc> + <method name='_destruct'><modifiers><protected/></modifiers> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> <docgroup homogen-name='`>' homogen-type='method'><doc><text><ref resolved='predef::GLUE.List'>List</ref> objects can be sorted according to list id. </text><group><seealso/><text><ref resolved='predef::GLUE.List.get_id'>get_id</ref> </text></group></doc> <method name='`>'><modifiers><protected/></modifiers> <arguments><argument name='x'><type><mixed/></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> <docgroup homogen-name='begin' homogen-type='method'><doc><text>Start defining the list. If <ref resolved='predef::GLUE.List.begin.run'>run</ref> is provided, the list will be executed as it is compiled (<ref resolved='predef::GL.GL_COMPILE_AND_EXECUTE'>GL.GL_COMPILE_AND_EXECUTE</ref>).
autodoc.git/modref.xml:37337: </text><group><seealso/><text><ref resolved='predef::GLUE.List.call'>call</ref> </text></group><group><example/><text>List list = List() { // GL code }; </text></group></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='f'><type><or><void/><function/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> - <docgroup homogen-name='destroy' homogen-type='method'><doc><text>Deletes this list and frees the list id from the id pool. - </text></doc> - <method name='destroy'><modifiers><protected/></modifiers> - <arguments/> - <returntype><void/></returntype> - </method> - </docgroup> + <docgroup homogen-name='end' homogen-type='method'><doc><text>Finish the list definition. </text><group><seealso/><text><ref resolved='predef::GLUE.List.begin'>begin</ref>, <ref resolved='predef::GLUE.List.compile'>compile</ref> </text></group></doc> <method name='end'> <arguments/> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='get_id' homogen-type='method'><doc><text>Returns this lists' id. </text></doc>
autodoc.git/modref.xml:90816: </text><group><seealso/><text><ref resolved='predef::Nettle.Yarrow.create'>create</ref> </text></group></doc> <method name='update'> <arguments><argument name='data'><type><string><min>0</min><max>255</max></string></type></argument><argument name='source'><type><int/></type></argument><argument name='entropy'><type><int/></type></argument></arguments> <returntype><int><min>0</min><max>1</max></int></returntype> </method> </docgroup> </class> </module> <module name='Object'> - <docgroup homogen-type='constant'><doc><text>Flags passed to <ref>lfun::destroy</ref>. + <docgroup homogen-type='constant'><doc><text>Flags passed to <ref resolved='lfun::_destruct'>lfun::_destruct</ref>. </text><group><note/><text><ref resolved='predef::Object.DESTRUCT_EXPLICIT'>Object.DESTRUCT_EXPLICIT</ref> is <expr>0</expr> and <ref resolved='predef::Object.DESTRUCT_CLEANUP'>Object.DESTRUCT_CLEANUP</ref> is <expr>1</expr> for compatibility. </text></group></doc> <constant name='DESTRUCT_EXPLICIT'/> <constant name='DESTRUCT_NO_REFS'/> <constant name='DESTRUCT_GC'/> <constant name='DESTRUCT_CLEANUP'/> </docgroup> <docgroup homogen-name='' homogen-type='import'> <import name=''><classname resolved='predef::'>predef::</classname></import>
autodoc.git/modref.xml:92171: <variable name='lr_error'><type><int/></type></variable> </docgroup> <docgroup homogen-name='make_parser' homogen-type='method'><doc><text>Compiles the parser-specification given in the first argument. Named actions are taken from the object if available, otherwise left as is. </text><group><bugs/><text>Returns error-code in both GrammarParser.error and return_value->lr_error. </text></group></doc> <method name='make_parser'> <arguments><argument name='str'><type><string/></type></argument><argument name='m'><type><or><object resolved='predef::Parser.LR.GrammarParser.make_parser'/><void/></or></type></argument></arguments> - <returntype><object resolved='predef::Parser'>Parser</object></returntype> + <returntype><object resolved='predef::Parser.LR.Parser'>Parser</object></returntype> </method> </docgroup> <docgroup homogen-name='make_parser_from_file' homogen-type='method'><doc><text>Compiles the file specified in the first argument into an LR parser. </text><group><seealso/><text><ref resolved='predef::Parser.LR.GrammarParser.make_parser'>make_parser</ref> </text></group></doc> <method name='make_parser_from_file'> <arguments><argument name='fname'><type><string/></type></argument><argument name='m'><type><or><object resolved='predef::Parser.LR.GrammarParser.make_parser_from_file'/><void/></or></type></argument></arguments> - <returntype><or><int/><object resolved='predef::Parser'>Parser</object></or></returntype> + <returntype><or><int/><object resolved='predef::Parser.LR.Parser'>Parser</object></or></returntype> </method> </docgroup> </module> <class name='Parser'> <doc><text>This object implements an LALR(1) parser and compiler. Normal use of this object would be: <pre> set_error_handler {add_rule, set_priority, set_associativity}* set_symbol_to_string
autodoc.git/modref.xml:100273: to never save any kept-alive connections. (Might be good in a for instance totaly synchroneous script that keeps the backend thread busy and never will get call_outs.) Defaults to 10 seconds. </text></doc> <variable name='time_to_keep_unused_connections'><type><or><int/><float/></or></type></variable> </docgroup> <class name='Request'> <doc><text>Request </text></doc> + <docgroup homogen-name='_destruct' homogen-type='method'><doc><text><ref resolved='predef::Protocols.HTTP.Session.Request._destruct'>_destruct</ref> is called when an object is destructed. + </text></doc> + <method name='_destruct'><modifiers><protected/></modifiers> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> <docgroup homogen-name='con' homogen-type='variable'><doc><text>Raw connection object </text></doc> <variable name='con'><type><object resolved='predef::Protocols.HTTP.Query'>Query</object></type></variable> </docgroup> <docgroup homogen-name='cookie_encountered' homogen-type='variable'><doc><text>Cookie callback. When a request is performed, the result is checked for cookie changes and additions. If a cookie is encountered, this function is called. Default is to call <ref resolved='predef::Protocols.HTTP.Session.set_http_cookie'>set_http_cookie</ref> in the <ref resolved='predef::Protocols.HTTP.Session'>Session</ref> object. </text></doc> <variable name='cookie_encountered'><type><function><argtype><string/></argtype><argtype><object resolved='predef::Standards.URI'>Standards.URI</object></argtype><returntype><mixed/></returntype></function></type></variable> </docgroup> - <docgroup homogen-name='destroy' homogen-type='method'><doc><text><ref resolved='predef::Protocols.HTTP.Session.Request.destroy'>destroy</ref> is called when an object is destructed. - But since this clears the HTTP connection from the Request object, + <docgroup homogen-name='destroy' homogen-type='method'><doc><text>But since this clears the HTTP connection from the Request object, it can also be used to reuse a <ref resolved='predef::Protocols.HTTP.Session.Request'>Request</ref> object. </text></doc> <method name='destroy'> <arguments/> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='do_async' homogen-type='method'><doc><text>Start a request asyncroneously. It will perform in the background using callbacks (make sure the backend thread is free).
autodoc.git/modref.xml:111527: read or a write callback may install both internally. </text></group><group><item/><text>In Pike 8.0 and later, blocking read and write in concurrent threads is supported. </text></group><group><item/><text>Callback changing operations like <ref resolved='predef::SSL.File.set_blocking'>set_blocking</ref> and <ref resolved='predef::SSL.File.set_nonblocking'>set_nonblocking</ref> aren't atomic. </text></group><group><item/><text>Apart from the above, thread safety/atomicity characteristics are retained. </text></group><group><item/><text>Blocking characterstics are retained for all functions. </text></group><group><item/><text><ref resolved='predef::SSL.File.is_open'>is_open</ref>, connection init (<ref resolved='predef::SSL.File.create'>create</ref>) and close (<ref resolved='predef::SSL.File.close'>close</ref>) can do both reading and writing. - </text></group><group><item/><text><ref resolved='predef::SSL.File.destroy'>destroy</ref> attempts to close the stream properly by sending the + </text></group><group><item/><text><ref resolved='predef::SSL.File._destruct'>_destruct</ref> attempts to close the stream properly by sending the close packet, but since it can't do blocking I/O it's not certain that it will succeed. The stream should therefore always be closed with an explicit <ref resolved='predef::SSL.File.close'>close</ref> call. </text></group><group><item/><text>Abrupt remote close without the proper handshake gets the errno <ref>System.EPIPE</ref>. </text></group><group><item/><text>Objects do not contain cyclic references, so they are closed and destructed timely when dropped. </text></group></ul> </text></doc> - + <docgroup homogen-name='_destruct' homogen-type='method'><doc><text>Try to close down the connection properly since it's customary to + close files just by dropping them. No guarantee can be made that + the close packet gets sent successfully though, because we can't + risk blocking I/O here. You should call <ref resolved='predef::SSL.File.close'>close</ref> explicitly. + </text><group><seealso/><text><ref resolved='predef::SSL.File.close'>close</ref> + </text></group></doc> + <method name='_destruct'><modifiers><protected/></modifiers> + <arguments/> + <returntype><void/></returntype> + </method> + </docgroup> <docgroup homogen-name='accept' homogen-type='method'><doc><text>Configure as server and set up the connection. </text><group><param name='pending_data'/><text>Any data that has already been read from the stream. This is typically used with protocols that use START TLS or similar, where there's a risk that "too much" data (ie part of the TLS ClientHello) has been read from the stream before deciding that the connection is to enter TLS-mode. </text></group><group><returns/><text>Returns <expr>0</expr> on handshaking failure in blocking mode, and otherwise <expr>1</expr>. </text></group><group><seealso/><text><ref resolved='predef::SSL.File.connect'>connect()</ref>
autodoc.git/modref.xml:111623: connection is closed (see <ref resolved='predef::SSL.File.close'>close</ref> and <ref resolved='predef::SSL.File.shutdown'>shutdown</ref>). The callbacks and id in <ref resolved='predef::SSL.File.create.stream'>stream</ref> are overwritten. </text></group><group><note/><text>The operation mode defaults to nonblocking mode. </text></group><group><seealso/><text><ref resolved='predef::SSL.File.accept'>accept()</ref>, <ref resolved='predef::SSL.File.connect'>connect()</ref> </text></group></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='stream'><type><object resolved='predef::Stdio.File'>Stdio.File</object></type></argument><argument name='ctx'><type><object resolved='predef::SSL.Context'>SSL.Context</object></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> - <docgroup homogen-name='destroy' homogen-type='method'><doc><text>Try to close down the connection properly since it's customary to - close files just by dropping them. No guarantee can be made that - the close packet gets sent successfully though, because we can't - risk blocking I/O here. You should call <ref resolved='predef::SSL.File.close'>close</ref> explicitly. - </text><group><seealso/><text><ref resolved='predef::SSL.File.close'>close</ref> - </text></group></doc> - <method name='destroy'><modifiers><protected/></modifiers> - <arguments/> - <returntype><void/></returntype> - </method> - </docgroup> + <docgroup homogen-name='errno' homogen-type='method'><doc><group><returns/><text>Returns the current error number for the connection. Notable values are: <int><group><value>0</value><text>No error </text></group><group><value>System.EPIPE</value><text>Connection closed by other end. </text></group></int> </text></group></doc> <method name='errno'> <arguments/> <returntype><int/></returntype> </method>

autodoc.git / modref.xml