Skip to main content

Xbox Client Subsystems

Xbox Durango client, controller buffer, voice chat, and async services.

Subsystem Metrics​

  • Total Documented Functions: 299
  • Functions Exercised in Tests: 14
  • Platform-Divergent Implementations: 65
  • Component Source Files: 27

Source Files​

View all 27 source files in this subsystem
Source FilePath
ControllerBuffer.cppXboxClient/ControllerBuffer.cpp
ControllerBuffer.hXboxClient/ControllerBuffer.h
KeyboardProvider.cppXboxClient/KeyboardProvider.cpp
UserTranslator.cppXboxClient/UserTranslator.cpp
UserTranslator.hXboxClient/UserTranslator.h
VoiceChat.cppXboxClient/VoiceChat.cpp
VoiceChat.hXboxClient/VoiceChat.h
VoiceChatBase.hXboxClient/VoiceChatBase.h
VoiceChatMaxNet.cppXboxClient/VoiceChatMaxNet.cpp
VoiceChatMaxNet.hXboxClient/VoiceChatMaxNet.h
XbLiveUtils.cppXboxClient/XbLiveUtils.cpp
XboxGameController.cppXboxClient/XboxGameController.cpp
XboxGameController.hXboxClient/XboxGameController.h
XboxMultiplayerManager.cppXboxClient/XboxMultiplayerManager.cpp
XboxMultiplayerManager.hXboxClient/XboxMultiplayerManager.h
XboxService.cppXboxClient/XboxService.cpp
XboxUtils.cppXboxClient/XboxUtils.cpp
XboxUtils.hXboxClient/XboxUtils.h
async.hXboxClient/async.h
fetchfflags.pyXboxClient/fetchfflags.py
main.cppXboxClient/main.cpp
marshaller.cppXboxClient/marshaller.cpp
marshaller.hXboxClient/marshaller.h
p2p.cppXboxClient/p2p.cpp
p2p.hXboxClient/p2p.h
renderJob.cppXboxClient/renderJob.cpp
xdpevents.hXboxClient/xdpevents.h

Function Reference​

1. ControllerBuffer::updateBuffer​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void ControllerBuffer::updateBuffer();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/ControllerBuffer.cpp:14
SubsystemXbox Client Subsystems

How it Works Internally​

Executes updateBuffer within Xbox Client Subsystems. Coordinates interactions with lock, getRbxGamepadIntFromGamepad, GetAt, GetCurrentReading.

  • Control Flow & Execution: Iterative loop processing, Conditional branching, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock); Thread mutual exclusion locking (boost::mutex).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, getRbxGamepadIntFromGamepad, GetAt, GetCurrentReading, bufferGamepadButtons, bufferGamepadAxis.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on updateBuffer.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


2. ControllerBuffer::processButton​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void ControllerBuffer::processButton(InputObject::UserInputType userInputType, const RBX::KeyCode buttonCode, const int buttonState);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/ControllerBuffer.cpp:39
SubsystemXbox Client Subsystems

How it Works Internally​

Executes processButton within Xbox Client Subsystems. Coordinates interactions with gamepadButtonCombo, newGamepadButtonState, Vector3, find.

  • Control Flow & Execution: Conditional branching, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: gamepadButtonCombo, newGamepadButtonState, Vector3, find, end, back, push_back.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on processButton.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


3. ControllerBuffer::bufferGamepadButtons​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void ControllerBuffer::bufferGamepadButtons(const int controllerIndex, IGamepadReading^& gamepadReading);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/ControllerBuffer.cpp:57
SubsystemXbox Client Subsystems

How it Works Internally​

Executes bufferGamepadButtons within Xbox Client Subsystems. Coordinates interactions with getGamepadEnumForInt, processButton.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getGamepadEnumForInt, processButton.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on bufferGamepadButtons.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


4. ControllerBuffer::processAxis​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void ControllerBuffer::processAxis(RBX::InputObject::UserInputType userInputType, const RBX::KeyCode axisCode, const Vector3 axisValue);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/ControllerBuffer.cpp:80
SubsystemXbox Client Subsystems

How it Works Internally​

Executes processAxis within Xbox Client Subsystems. Coordinates interactions with zero, gamepadAxisCombo, newGamepadAxisState, find.

  • Control Flow & Execution: Conditional branching, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: zero, gamepadAxisCombo, newGamepadAxisState, find, end, back, push_back.
  • External Library Dependencies: G3D Graphics and Math Engine.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on processAxis.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


5. ControllerBuffer::bufferGamepadAxis​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void ControllerBuffer::bufferGamepadAxis(const int controllerIndex, IGamepadReading^& gamepadReading);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/ControllerBuffer.cpp:108
SubsystemXbox Client Subsystems

How it Works Internally​

Executes bufferGamepadAxis within Xbox Client Subsystems. Coordinates interactions with getGamepadEnumForInt, processAxis, Vector3.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getGamepadEnumForInt, processAxis, Vector3.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on bufferGamepadAxis.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


6. ControllerBuffer::getBufferedInput​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

ControllerBuffer::GamepadValueBufferMap ControllerBuffer::getBufferedInput();
PropertyValue
Return TypeControllerBuffer::GamepadValueBufferMap
ModifiersNone
Source LocationXboxClient/ControllerBuffer.cpp:118
SubsystemXbox Client Subsystems

How it Works Internally​

Executes getBufferedInput within Xbox Client Subsystems. Coordinates interactions with lock, swap.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock); Thread mutual exclusion locking (boost::mutex).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, swap.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getBufferedInput.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


7. ControllerBuffer::getPollingMsec​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

float ControllerBuffer::getPollingMsec();
PropertyValue
Return Typefloat
ModifiersNone
Source LocationXboxClient/ControllerBuffer.cpp:130
SubsystemXbox Client Subsystems

How it Works Internally​

Executes getPollingMsec within Xbox Client Subsystems. Coordinates interactions with return.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: return.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getPollingMsec.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


8. setXboxGameController​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void setXboxGameController(XboxGameController* newController);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/ControllerBuffer.h:31
SubsystemXbox Client Subsystems

How it Works Internally​

Executes setXboxGameController within Xbox Client Subsystems.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on setXboxGameController.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


9. KeyboardProvider::registerTextBoxListener​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void KeyboardProvider::registerTextBoxListener(RBX::DataModel* dm);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/KeyboardProvider.cpp:14
SubsystemXbox Client Subsystems

How it Works Internally​

Executes registerTextBoxListener within Xbox Client Subsystems. Coordinates interactions with connect, bind.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: connect, bind.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on registerTextBoxListener.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


10. KeyboardProvider::showKeyBoardLua​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void KeyboardProvider::showKeyBoardLua(std::string& title, std::string& description, std::string& defaultText, RBX::XboxKeyBoardType keyboardType, RBX::DataModel* dm);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/KeyboardProvider.cpp:73
SubsystemXbox Client Subsystems

How it Works Internally​

Executes showKeyBoardLua within Xbox Client Subsystems. Coordinates interactions with void, submitTask, keyboardClosedSignal, data.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: void, submitTask, keyboardClosedSignal, data, InterlockedExchange, ws2s, Data, showKeyBoard.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on showKeyBoardLua.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


11. KeyboardProvider::showKeyBoard​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void KeyboardProvider::showKeyBoard(shared_ptr<RBX::Instance> instance);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/KeyboardProvider.cpp:103
SubsystemXbox Client Subsystems

How it Works Internally​

Executes showKeyBoard within Xbox Client Subsystems. Coordinates interactions with get, getText, wstr, begin. Employs dynamic heap allocation via c++ operator new.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Dynamic heap allocation via C++ operator new; Reference-counted heap object ownership (boost::shared_ptr).
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: get, getText, wstr, begin, end, String, c_str, void, submitTask, textboxDidFinishEditing, InterlockedExchange, ws2s.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on showKeyBoard.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/XboxService.cpp.

  • Alternative Implementation Files: XboxClient/XboxService.cpp

12. constructJsonRequest​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

std::string constructJsonRequest(const UserIDTranslator::GametagSet& tags);
PropertyValue
Return Typestd::string
Modifiersstatic
Source LocationXboxClient/UserTranslator.cpp:6
SubsystemXbox Client Subsystems

How it Works Internally​

Executes constructJsonRequest within Xbox Client Subsystems. Coordinates interactions with empty, begin, end.

  • Control Flow & Execution: Iterative loop processing, Conditional branching, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: empty, begin, end.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on constructJsonRequest.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


13. UserIDTranslator::get​

Status: 🧪 Tested  |  ⚠️ Platform Divergent

void UserIDTranslator::get(OutputVector& result, const InputVector& inputs);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/UserTranslator.cpp:36
SubsystemXbox Client Subsystems

How it Works Internally​

Executes get within Xbox Client Subsystems. Coordinates interactions with lock, clear, begin, end. Employs dynamic heap allocation via c++ operator new.

  • Control Flow & Execution: Iterative loop processing, Conditional branching, Multi-case state dispatch.
  • Memory Management: Dynamic heap allocation via C++ operator new; Reference-counted heap object ownership (boost::shared_ptr).
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, clear, begin, end, string, Entry, insert, getState, store, push_back, empty, constructJsonRequest.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

This function is exercised in 73 test case(s):

  • ClusterDeprecatedProperty::ParentCannotBeSet (App.UnitTest/ClusterDeprecatedPropertyTest.cpp:69)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_REQUIRE_EQUAL(dataModel-&gt;getWorkspace(), resultTuple-&gt;at(0).get&lt;shared_ptr&lt;Instance&gt; &gt;().get()), BOOST_REQUIRE_EQUAL(dataModel-&gt;getWorkspace(), resultTuple-&gt;at(0).get&lt;shared_ptr&lt;Instance&gt; &gt;().get())
    • Callsite Snippet: BOOST_REQUIRE_EQUAL(dataModel-&gt;getWorkspace(), resultTuple-&gt;at(0).get&lt;shared_ptr&lt;Instance&gt; &gt;().get());
  • Instance::CastTo (App.UnitTest/Instance.cpp:137)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(RBX::Instance::fastDynamicCast&lt;RBX::Instance&gt;(part.get())), BOOST_CHECK(!RBX::Instance::fastDynamicCast&lt;RBX::PartInstance&gt;(instance.get()))
    • Callsite Snippet: BOOST_CHECK(RBX::Instance::fastDynamicCast&lt;RBX::Instance&gt;(part.get()));
  • Instance::CastToConst (App.UnitTest/Instance.cpp:155)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(RBX::Instance::fastDynamicCast&lt;RBX::Instance&gt;(part.get())), BOOST_CHECK(!RBX::Instance::fastDynamicCast&lt;RBX::PartInstance&gt;(instance.get()))
    • Callsite Snippet: BOOST_CHECK(RBX::Instance::fastDynamicCast&lt;RBX::Instance&gt;(part.get()));
  • Instance::ReparentingLock (App.UnitTest/Instance.cpp:213)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_CHECK(!parent-&gt;getIsParentLocked()), BOOST_CHECK(parent-&gt;getIsParentLocked()), BOOST_CHECK(child-&gt;getIsParentLocked()), BOOST_CHECK(child-&gt;getParent() == parent.get()), BOOST_CHECK(!child-&gt;getIsParentLocked())
    • Callsite Snippet: BOOST_CHECK(!parent-&gt;getIsParentLocked());

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: RobloxStudio/RobloxMainWindow.cpp.

  • Alternative Implementation Files: RobloxStudio/RobloxMainWindow.cpp

