plac

Unofficial Roon clients

  1. 1
  2. 2
  3. 3
  4. 4
  5. 5
  6. 6
  7. 7
  8. 8
  9. 9
  10. 10
  11. 11
  12. 12
  13. 13
  14. 14
  15. 15
  16. 16
  17. 17
  18. 18
  19. 19
  20. 20
  21. 21
  22. 22
  23. 23
  24. 24
  25. 25
  26. 26
  27. 27
  28. 28
  29. 29
  30. 30
  31. 31
  32. 32
  33. 33
  34. 34
  35. 35
  36. 36
  37. 37
  38. 38
  39. 39
  40. 40
// Copyright 2025 Shota FUJI
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0

public protocol Connectable: Actor {
	/// Roon server ID of the target Roon Core.
	var serverID: String { get }

	/// Host, mostly IPv4 address of the target Roon Core.
	var host: String { get }

	/// HTTP port to use for WebSocket connection to the target Roon Core.
	var port: UInt16 { get }

	/// Open a new connection if the current connection is closed.
	/// Throws when the current connection is already open.
	func connect() async throws

	/// Close the current connection.
	func disconnect()

	/// Waits for connection to be closed.
	///
	/// This method returns when the connection was closed.
	/// If the connection is already closed at the time of this method call,
	/// this method immediately returns.
	func lifetime() async
}