feat: Add WebSocket-based syslog broadcast support for iOS

[Dor-bl]

List of changes

Implements the iOS half of the log broadcast feature. The Android logcat
side was merged in #969; this wires the existing (previously unused)
IListensToSyslogMessages interface into IOSDriver, adding WebSocket-based
real-time iOS syslog streaming via the Appium
ws://<host>:<port>/ws/session/<id>/appium/device/syslog endpoint.

• IOSDriver now implements IListensToSyslogMessages using a
  StringWebSocketClient, with StartSyslogBroadcast() (+ host / host+port
  overloads), StopSyslogBroadcast(), listener registration for messages,
  errors, connections and disconnections, and RemoveAllSyslogListeners().
• Changed IListensToSyslogMessages Start/StopSyslogBroadcast return
  types from void to Task, matching the async implementation and the
  Android IListensToLogcatMessages contract.
• Added SyslogBroadcastTests integration tests paralleling the Android
  LogcatBroadcastTests suite.

Related to: #255

Types of changes

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change that adds functionality or value)
• Breaking change (fix or feature that would cause existing functionality not to work as expected)
• Test fix (non-breaking change that improves test stability or correctness)

Documentation

• Have you proposed a file change/ PR with Appium to update documentation?

Integration tests

• Have you provided integration tests for your changes?

Details

iOS syslog streaming:

var driver = new IOSDriver(options);

driver.AddSyslogMessagesListener(msg => Console.WriteLine($"[SYSLOG] {msg}"));
driver.AddSyslogConnectionListener(() => Console.WriteLine("Connected"));

await driver.StartSyslogBroadcast();          // localhost:4723 default
// or: await driver.StartSyslogBroadcast("192.168.1.100", 4723);

await driver.StopSyslogBroadcast();
driver.RemoveAllSyslogListeners();

[Copilot]

Pull request overview

Adds iOS support for Appium’s WebSocket-based log broadcast feature by wiring IListensToSyslogMessages into IOSDriver and introducing integration tests to validate real-time syslog streaming behavior, complementing the existing Android logcat broadcast implementation.

Changes:

• Implemented WebSocket-driven iOS syslog broadcast start/stop and listener management on IOSDriver.
• Updated IListensToSyslogMessages start/stop signatures to be async (Task) to align with the Android logcat contract.
• Added SyslogBroadcastTests integration tests mirroring the Android logcat broadcast suite.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
test/integration/IOS/Session/Logs/SyslogBroadcastTests.cs	Adds integration coverage for syslog WebSocket broadcast lifecycle and listener behavior.
src/Appium.Net/Appium/iOS/IOSDriver.cs	Implements iOS syslog broadcast and listener APIs via StringWebSocketClient.
src/Appium.Net/Appium/iOS/Interfaces/IListensToSyslogMessages.cs	Changes syslog broadcast interface methods to async Task signatures.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (2)

src/Appium.Net/Appium/iOS/Interfaces/IListensToSyslogMessages.cs:31

• Changing Start/StopSyslogBroadcast from void to Task is a breaking public API change for any downstream implementations and some call sites (e.g., delegates expecting Action). If this package follows semver, consider adding new Task-returning Async methods (and keeping the void ones as obsolete shims) or coordinating a major version bump.

        Task StartSyslogBroadcast();

src/Appium.Net/Appium/WebSocket/StringWebSocketClient.cs:279

• DisconnectInternalAsync only runs when State==Open, but when the server sends a Close frame ReceiveMessagesAsync calls DisconnectAsync (line 336) and the ClientWebSocket state is typically CloseReceived. That means the close handshake + _disconnected handlers can be skipped. Additionally, awaiting _receiveTask unconditionally can deadlock when DisconnectAsync is triggered from within ReceiveMessagesAsync.

            if (_clientWebSocket?.State == WebSocketState.Open)
            {
                try
                {
                    _cancellationTokenSource?.Cancel();

[Copilot]

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

[Copilot]

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

src/Appium.Net/Appium/WebSocket/StringWebSocketClient.cs:279

• DisconnectInternalAsync can deadlock when a Close frame is received: ReceiveMessagesAsync calls DisconnectAsync() (StringWebSocketClient.cs:336), which then awaits _receiveTask (lines 283-286). If DisconnectAsync is running on the receive task itself, this is effectively awaiting itself and can hang indefinitely, leaving callers (e.g., IOSDriver.StopSyslogBroadcast) stuck. Consider skipping the await when DisconnectAsync is invoked from the receive loop task (compare Task.CurrentId to _receiveTask.Id), or otherwise avoid calling DisconnectAsync from inside ReceiveMessagesAsync.

            if (_clientWebSocket?.State == WebSocketState.Open)
            {
                try
                {
                    _cancellationTokenSource?.Cancel();

[Copilot]

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.