14. UserIDTranslator::waitForUIDs​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void UserIDTranslator::waitForUIDs(const std::vector< const UserIDTranslator::Entry* >& uids);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/UserTranslator.cpp:146
SubsystemXbox Client Subsystems

How it Works Internally​

Executes waitForUIDs within Xbox Client Subsystems. Coordinates interactions with size, getState, Sleep.

  • Control Flow & Execution: Iterative loop processing, Conditional branching, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: size, getState, Sleep.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on waitForUIDs.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


15. getState​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

ResultState getState() const;
PropertyValue
Return TypeResultState
Modifiersconst
Source LocationXboxClient/UserTranslator.h:26
SubsystemXbox Client Subsystems

How it Works Internally​

Executes getState within Xbox Client Subsystems. Coordinates interactions with return, load.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Immutable / read-only operation (const member method; does not alter object state).
  • Key Internal Calls: return, load.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getState.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


16. currentUser​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

: currentUser(nullptr);
PropertyValue
Return Type:
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:18
SubsystemXbox Client Subsystems

How it Works Internally​

Executes currentUser within Xbox Client Subsystems. Coordinates interactions with ChatManager, MeshManager, String, s2ws. Employs dynamic heap allocation via c++ operator new.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Dynamic heap allocation via C++ operator new.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Exception handling block (try/catch recovery).
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: ChatManager, MeshManager, String, s2ws, data, Data, ws2s, dprintf, c_str.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on currentUser.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


17. VoiceChat::init​

Status: 🧪 Tested  |  ⚠️ Platform Divergent

void VoiceChat::init();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:65
SubsystemXbox Client Subsystems

How it Works Internally​

Executes init within Xbox Client Subsystems. Coordinates interactions with shared_from_this, GetMeshPacketManager, sharedPtrToThis, lock. Employs dynamic heap allocation via c++ operator new.

  • Control Flow & Execution: Conditional branching, Explicit result return.
  • Memory Management: Dynamic heap allocation via C++ operator new; Reference-counted heap object ownership (boost::shared_ptr).
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: shared_from_this, GetMeshPacketManager, sharedPtrToThis, lock, onIncomingChatMessage, GetAssociation, onMeshConnectionAdded, onMeshConnectionRemoved, onOutgoingChatPacketReady, onDebugMessageReceived, CompareUniqueConsoleIdentifiersHandler, Compare.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

This function is exercised in 5 test case(s):

  • SoundEffectTests::DistortionDSPUpdatesAndDetach (App.UnitTest/SoundEffectTest.cpp:53)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_REQUIRE_EQUAL(system-&gt;init(16, FMOD_INIT_NORMAL, NULL), FMOD_OK)
    • Callsite Snippet: BOOST_REQUIRE_EQUAL(system-&gt;init(16, FMOD_INIT_NORMAL, NULL), FMOD_OK);
  • Trie::SimpleTest (Base.UnitTest/trie.cpp:86)
    • Usage Pattern: Direct Call
    • Callsite Snippet: std::string key = init(trie, map, hashmap);
  • Trie::PerfTrie (Base.UnitTest/trie.cpp:95)
    • Usage Pattern: Performance Benchmark
    • Callsite Snippet: std::string key = init(trie, map, hashmap);
  • Trie::PerfMap (Base.UnitTest/trie.cpp:106)
    • Usage Pattern: Performance Benchmark
    • Callsite Snippet: std::string key = init(trie, map, hashmap);

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp, Win/LogManager.cpp, App/util/XboxHttp2.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp, Win/LogManager.cpp, App/util/XboxHttp2.cpp

18. VoiceChat::onMeshConnectionAdded​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void VoiceChat::onMeshConnectionAdded(Microsoft::Xbox::Samples::NetworkMesh::MeshConnection^ meshConnection);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:177
SubsystemXbox Client Subsystems

How it Works Internally​

Executes onMeshConnectionAdded within Xbox Client Subsystems. Coordinates interactions with HandleNewRemoteConsole, GetAssociation.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: HandleNewRemoteConsole, GetAssociation.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on onMeshConnectionAdded.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


19. VoiceChat::onMeshConnectionRemoved​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void VoiceChat::onMeshConnectionRemoved(Microsoft::Xbox::Samples::NetworkMesh::MeshConnection^ meshConnection);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:183
SubsystemXbox Client Subsystems

How it Works Internally​

Executes onMeshConnectionRemoved within Xbox Client Subsystems. Coordinates interactions with async, RemoveRemoteConsoleAsync, GetAssociation, detach.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: async, RemoveRemoteConsoleAsync, GetAssociation, detach.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on onMeshConnectionRemoved.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


20. VoiceChat::multiplayerUserAdded​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChat::multiplayerUserAdded(Microsoft::Xbox::Services::Multiplayer::MultiplayerSessionMember^ member);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:191
SubsystemXbox Client Subsystems

