You are browsing upcoming documentation for version 5.1 of OroCommerce, OroCRM, and OroPlatform, scheduled for release in March 2023. Read version 5.0 (the latest LTS version) of the Oro documentation to get up-to-date information.
See our Release Process documentation for more information on the currently supported and upcoming releases.
WebSockets is a full-duplex communication protocol for real-time messaging between a server and clients through persistent connections.
The main aim of WebSockets is to provide real-time notifications for clients about server events or changes without a need for the client to repeat requests to the server for new information. For example:
- When someone changed the document, which another user was in the progress of editing. In this case, a notification informing that someone is working with this document, or that the document has been modified is immensely helpful.
- Real-time charts of stock prices or currency exchange rates on financial portals. The accuracy and timeliness of this type of data are crucial for visitors of the portal, and manual refreshment of the page can be very exhausting.
- Real-time instant messaging on the website. Users must receive messages without refreshing the chat page, and so on.
In Oro applications, WebSocket communications are built using Web Application Message Protocol (WAMP), a WebSocket subprotocol aimed at organizing the communication between program components in the applications with a loosely coupled architecture.
The main two parts of WAMP protocol are Remote Procedure Call (RPC) mechanism and PubSub messaging pattern.
RPC mechanism allows calling a function from a different code remotely via a WebSocket.
PubSub messaging pattern implies that when messages are published to topics by publishers (or, in other words, “channels”), the broker distributes them to clients that are subscribed to these topics.
Therefore, the WAMP protocol implies that there is a WebSocket server that plays the role of message broker; there are ways for the application components to register topics for messages, publish messages to topics, and subscribe to topic messages.
In Oro applications, all WebSocket-related functionality is provided by OroSyncBundle. As OroSyncBundle is part of OroPlatform, which is the base for all Oro applications, the WebSocket functionality exists in all Oro applications.
WebSocket functionality exists only in the Oro application admin UI which guarantees authentication of all clients who subscribe to the topic messages.
You need to Setup and Configure websocket functionality before you can start using it in Oro applications.
Out-of-the-box, OroSyncBundle uses WebSocket connection for two purposes:
- Content outdated notifications — To provide flash notifications for the user informing about outdated content, if several users try to edit the same entity record simultaneously.
- Maintenance mode notifications — To send flash notifications to all application site visitors once a developer turns on the system maintenance mode by a console’s CLI tool.
To start using websocket messages for your custom functionality, refer to the following articles: