@epicgames-ps/lib-pixelstreamingsignalling-ue5.8 0.1.0

package/docs/LoggingUtils/functions/logOutgoing.md

@@ -0,0 +1,30 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [LoggingUtils](../README.md) / logOutgoing
+
+# Function: logOutgoing()
+
+> **logOutgoing**(`sender`, `message`): `void`
+
+Defined in: [Signalling/src/LoggingUtils.ts:41](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/LoggingUtils.ts#L41)
+
+Call to log messages created here at the server and being sent to the connection.
+Do not call this for messages being forwarded to this connection.
+
+## Parameters
+
+### sender
+
+[`IMessageLogger`](../interfaces/IMessageLogger.md)
+
+IMessageLogger The connection the message is being sent to.
+
+### message
+
+`BaseMessage`
+
+## Returns
+
+`void`

package/docs/LoggingUtils/interfaces/IMessageLogger.md

@@ -0,0 +1,29 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [LoggingUtils](../README.md) / IMessageLogger
+
+# Interface: IMessageLogger
+
+Defined in: [Signalling/src/LoggingUtils.ts:17](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/LoggingUtils.ts#L17)
+
+Most methods in here rely on connections implementing this interface so we can identify
+who is sending or receiving etc.
+
+## Extended by
+
+- [`IPlayer`](../../PlayerRegistry/interfaces/IPlayer.md)
+- [`IStreamer`](../../StreamerRegistry/interfaces/IStreamer.md)
+
+## Methods
+
+### getReadableIdentifier()
+
+> **getReadableIdentifier**(): `string`
+
+Defined in: [Signalling/src/LoggingUtils.ts:18](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/LoggingUtils.ts#L18)
+
+#### Returns
+
+`string`

package/docs/LoggingUtils/interfaces/IProtoLogObj.md

@@ -0,0 +1,57 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [LoggingUtils](../README.md) / IProtoLogObj
+
+# Interface: IProtoLogObj
+
+Defined in: [Signalling/src/LoggingUtils.ts:4](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/LoggingUtils.ts#L4)
+
+## Properties
+
+### direction
+
+> **direction**: `string`
+
+Defined in: [Signalling/src/LoggingUtils.ts:6](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/LoggingUtils.ts#L6)
+
+***
+
+### event
+
+> **event**: `string`
+
+Defined in: [Signalling/src/LoggingUtils.ts:5](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/LoggingUtils.ts#L5)
+
+***
+
+### protoMessage
+
+> **protoMessage**: `BaseMessage`
+
+Defined in: [Signalling/src/LoggingUtils.ts:10](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/LoggingUtils.ts#L10)
+
+***
+
+### receiver?
+
+> `optional` **receiver**: `string`
+
+Defined in: [Signalling/src/LoggingUtils.ts:8](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/LoggingUtils.ts#L8)
+
+***
+
+### sender?
+
+> `optional` **sender**: `string`
+
+Defined in: [Signalling/src/LoggingUtils.ts:7](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/LoggingUtils.ts#L7)
+
+***
+
+### target?
+
+> `optional` **target**: `string`
+
+Defined in: [Signalling/src/LoggingUtils.ts:9](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/LoggingUtils.ts#L9)

package/docs/PlayerConnection/README.md

@@ -0,0 +1,11 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../README.md) / PlayerConnection
+
+# PlayerConnection
+
+## Classes
+
+- [PlayerConnection](classes/PlayerConnection.md)

package/docs/PlayerConnection/classes/PlayerConnection.md

@@ -0,0 +1,177 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../../README.md) / [PlayerConnection](../README.md) / PlayerConnection
+
+# Class: PlayerConnection
+
+Defined in: [Signalling/src/PlayerConnection.ts:27](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerConnection.ts#L27)
+
+A connection between the signalling server and a player connection.
+This is where messages expected to be handled by the player come in
+and where messages are sent to the player.
+
+Interesting internals:
+playerId: The unique id string of this player.
+transport: The ITransport where transport events can be subscribed to
+protocol: The SignallingProtocol where signalling messages can be
+subscribed to.
+
+## Implements
+
+- [`IPlayer`](../../PlayerRegistry/interfaces/IPlayer.md)
+- [`IMessageLogger`](../../LoggingUtils/interfaces/IMessageLogger.md)
+
+## Constructors
+
+### new PlayerConnection()
+
+> **new PlayerConnection**(`server`, `ws`, `remoteAddress`?): [`PlayerConnection`](PlayerConnection.md)
+
+Defined in: [Signalling/src/PlayerConnection.ts:50](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerConnection.ts#L50)
+
+Initializes a new connection with given and sane values. Adds listeners for the
+websocket close and error so it can react by unsubscribing and resetting itself.
+
+#### Parameters
+
+##### server
+
+[`SignallingServer`](../../SignallingServer/classes/SignallingServer.md)
+
+The signalling server object that spawned this player.
+
+##### ws
+
+`WebSocket`
+
+The websocket coupled to this player connection.
+
+##### remoteAddress?
+
+`string`
+
+The remote address of this connection. Only used as display.
+
+#### Returns
+
+[`PlayerConnection`](PlayerConnection.md)
+
+## Properties
+
+### playerId
+
+> **playerId**: `string`
+
+Defined in: [Signalling/src/PlayerConnection.ts:29](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerConnection.ts#L29)
+
+#### Implementation of
+
+[`IPlayer`](../../PlayerRegistry/interfaces/IPlayer.md).[`playerId`](../../PlayerRegistry/interfaces/IPlayer.md#playerid)
+
+***
+
+### protocol
+
+> **protocol**: `SignallingProtocol`
+
+Defined in: [Signalling/src/PlayerConnection.ts:33](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerConnection.ts#L33)
+
+#### Implementation of
+
+[`IPlayer`](../../PlayerRegistry/interfaces/IPlayer.md).[`protocol`](../../PlayerRegistry/interfaces/IPlayer.md#protocol)
+
+***
+
+### remoteAddress?
+
+> `optional` **remoteAddress**: `string`
+
+Defined in: [Signalling/src/PlayerConnection.ts:37](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerConnection.ts#L37)
+
+***
+
+### subscribedStreamer
+
+> **subscribedStreamer**: `null` \| [`IStreamer`](../../StreamerRegistry/interfaces/IStreamer.md)
+
+Defined in: [Signalling/src/PlayerConnection.ts:35](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerConnection.ts#L35)
+
+#### Implementation of
+
+[`IPlayer`](../../PlayerRegistry/interfaces/IPlayer.md).[`subscribedStreamer`](../../PlayerRegistry/interfaces/IPlayer.md#subscribedstreamer)
+
+***
+
+### transport
+
+> **transport**: `ITransport`
+
+Defined in: [Signalling/src/PlayerConnection.ts:31](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerConnection.ts#L31)
+
+## Methods
+
+### getPlayerInfo()
+
+> **getPlayerInfo**(): [`IPlayerInfo`](../../PlayerRegistry/interfaces/IPlayerInfo.md)
+
+Defined in: [Signalling/src/PlayerConnection.ts:88](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerConnection.ts#L88)
+
+Returns a descriptive object for the REST API inspection operations.
+
+#### Returns
+
+[`IPlayerInfo`](../../PlayerRegistry/interfaces/IPlayerInfo.md)
+
+An IPlayerInfo object containing viewable information about this connection.
+
+#### Implementation of
+
+[`IPlayer`](../../PlayerRegistry/interfaces/IPlayer.md).[`getPlayerInfo`](../../PlayerRegistry/interfaces/IPlayer.md#getplayerinfo)
+
+***
+
+### getReadableIdentifier()
+
+> **getReadableIdentifier**(): `string`
+
+Defined in: [Signalling/src/PlayerConnection.ts:71](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerConnection.ts#L71)
+
+Returns an identifier that is displayed in logs.
+
+#### Returns
+
+`string`
+
+A string describing this connection.
+
+#### Implementation of
+
+[`IMessageLogger`](../../LoggingUtils/interfaces/IMessageLogger.md).[`getReadableIdentifier`](../../LoggingUtils/interfaces/IMessageLogger.md#getreadableidentifier)
+
+***
+
+### sendMessage()
+
+> **sendMessage**(`message`): `void`
+
+Defined in: [Signalling/src/PlayerConnection.ts:79](https://github.com/EpicGamesExt/PixelStreamingInfrastructure/blob/4dc9339cfc185a91d37d078aa9dd0951dfbae1a5/Signalling/src/PlayerConnection.ts#L79)
+
+Sends a signalling message to the player.
+
+#### Parameters
+
+##### message
+
+`BaseMessage`
+
+The message to send.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`IPlayer`](../../PlayerRegistry/interfaces/IPlayer.md).[`sendMessage`](../../PlayerRegistry/interfaces/IPlayer.md#sendmessage)

package/docs/PlayerRegistry/README.md

@@ -0,0 +1,16 @@
+[**@epicgames-ps/lib-pixelstreamingsignalling-ue5.5**](../README.md)
+
+***
+
+[@epicgames-ps/lib-pixelstreamingsignalling-ue5.5](../README.md) / PlayerRegistry
+
+# PlayerRegistry
+
+## Classes
+
+- [PlayerRegistry](classes/PlayerRegistry.md)
+
+## Interfaces
+
+- [IPlayer](interfaces/IPlayer.md)
+- [IPlayerInfo](interfaces/IPlayerInfo.md)