How it Works Internally​

Executes multiplayerUserAdded within Xbox Client Subsystems.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on multiplayerUserAdded.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

21. VoiceChat::multiplayerUserRemoved​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChat::multiplayerUserRemoved(Microsoft::Xbox::Services::Multiplayer::MultiplayerSessionMember^ member);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:196
SubsystemXbox Client Subsystems

How it Works Internally​

Executes multiplayerUserRemoved within Xbox Client Subsystems.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on multiplayerUserRemoved.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

22. VoiceChat::onOutgoingChatPacketReady​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChat::onOutgoingChatPacketReady(Microsoft::Xbox::GameChat::ChatPacketEventArgs^ args);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:201
SubsystemXbox Client Subsystems

How it Works Internally​

Executes onOutgoingChatPacketReady within Xbox Client Subsystems. Coordinates interactions with GetConnectionsByType, GetAt, GetMeshPacketManager, SendChatMessage.

  • Control Flow & Execution: Iterative loop processing, Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: GetConnectionsByType, GetAt, GetMeshPacketManager, SendChatMessage, GetAssociation, onIncomingChatMessage, ProcessIncomingChatMessage, setMuteState, UnmuteUserFromAllChannels, MuteUserFromAllChannels, muteAll, MuteAllUsersFromAllChannels.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on onOutgoingChatPacketReady.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

23. VoiceChat::onIncomingChatMessage​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void VoiceChat::onIncomingChatMessage(Windows::Storage::Streams::IBuffer^ chatMessage, Platform::Object^ uniqueRemoteConsoleIdentifier);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:227
SubsystemXbox Client Subsystems

How it Works Internally​

Executes onIncomingChatMessage within Xbox Client Subsystems. Coordinates interactions with ProcessIncomingChatMessage.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: ProcessIncomingChatMessage.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on onIncomingChatMessage.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


24. VoiceChat::setMuteState​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChat::setMuteState(bool muted, Microsoft::Xbox::GameChat::ChatUser^ chatUser);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:235
SubsystemXbox Client Subsystems

How it Works Internally​

Executes setMuteState within Xbox Client Subsystems. Coordinates interactions with UnmuteUserFromAllChannels, MuteUserFromAllChannels.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: UnmuteUserFromAllChannels, MuteUserFromAllChannels.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on setMuteState.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

25. VoiceChat::muteAll​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChat::muteAll();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:244
SubsystemXbox Client Subsystems

How it Works Internally​

Executes muteAll within Xbox Client Subsystems. Coordinates interactions with MuteAllUsersFromAllChannels.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: MuteAllUsersFromAllChannels.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on muteAll.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

26. VoiceChat::unmuteAll​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChat::unmuteAll();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:250
SubsystemXbox Client Subsystems

How it Works Internally​

Executes unmuteAll within Xbox Client Subsystems. Coordinates interactions with UnmuteAllUsersFromAllChannels.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: UnmuteAllUsersFromAllChannels.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on unmuteAll.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

27. VoiceChat::onDebugMessageReceived​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChat::onDebugMessageReceived(Microsoft::Xbox::GameChat::DebugMessageEventArgs^ args);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:256
SubsystemXbox Client Subsystems

How it Works Internally​

Executes onDebugMessageReceived within Xbox Client Subsystems. Coordinates interactions with dprintf, ws2s, Data, c_str.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: dprintf, ws2s, Data, c_str.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on onDebugMessageReceived.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

28. VoiceChat::headsetConnected​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChat::headsetConnected(Windows::Xbox::System::User^ user);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:261
SubsystemXbox Client Subsystems

How it Works Internally​

Executes headsetConnected within Xbox Client Subsystems. Coordinates interactions with addLocalUserToChannel, GetConnectionsByType, HandleNewRemoteConsole, GetAssociation.

  • Control Flow & Execution: Iterative loop processing, Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: addLocalUserToChannel, GetConnectionsByType, HandleNewRemoteConsole, GetAssociation.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on headsetConnected.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

29. VoiceChat::headsetDisconnected​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void VoiceChat::headsetDisconnected();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:276
SubsystemXbox Client Subsystems

How it Works Internally​

Executes headsetDisconnected within Xbox Client Subsystems. Coordinates interactions with removeLocalUserFromChannel.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: removeLocalUserFromChannel.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on headsetDisconnected.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


30. VoiceChat::addLocalUserToChannel​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChat::addLocalUserToChannel(uint8 channelIndex, Windows::Xbox::System::User^ user);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:282
SubsystemXbox Client Subsystems

How it Works Internally​

Executes addLocalUserToChannel within Xbox Client Subsystems. Coordinates interactions with async, AddLocalUserToChatChannelAsync, detach.

  • Control Flow & Execution: Iterative loop processing, Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: async, AddLocalUserToChatChannelAsync, detach.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on addLocalUserToChannel.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

31. VoiceChat::removeLocalUserFromChannel​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChat::removeLocalUserFromChannel();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:305
SubsystemXbox Client Subsystems

How it Works Internally​

Executes removeLocalUserFromChannel within Xbox Client Subsystems. Coordinates interactions with async, RemoveLocalUserFromChatChannelAsync, detach.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: async, RemoveLocalUserFromChatChannelAsync, detach.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on removeLocalUserFromChannel.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

32. VoiceChat::addConnections​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChat::addConnections(Windows::Foundation::Collections::IVectorView<MultiplayerSessionMember^>^ members);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:314
SubsystemXbox Client Subsystems

