summaryrefslogtreecommitdiffstats
path: root/modules/websocket/doc_classes/WebSocketPeer.xml
Commit message (Collapse)AuthorAgeFilesLines
* Doctool: Remove version attribute from XML headerRémi Verschelde2023-07-061-1/+1
| | | | | | We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
* Bump version to 4.2-devRémi Verschelde2023-07-051-1/+1
| | | | Keep on waitin'
* Validate code tags in documentation for potential paramsYuri Sizov2023-04-261-1/+1
| | | | | | | Adds a check to make_rst to look for matches between the text inside of the [code][/code] tag and known param identifiers. Fixes most of what was revealed.
* Bump version to 4.1-devRémi Verschelde2023-03-011-1/+1
| | | | Can't stop, won't stop, they said, huh?
* [NET] Refactor TLS configuration.Fabio Alessandrelli2023-01-281-3/+2
| | | | | | | | | | | | | Use a TLSOptions configuration object which is created via static functions. - "TLSOptions.client": uses the standard CA and common name verification. - "TLSOptions.client_unsafe": uses optional CA verification (i.e. if specified) - "TLSOptions.server": is the standard server configuration (chain + key) This will allow us to expand the TLS configuration options to include e.g. mutual authentication without bloating the classes that uses StreamPeerTLS and PacketPeerDTLS as underlying peers.
* Style: Misc docs and comment style and language fixesRémi Verschelde2022-11-021-1/+1
| | | | | | | | | | - Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
* [WebSocket] Refactor websocket module.Fabio Alessandrelli2022-10-111-18/+125
| | | | | | | | | | | | | | | | | | | | | | | | | | | This commit is a huge refactor of the websocket module. The module is really old, and some design choices had to be re-evaluated. The WebSocketClient and WebSocketServer classes are now gone, and WebSocketPeer can act as either client or server. The WebSocketMultiplayerPeer class is no longer abstract, and implements the Multiplayer API on top of the lower level WebSocketPeer. WebSocketPeer is now a "raw" peer, like StreamPeerTCP and StreamPeerTLS, so it emits no signal, and just needs polling to update its internal state. To use it as a client, simply call WebSocketPeer.coonect_to_url, then frequently poll the peer until STATE_OPEN is reached and then you can write or read from it, or STATE_CLOSED and then you can check the disconnect code and reason). To implement a server instead, a TCPServer must be created, and the accepted connections needs to be provided to WebSocketPeer.accept_stream (which will perform the HTTP handshake). A full example of a WebSocketServer using TLS will be provided in the demo repository.
* [Web] Rename JavaScript platform to Web.Fabio Alessandrelli2022-08-291-5/+5
| | | | Also rename export name from "HTML5" to "Web".
* Rename the argument tag to param in XML documentationYuri Sizov2022-08-081-4/+4
|
* Add an XML schema for documentationHugo Locurcio2022-02-151-1/+1
| | | | | | | | This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
* Fix small typos regarding WebSocketPeerInfinixius2021-10-061-1/+1
|
* Merge pull request #51036 from winterpixelgames/master-ws-fixRémi Verschelde2021-08-011-0/+6
|\ | | | | WebsocketPeer outbound buffer fixes and buffer size query
| * Websocket peer outbound buffer fixes. Expose outbound buffered amount.Jordan Schidlowsky2021-07-311-0/+6
| |
* | doc: Use self-closing tags for `return` and `argument`Rémi Verschelde2021-07-301-24/+12
|/ | | | | | | | For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
* Update docs to version 4.0clayjohn2020-01-311-1/+1
|
* Disable Nagle's algorithm for WebSocket TCP.Fabio Alessandrelli2020-01-281-0/+10
| | | | | | This should greatly decrease latency for the most common use cases. A new function WebSocketPeer::set_no_delay will allow to configure it if so desired.
* doc: Drop unused 'category' property from headerRémi Verschelde2020-01-261-1/+1
| | | | | | | | | | We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
* doc: Misc updates for AnimationNode* and othersRémi Verschelde2020-01-231-1/+1
| | | | | | | | | | | | | - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
* Proofread and improve the whole class referenceHugo Locurcio2019-06-271-8/+10
| | | | | | | | | | | | | - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
* doc: Drop unused <demos> tagRémi Verschelde2019-04-191-2/+0
|
* doc: Bump version to 3.2Rémi Verschelde2019-04-011-1/+1
|
* doc: Fix wrong references found by new makerst.pyRémi Verschelde2019-01-071-1/+1
| | | | Thanks @PJB3005
* Update WebSocket documentationFabio Alessandrelli2018-09-241-1/+7
|
* Document websocket module, further document enetFabio Alessandrelli2018-05-081-0/+75