ProtoFlux:User Network Statistic: Difference between revisions

From Resonite Wiki
Add skeleton page 🩻
 
Added most info without descriptions on what it does.
Line 6: Line 6:
|}}
|}}


The <code>User Network Statistic</code> node is...
The <code>User Network Statistic</code> node can output different statistics pertaining to a user's network connection in Resonite.
 
==Inputs==
==Inputs==
===Name ([[Type:String|String]])===
The name of the network statistic the user would like to output. The output will only work if you select the correct type when slecting the node. There are different names depending on whether the user has connected through LNL or Steam Networking Sockets.
====Any Connection Names====
(These names apply to any type of network connection)
{| class="wikitable"
!Name!!Type!!Description
|-
|<code>Protocol</code> ([https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/1833 currently inaccessible])||string||Outputs either "LNL" or "Steam", depending on the user's connection.
|}
====LNL Connection Names====
(These names only apply if the user is connected through LNL)
{| class="wikitable"
!Name!!Type!!Description
|-
|<code>PrimaryChannelQueue</code>||int||
|-
|<code>BackgroundChannelQueue</code>||int||
|-
|<code>PacketsLost</code>||long||
|-
|<code>PacketsSent</code>||long||
|-
|<code>PacketsReceived</code>||long||
|-
|<code>BytesSent</code>||long||
|-
|<code>BytesReceived</code>||long||
|-
|<code>WindowWaitCount</code>||long||
|-
|<code>AveragePacketSize</code>||double||
|-
|<code>AverageMergedPackets</code>||double||
|-
|<code>MTU</code>||int||
|-
|<code>TimeSinceLastPacket</code>||int||
|}
====Steam Connection Names====
(These names only apply if the user is connected through Steam Networking Sockets)
{| class="wikitable"
!Name!!Type!!Description
|-
|<code>MainQualityLocal</code>||float||
|-
|<code>MainQualityRemote</code>||float||
|-
|<code>MainPendingReliable</code>||int||
|-
|<code>MainPendingUnreliable</code>||int||
|-
|<code>MainOutRate</code>||float||
|-
|<code>MainInRate</code>||float||
|-
|<code>BG_QualityLocal</code>||float||
|-
|<code>BG_QualityRemote</code>||float||
|-
|<code>BG_PendingReliable</code>||int||
|-
|<code>BG_PendingUnreliable</code>||int||
|-
|<code>BG_OutRate</code>||float||
|-
|<code>BG_InRate</code>||float||
|-
|<code>Bandwidth</code>||int||
|}
===User ([[User]])===
The user to show network statistics for. Does not work if user is host of the session.


==Outputs==
==Outputs==
 
This node will output a nullable value of the type specified for the associated statistic name. The ouput will always be null if user is the host of the session.


[[Category:ProtoFlux:Users:Info]]
[[Category:ProtoFlux:Users:Info]]

Revision as of 11:39, 24 April 2024

User Network Statistic<T>
Name
*
User
Info

The User Network Statistic node can output different statistics pertaining to a user's network connection in Resonite.

Inputs

Name (String)

The name of the network statistic the user would like to output. The output will only work if you select the correct type when slecting the node. There are different names depending on whether the user has connected through LNL or Steam Networking Sockets.

Any Connection Names

(These names apply to any type of network connection)

Name Type Description
Protocol (currently inaccessible) string Outputs either "LNL" or "Steam", depending on the user's connection.

LNL Connection Names

(These names only apply if the user is connected through LNL)

Name Type Description
PrimaryChannelQueue int
BackgroundChannelQueue int
PacketsLost long
PacketsSent long
PacketsReceived long
BytesSent long
BytesReceived long
WindowWaitCount long
AveragePacketSize double
AverageMergedPackets double
MTU int
TimeSinceLastPacket int

Steam Connection Names

(These names only apply if the user is connected through Steam Networking Sockets)

Name Type Description
MainQualityLocal float
MainQualityRemote float
MainPendingReliable int
MainPendingUnreliable int
MainOutRate float
MainInRate float
BG_QualityLocal float
BG_QualityRemote float
BG_PendingReliable int
BG_PendingUnreliable int
BG_OutRate float
BG_InRate float
Bandwidth int

User (User)

The user to show network statistics for. Does not work if user is host of the session.

Outputs

This node will output a nullable value of the type specified for the associated statistic name. The ouput will always be null if user is the host of the session.