How it Works Internally​

Executes addConnections within Xbox Client Subsystems. Coordinates interactions with IsEmpty, find, end, FromBase64String.

  • Control Flow & Execution: Iterative loop processing, Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: IsEmpty, find, end, FromBase64String, ConnectToAddress.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on addConnections.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

33. VoiceChat::removeConnections​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChat::removeConnections(Windows::Foundation::Collections::IVectorView<MultiplayerSessionMember^>^ members);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChat.cpp:337
SubsystemXbox Client Subsystems

How it Works Internally​

Executes removeConnections within Xbox Client Subsystems. Coordinates interactions with IsEmpty, find, end, FromBase64String.

  • Control Flow & Execution: Iterative loop processing, Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: IsEmpty, find, end, FromBase64String, DisconectFromAddress.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on removeConnections.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

34. create​

Status: 🧪 Tested  |  ⚠️ Platform Divergent

boost::shared_ptr<VoiceChatBase> create(unsigned char sessionConsoleId);
PropertyValue
Return Typeboost::shared_ptr&lt;VoiceChatBase&gt;
Modifiersstatic
Source LocationXboxClient/VoiceChat.h:14
SubsystemXbox Client Subsystems

How it Works Internally​

Executes create within Xbox Client Subsystems. Coordinates interactions with VoiceChat, init. Employs dynamic heap allocation via c++ operator new.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Dynamic heap allocation via C++ operator new; Reference-counted heap object ownership (boost::shared_ptr).
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: VoiceChat, init.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

This function is exercised in 39 test case(s):

  • Instance::WaitForChildReturnsImmediatelyIfChildPresent (App.UnitTest/Instance.cpp:264)
    • Usage Pattern: Direct Call
    • Assertions Checked: BOOST_CHECK_EQUAL(part-&gt;getName(), "Renamed")
    • Callsite Snippet: shared_ptr&lt;Script&gt; script = Creatable&lt;RBX::Instance&gt;::create&lt;Script&gt;();
  • Instance::WaitForSameChildAfterInitialWaitForChild (App.UnitTest/Instance.cpp:289)
    • Usage Pattern: Direct Call
    • Assertions Checked: BOOST_CHECK_EQUAL(part-&gt;getName(), "Renamed")
    • Callsite Snippet: shared_ptr&lt;Script&gt; script = Creatable&lt;RBX::Instance&gt;::create&lt;Script&gt;();
  • Instance::TwoScriptsWaitingForSameChild (App.UnitTest/Instance.cpp:314)
    • Usage Pattern: Direct Call
    • Assertions Checked: BOOST_CHECK(dm-&gt;getWorkspace()-&gt;findFirstChildByName("Alice") != NULL), BOOST_CHECK(dm-&gt;getWorkspace()-&gt;findFirstChildByName("Bob") != NULL)
    • Callsite Snippet: shared_ptr&lt;Script&gt; script1 = Creatable&lt;RBX::Instance&gt;::create&lt;Script&gt;();
  • Instance::TwoScriptsWaitingForSameChildRenameOnResume (App.UnitTest/Instance.cpp:356)
    • Usage Pattern: Direct Call
    • Assertions Checked: BOOST_CHECK_EQUAL("PartBx", part-&gt;getName()), BOOST_CHECK_EQUAL("PartA", part2-&gt;getName())
    • Callsite Snippet: shared_ptr&lt;Script&gt; script1 = Creatable&lt;RBX::Instance&gt;::create&lt;Script&gt;();

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.h, XboxClient/async.h, Rendering/GfxCore/GL/ContextGLMac.mm.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.h, XboxClient/async.h, Rendering/GfxCore/GL/ContextGLMac.mm, Rendering/GfxCore/GL/ContextGLAndroid.cpp, Rendering/GfxCore/GL/ContextGLWin32.cpp

35. ~VoiceChatBase​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

public:
virtual ~VoiceChatBase();
PropertyValue
Return Type`public:
virtual`
ModifiersNone
Source LocationXboxClient/VoiceChatBase.h:11
SubsystemXbox Client Subsystems

How it Works Internally​

Declaration or inline method for ~VoiceChatBase.

  • Control Flow & Execution: Linear execution flow.
  • Memory Management: Standard stack allocation.
  • Concurrency & Thread Safety: Unsynchronized / single-threaded context.
  • Error Handling & Invariants: Standard return value verification.
  • State Mutation: Stateless or local modification.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on ~VoiceChatBase.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


36. getMuteState​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

unsigned getMuteState(unsigned memberId);
PropertyValue
Return Typeunsigned
Modifiersvirtual
Source LocationXboxClient/VoiceChatBase.h:36
SubsystemXbox Client Subsystems

How it Works Internally​

Executes getMuteState within Xbox Client Subsystems. Coordinates interactions with return.

  • Control Flow & Execution: Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: return.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getMuteState.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

37. muteUser​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void muteUser(unsigned memberId);
PropertyValue
Return Typevoid
Modifiersvirtual
Source LocationXboxClient/VoiceChatBase.h:39
SubsystemXbox Client Subsystems

How it Works Internally​

Declaration or inline method for muteUser.

  • Control Flow & Execution: Linear execution flow.
  • Memory Management: Standard stack allocation.
  • Concurrency & Thread Safety: Unsynchronized / single-threaded context.
  • Error Handling & Invariants: Standard return value verification.
  • State Mutation: Stateless or local modification.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on muteUser.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

