This repository has been archived by the owner on Mar 1, 2024. It is now read-only.
Common library and Signalling Tester #473
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changed up how we handle expects and messages. Messages are now buffered until we call processMessages. This allows us better control over the timing of messages.
…onal arent reflected in the generated code.
Signed-off-by: mcottontensor <80377552+mcottontensor@users.noreply.github.com>
…eamingInfrastructure into signalling_tester
…eamingInfrastructure into signalling_tester
lukehb
reviewed
Jan 24, 2024
lukehb
suggested changes
Jan 24, 2024
|
I guess our main readme.md should also include an explanation for what is |
…se 5.5 now. Updating workflows and versions etc.
…tiple listeners for events rather than the map of callbacks. Added some extra documentation to some public facing stuff in Common. Some cleanup in surrounding areas.
lukehb
suggested changes
Jan 25, 2024
lukehb
approved these changes
Jan 28, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relevant components:
Problem statement:
There are a bunch of code in the front end library that can be useful for other users. Without a common library the other components need to copy/paste or implement their own etc.
Solution
A few common implementations are extracted into a standalone Common library. This allows implementers to link with this library and write their own frontend application.
Additionally a protobuf description for signalling messages has been added. This isn't being used by any of the existing functionality yet, but should be possible to bring this in in the future.
A new tool has also been added under SS_Test. This is the signalling protocol tester. This is a small test application which can test the validity of the signalling protocol between signalling server and streamers and peers.
This tool comes with a github action that will run on changes to several components and fail if anything in the protocol changes to break existing behaviour.
Documentation
The following classes and types and now in Pixel Streaming common...
This change means that imports will have to change. For example, importing Logger would change from:
import { Logger } from '../Logger/Logger';to
import { Logger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.4';WebSocketControllerhas now mostly moved intoSignallingProtocol. Most of the functionality has been moved into this new class but it is not a 1 to 1 change so some changes might be required when upgrading.Binding to the protocol message events in now done through the messageHandlers event emitter and its addListener method. Here is an example where we add a handler for when we receive the config message over the protocol:
Test Plan and Compatibility