summaryrefslogtreecommitdiffstats
path: root/modules/websocket/doc_classes
Commit message (Collapse)AuthorAgeFilesLines
* [WebSocket] Ensure TCP_NODELAY is always setFabio Alessandrelli2024-07-221-1/+1
| | | | | | | | | | | Almost all WebSocket implementations (including all major browsers) disable Nagle's algorithm to favor low latency over packet overhead. This was also the case in Godot 3.x, while in Godot 4.0 this was only being done for clients and wasn't even always working due to a bug. This commit fixes the aforementioned bug, and forces TCP_NODELAY when accepting a stream as a server.
* Doctool: Remove version attribute from XML headerRémi Verschelde2023-07-062-2/+2
| | | | | | 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-052-2/+2
| | | | Keep on waitin'
* Validate code tags in documentation for potential paramsYuri Sizov2023-04-262-2/+2
| | | | | | | 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.
* Fix typos and inconsistencies in classrefHaoyu Qiu2023-03-161-1/+1
|
* Bump version to 4.1-devRémi Verschelde2023-03-012-2/+2
| | | | Can't stop, won't stop, they said, huh?
* Document unsupported features in Mobile and Compatibility rendering methodsHugo Locurcio2023-02-131-1/+1
|
* [NET] Refactor TLS configuration.Fabio Alessandrelli2023-01-282-9/+6
| | | | | | | | | | | | | 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`.
* [MP] Add MultiplayerPeer disconnect_peer, close.Fabio Alessandrelli2022-10-281-16/+0
| | | | | Update ENet, WebRTC, and WebSocket to support peer disconnection and unify the close function.
* [WebSocket] Refactor websocket module.Fabio Alessandrelli2022-10-114-257/+191
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* [Net] Rename "ssl" references to "tls" in methods and members.Fabio Alessandrelli2022-09-082-11/+11
|
* [Web] Rename JavaScript platform to Web.Fabio Alessandrelli2022-08-294-10/+10
| | | | Also rename export name from "HTML5" to "Web".
* Rename the argument tag to param in XML documentationYuri Sizov2022-08-084-39/+39
|
* Added set_extra_headers() to WebSocketServerOğuzhan Eroğlu2022-04-121-0/+7
|
* Add an XML schema for documentationHugo Locurcio2022-02-154-4/+4
| | | | | | | | 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 usage of "Return" in the docskobewi2022-01-021-2/+2
|
* Fix small typos regarding WebSocketPeerInfinixius2021-10-061-1/+1
|
* Merge pull request #52481 from Faless/net/4.x_native_peersFabio Alessandrelli2021-09-281-4/+0
|\ | | | | [Net] Extension system for network peers, webrtc.
| * [Net/Docs] Update extensions documentation.Fabio Alessandrelli2021-09-241-4/+0
| |
* | Document Android permission requirements for network access where neededHugo Locurcio2021-09-253-0/+3
|/
* Don't generate empty doc sections and reduce code duplicationAaron Franke2021-09-203-6/+0
|
* Multiplayer networking renames/simplificationMax Hilbrunner2021-09-083-4/+4
| | | | Removes _networking_ prefix from some methods and members, now that multiplayer has been largely moved out of Node and SceneTree and is seperated into its own set of classes.
* [Net] Move multiplayer to core subdir, split RPCManager.Fabio Alessandrelli2021-09-071-1/+1
| | | | | | | | | | | Move multiplayer classes to "core/multiplayer" subdir. Move the RPCConfig and enums (TransferMode, RPCMode) to a separate file (multiplayer.h), and bind them to the global namespace. Move the RPC handling code to its own class (RPCManager). Renames "get_rpc_sender_id" to "get_remote_sender_id".
* 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-304-118/+59
|/ | | | | | | | 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.
* Expose the resource name the client used to the websocket serverMeriipu2021-07-171-1/+4
| | | | | | | This information is exposed to the websocket server through the client_connected-signal. example.com/chat?id=10 gives the resource name "/chat?id=10"
* [Net] Rename NetworkedMultiplayerPeer to MultiplayerPeer.Fabio Alessandrelli2021-07-123-4/+4
|
* [Net] Add WebSocketServer handshake_timeout property.Fabio Alessandrelli2021-06-281-0/+3
| | | | | | | Allows customization of the maximum time a client is allowed to stay in the the "pending" state (i.e. awaiting HTTP handshake). This used to be 1 second by before, the new default is 3 seconds.
* Better format arguments in variant parserMichael Alexsander Silva Dias2021-06-182-3/+3
|
* Document secure wss:// caveats for WebSocketClientHugo Locurcio2021-04-071-0/+1
| | | | See https://github.com/godotengine/godot/issues/37739.
* doc: Sync classref with current sourceRémi Verschelde2020-02-182-3/+3
| | | | Handle removal of Pool*Array types and other recent changes.
* Update docs to version 4.0clayjohn2020-01-314-4/+4
|
* 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-264-4/+4
| | | | | | | | | | 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`.
* Validate input in (CPU)Particles set_emission_shape()Rémi Verschelde2020-01-161-1/+1
| | | | | | Fixes #29777. Co-authored-by: Cameron Reikes <cameronreikes@gmail.com>
* Prevent GDScript language server from listening to external hosts by defaultHoukime2020-01-151-0/+3
| | | | | | | | | | * Add bind_ip property to WebSocketServer defaulting to "*" (listen to everyone) * Set default for GDscript Language Server to listen only to localhost Fixes potential security issue with GDScript language server being exposed to the broad net by default. Since it is the server which primary usage is to provide utility to the local editor there is no need to expose it.
* Update documentation to reflect HTML5 limitations.Fabio Alessandrelli2020-01-142-2/+4
|
* doc: Sync classref with current sourceRémi Verschelde2019-10-111-2/+2
|
* Document all this new improvements.Fabio Alessandrelli2019-10-092-0/+31
|
* doc: Fix parsing of self-closing XML tagsRémi Verschelde2019-09-241-2/+2
| | | | | | | Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`.
* Run doctool after overridden properties changesBojidar Marinov2019-09-041-0/+4
|
* WebSocket module now uses wslay library.Fabio Alessandrelli2019-07-042-2/+2
| | | | | | | | | | Both client and server are supported on native builds (as usual). SSL server is still not supported, but will soon be possible with this new library. The API stays the same, we just need to work out potential issues due to this big library switch.
* Proofread and improve the whole class referenceHugo Locurcio2019-06-274-27/+33
| | | | | | | | | | | | | - 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: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinksRémi Verschelde2019-06-271-1/+1
|
* Expose WebSocket set_buffers and document it.Fabio Alessandrelli2019-06-151-0/+18
|
* doc: Drop unused <demos> tagRémi Verschelde2019-04-194-8/+0
|
* doc: Bump version to 3.2Rémi Verschelde2019-04-014-4/+4
|