38. unmuteUser​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void unmuteUser(unsigned memberId);
PropertyValue
Return Typevoid
Modifiersvirtual
Source LocationXboxClient/VoiceChatBase.h:41
SubsystemXbox Client Subsystems

How it Works Internally​

Declaration or inline method for unmuteUser.

  • Control Flow & Execution: Linear execution flow.
  • Memory Management: Standard stack allocation.
  • Concurrency & Thread Safety: Unsynchronized / single-threaded context.
  • Error Handling & Invariants: Standard return value verification.
  • State Mutation: Stateless or local modification.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on unmuteUser.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

39. updateMember​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void updateMember(unsigned memberId, float distance, TalkingDelta* talkingDeltaOut);
PropertyValue
Return Typevoid
Modifiersvirtual
Source LocationXboxClient/VoiceChatBase.h:42
SubsystemXbox Client Subsystems

How it Works Internally​

Declaration or inline method for updateMember.

  • Control Flow & Execution: Linear execution flow.
  • Memory Management: Standard stack allocation.
  • Concurrency & Thread Safety: Unsynchronized / single-threaded context.
  • Error Handling & Invariants: Standard return value verification.
  • State Mutation: Stateless or local modification.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on updateMember.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatMaxNet.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChatMaxNet.cpp

40. xbLiveContext​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

: xbLiveContext(xboxLiveContext);
PropertyValue
Return Type:
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:22
SubsystemXbox Client Subsystems

How it Works Internally​

Executes xbLiveContext within Xbox Client Subsystems. Coordinates interactions with ChatManager, reset, Network. Employs dynamic heap allocation via c++ operator new.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Dynamic heap allocation via C++ operator new.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: ChatManager, reset, Network.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on xbLiveContext.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


41. VoiceChatMaxNet::init​

Status: 🧪 Tested  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::init();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:45
SubsystemXbox Client Subsystems

How it Works Internally​

Executes init within Xbox Client Subsystems. Coordinates interactions with shared_from_this, sharedPtrToThis, lock, onOutgoingChatPacketReady. Employs dynamic heap allocation via c++ operator new.

  • Control Flow & Execution: Iterative loop processing, Conditional branching, Explicit result return.
  • Memory Management: Dynamic heap allocation via C++ operator new; Reference-counted heap object ownership (boost::shared_ptr).
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock).
  • Error Handling & Invariants: Engine invariant assertion check (RBXASSERT).
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: shared_from_this, sharedPtrToThis, lock, onOutgoingChatPacketReady, onDebugMessageReceived, CompareUniqueConsoleIdentifiersHandler, RBXASSERT, return, Equals, muteAll, unmuteAll, subscribeToChatMessages_NoLock.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

This function is exercised in 5 test case(s):

  • SoundEffectTests::DistortionDSPUpdatesAndDetach (App.UnitTest/SoundEffectTest.cpp:53)
    • Usage Pattern: Direct Assertion
    • Assertions Checked: BOOST_REQUIRE_EQUAL(system-&gt;init(16, FMOD_INIT_NORMAL, NULL), FMOD_OK)
    • Callsite Snippet: BOOST_REQUIRE_EQUAL(system-&gt;init(16, FMOD_INIT_NORMAL, NULL), FMOD_OK);
  • Trie::SimpleTest (Base.UnitTest/trie.cpp:86)
    • Usage Pattern: Direct Call
    • Callsite Snippet: std::string key = init(trie, map, hashmap);
  • Trie::PerfTrie (Base.UnitTest/trie.cpp:95)
    • Usage Pattern: Performance Benchmark
    • Callsite Snippet: std::string key = init(trie, map, hashmap);
  • Trie::PerfMap (Base.UnitTest/trie.cpp:106)
    • Usage Pattern: Performance Benchmark
    • Callsite Snippet: std::string key = init(trie, map, hashmap);

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChat.cpp, Win/LogManager.cpp, App/util/XboxHttp2.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChat.cpp, Win/LogManager.cpp, App/util/XboxHttp2.cpp

42. VoiceChatMaxNet::updateMember​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::updateMember(unsigned memberId, float distance, TalkingDelta* talkingDeltaOut);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:133
SubsystemXbox Client Subsystems

How it Works Internally​

Executes updateMember within Xbox Client Subsystems. Coordinates interactions with GetChatUsers, get, RBXASSERT, TalkingState. Employs dynamic heap allocation via c++ operator new.

  • Control Flow & Execution: Iterative loop processing, Conditional branching.
  • Memory Management: Dynamic heap allocation via C++ operator new.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Engine invariant assertion check (RBXASSERT).
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: GetChatUsers, get, RBXASSERT, TalkingState, GetAllChannels, GetAt, clamp.
  • External Library Dependencies: G3D Graphics and Math Engine.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on updateMember.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatBase.h.

  • Alternative Implementation Files: XboxClient/VoiceChatBase.h

43. VoiceChatMaxNet::handleNewRemoteConnection​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void VoiceChatMaxNet::handleNewRemoteConnection(ConsoleId^ consoleId);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:177
SubsystemXbox Client Subsystems

How it Works Internally​

Executes handleNewRemoteConnection within Xbox Client Subsystems. Coordinates interactions with HandleNewRemoteConsole.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: HandleNewRemoteConsole.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on handleNewRemoteConnection.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


44. VoiceChatMaxNet::multiplayerUserAdded​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::multiplayerUserAdded(Microsoft::Xbox::Services::Multiplayer::MultiplayerSessionMember^ member);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:182
SubsystemXbox Client Subsystems

How it Works Internally​

