48 lines
1.4 KiB
Swift
48 lines
1.4 KiB
Swift
//
|
|
// ServerProtocol.swift
|
|
// XIONControlPanel
|
|
//
|
|
// Created by James Magahern on 3/13/20.
|
|
// Copyright © 2020 XION. All rights reserved.
|
|
//
|
|
|
|
import Foundation
|
|
|
|
enum ConnectionStatus: Equatable
|
|
{
|
|
case disconnected
|
|
case connecting
|
|
case connected
|
|
case error
|
|
}
|
|
|
|
protocol ServerDelegate: AnyObject
|
|
{
|
|
func server(_ server: Server, deviceChangedState: AnyDevice)
|
|
func server(_ server: Server, connectionStatusChanged status: ConnectionStatus)
|
|
}
|
|
|
|
protocol Server: AnyObject
|
|
{
|
|
var connectionStatus: ConnectionStatus { get }
|
|
var delegate: ServerDelegate? { get set }
|
|
|
|
/// Designated initializer. Takes an API endpoint URL
|
|
init(_ url: URL)
|
|
|
|
/// Attempts to connect to the server at the specified endpoint.
|
|
func connect(_ completion: @escaping (Error?) -> Void)
|
|
|
|
/// Sets server's state as "disconnected"
|
|
func disconnect(_ completion: (Error?) -> Void)
|
|
|
|
/// Fetches a list of all currently configured devices for this server, or returns an error.
|
|
func fetchDevices(_ completion: @escaping (Result<[AnyDevice], Error>) -> Void)
|
|
|
|
/// Tells the server to set the state of a given device to the given state
|
|
func toggleDevice(_ device: AnyDevice, state: DeviceState, completion: @escaping (Error?) -> Void)
|
|
|
|
/// Returns true if this is a device this server is responsible for
|
|
func responsibleForDevice(_ device: AnyDevice) -> Bool
|
|
}
|