Executes multiplayerUserAdded within Xbox Client Subsystems. Coordinates interactions with lock, RBXASSERT, find, end. Employs dynamic heap allocation via c++ operator new.

  • Control Flow & Execution: Iterative loop processing, Conditional branching, Explicit result return.
  • Memory Management: Dynamic heap allocation via C++ operator new; Reference-counted heap object ownership (boost::shared_ptr).
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock).
  • Error Handling & Invariants: Engine invariant assertion check (RBXASSERT); Defensive null-pointer validation guard.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, RBXASSERT, find, end, shared_from_this, IsEmpty, GetChatUsers, createPeer, TalkingState, handleNewRemoteConnection, ConsoleId, getPeerId.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on multiplayerUserAdded.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChat.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChat.cpp

45. VoiceChatMaxNet::multiplayerUserRemoved​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::multiplayerUserRemoved(Microsoft::Xbox::Services::Multiplayer::MultiplayerSessionMember^ member);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:228
SubsystemXbox Client Subsystems

How it Works Internally​

Executes multiplayerUserRemoved within Xbox Client Subsystems. Coordinates interactions with lock, RBXASSERT, find, end.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock).
  • Error Handling & Invariants: Engine invariant assertion check (RBXASSERT).
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, RBXASSERT, find, end, destroyPeer, erase.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on multiplayerUserRemoved.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChat.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChat.cpp

46. VoiceChatMaxNet::sendData​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void VoiceChatMaxNet::sendData(Xp2p::PeerPtr peer, Windows::Storage::Streams::IBuffer^ buffer, unsigned int flags);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:240
SubsystemXbox Client Subsystems

How it Works Internally​

Executes sendData within Xbox Client Subsystems. Coordinates interactions with QueryInterface, IID_PPV_ARGS, Buffer, memcpy.

  • Control Flow & Execution: Iterative loop processing, Conditional branching, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Defensive null-pointer validation guard.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: QueryInterface, IID_PPV_ARGS, Buffer, memcpy, sendPacket, Sleep.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on sendData.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


47. VoiceChatMaxNet::onOutgoingChatPacketReady​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::onOutgoingChatPacketReady(Microsoft::Xbox::GameChat::ChatPacketEventArgs^ args);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:265
SubsystemXbox Client Subsystems

How it Works Internally​

Executes onOutgoingChatPacketReady within Xbox Client Subsystems. Coordinates interactions with get, lock, subscriptionLock, find.

  • Control Flow & Execution: Iterative loop processing, Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: get, lock, subscriptionLock, find, end, sendData.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on onOutgoingChatPacketReady.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChat.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChat.cpp

48. VoiceChatMaxNet::receive​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void VoiceChatMaxNet::receive();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:293
SubsystemXbox Client Subsystems

How it Works Internally​

Executes receive within Xbox Client Subsystems. Coordinates interactions with recvPacket, processPacket, ConsoleId, getPeerId. Employs dynamic heap allocation via c++ operator new.

  • Control Flow & Execution: Iterative loop processing, Conditional branching, Multi-case state dispatch.
  • Memory Management: Dynamic heap allocation via C++ operator new; Reference-counted heap object ownership (boost::shared_ptr).
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock).
  • Error Handling & Invariants: Engine invariant assertion check (RBXASSERT).
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: recvPacket, processPacket, ConsoleId, getPeerId, DataWriter, WriteBytes, getDataSize, DetachBuffer, ProcessIncomingChatMessage, getUserByMemberId, shared_from_this, async.
  • External Library Dependencies: Boost C++ Libraries.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on receive.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


49. VoiceChatMaxNet::setMuteState​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::setMuteState(bool muted, Microsoft::Xbox::GameChat::ChatUser^ chatUser);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:364
SubsystemXbox Client Subsystems

How it Works Internally​

Executes setMuteState within Xbox Client Subsystems. Coordinates interactions with UnmuteUserFromAllChannels, MuteUserFromAllChannels.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: UnmuteUserFromAllChannels, MuteUserFromAllChannels.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on setMuteState.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChat.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChat.cpp

50. VoiceChatMaxNet::getMuteState​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

unsigned VoiceChatMaxNet::getMuteState(unsigned memberId);
PropertyValue
Return Typeunsigned
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:373
SubsystemXbox Client Subsystems

How it Works Internally​

Executes getMuteState within Xbox Client Subsystems. Coordinates interactions with getUserByMemberId, find, end.

  • Control Flow & Execution: Conditional branching, Explicit result return.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getUserByMemberId, find, end.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on getMuteState.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatBase.h.

  • Alternative Implementation Files: XboxClient/VoiceChatBase.h

51. VoiceChatMaxNet::muteAll​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::muteAll();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:385
SubsystemXbox Client Subsystems

How it Works Internally​

Executes muteAll within Xbox Client Subsystems. Coordinates interactions with MuteAllUsersFromAllChannels.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: MuteAllUsersFromAllChannels.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on muteAll.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChat.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChat.cpp

52. VoiceChatMaxNet::unmuteAll​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::unmuteAll();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:391
SubsystemXbox Client Subsystems

How it Works Internally​

Executes unmuteAll within Xbox Client Subsystems. Coordinates interactions with UnmuteAllUsersFromAllChannels.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: UnmuteAllUsersFromAllChannels.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on unmuteAll.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChat.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChat.cpp

53. VoiceChatMaxNet::muteUser​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::muteUser(unsigned memberId);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:412
SubsystemXbox Client Subsystems

How it Works Internally​

Executes muteUser within Xbox Client Subsystems. Coordinates interactions with getUserByMemberId, MuteUserFromAllChannels.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getUserByMemberId, MuteUserFromAllChannels.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on muteUser.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatBase.h.

  • Alternative Implementation Files: XboxClient/VoiceChatBase.h

54. VoiceChatMaxNet::unmuteUser​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::unmuteUser(unsigned memberId);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:418
SubsystemXbox Client Subsystems

How it Works Internally​

Executes unmuteUser within Xbox Client Subsystems. Coordinates interactions with getUserByMemberId, UnmuteUserFromAllChannels.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: getUserByMemberId, UnmuteUserFromAllChannels.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on unmuteUser.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChatBase.h.

  • Alternative Implementation Files: XboxClient/VoiceChatBase.h

55. VoiceChatMaxNet::onDebugMessageReceived​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::onDebugMessageReceived(Microsoft::Xbox::GameChat::DebugMessageEventArgs^ args);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:424
SubsystemXbox Client Subsystems

How it Works Internally​

Executes onDebugMessageReceived within Xbox Client Subsystems. Coordinates interactions with dprintf, ws2s, Data, c_str.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: dprintf, ws2s, Data, c_str.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on onDebugMessageReceived.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChat.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChat.cpp

56. VoiceChatMaxNet::headsetConnected​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::headsetConnected(Windows::Xbox::System::User^ user);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:429
SubsystemXbox Client Subsystems

How it Works Internally​

Executes headsetConnected within Xbox Client Subsystems. Coordinates interactions with addLocalUserToChannel, lock, HandleNewRemoteConsole, ConsoleId. Employs dynamic heap allocation via c++ operator new.

  • Control Flow & Execution: Iterative loop processing, Conditional branching.
  • Memory Management: Dynamic heap allocation via C++ operator new.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: addLocalUserToChannel, lock, HandleNewRemoteConsole, ConsoleId.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on headsetConnected.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChat.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChat.cpp

57. VoiceChatMaxNet::addLocalUserToChannel​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::addLocalUserToChannel(uint8 channelIndex, Windows::Xbox::System::User^ user);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:444
SubsystemXbox Client Subsystems

How it Works Internally​

Executes addLocalUserToChannel within Xbox Client Subsystems. Coordinates interactions with lock, async, AddLocalUserToChatChannelAsync, except.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, async, AddLocalUserToChatChannelAsync, except, dprintf, Data, join, removeLocalUserFromChannel_NoLock.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on addLocalUserToChannel.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChat.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChat.cpp

58. VoiceChatMaxNet::removeLocalUserFromChannel​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::removeLocalUserFromChannel();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:464
SubsystemXbox Client Subsystems

How it Works Internally​

Executes removeLocalUserFromChannel within Xbox Client Subsystems. Coordinates interactions with lock, removeLocalUserFromChannel_NoLock.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: RAII mutex lock acquisition (scoped_lock).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: lock, removeLocalUserFromChannel_NoLock.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on removeLocalUserFromChannel.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChat.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChat.cpp

59. VoiceChatMaxNet::removeLocalUserFromChannel_NoLock​

Status: ⚪ Untested in Suites  |  🌐 Cross-Platform Uniform

void VoiceChatMaxNet::removeLocalUserFromChannel_NoLock();
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:470
SubsystemXbox Client Subsystems

How it Works Internally​

Executes removeLocalUserFromChannel_NoLock within Xbox Client Subsystems. Coordinates interactions with async, RemoveLocalUserFromChatChannelAsync, except, dprintf.

  • Control Flow & Execution: Conditional branching.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.
  • Key Internal Calls: async, RemoveLocalUserFromChatChannelAsync, except, dprintf, Data, join.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on removeLocalUserFromChannel_NoLock.

Behavioral Differences Across Code Files​

This function maintains identical behavior across all target platforms (_WIN32, macOS, iOS, Android, and Xbox Durango). It compiles into the same binary instructions without conditional preprocessor branching.


60. VoiceChatMaxNet::addConnections​

Status: ⚪ Untested in Suites  |  ⚠️ Platform Divergent

void VoiceChatMaxNet::addConnections(Windows::Foundation::Collections::IVectorView<MultiplayerSessionMember^>^ members);
PropertyValue
Return Typevoid
ModifiersNone
Source LocationXboxClient/VoiceChatMaxNet.cpp:485
SubsystemXbox Client Subsystems

How it Works Internally​

Executes addConnections within Xbox Client Subsystems.

  • Control Flow & Execution: Direct sequential execution.
  • Memory Management: Stack-based automatic variable allocation.
  • Concurrency & Thread Safety: Unsynchronized execution (caller must ensure thread-safety if shared).
  • Error Handling & Invariants: Relies on standard return codes and caller validation.
  • State Mutation: Pure computational logic or modifies passed-in parameters/references.

How it is Used in Tests​

No dedicated unit test case directly exercises this function by name.

Verification Note

This function is invoked indirectly through higher-level simulation or integration workloads. To add direct test coverage, introduce a test case in App.UnitTest or Base.UnitTest asserting state changes on addConnections.

Behavioral Differences Across Code Files​

Divergence Analysis: Alternative platform-specific implementations exist in: XboxClient/VoiceChat.cpp.

  • Alternative Implementation Files: XboxClient/VoiceChat.cpp

Additional Functions

There are 239 additional internal and inline functions in this subsystem. All functions are indexed and cross-referenced in the Complete Function Catalog.