/*
 * DiscoveryManagerListener
 * Connect SDK
 * 
 * Copyright (c) 2014 LG Electronics.
 * Created by Hyun Kook Khang on 19 Jan 2014
 * 
 * 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.
 */

package com.connectsdk.discovery;

import com.connectsdk.device.ConnectableDevice;
import com.connectsdk.service.command.ServiceCommandError;

/**
 * ###Overview
 * The DiscoveryManagerListener will receive events on the addition/removal/update of ConnectableDevice objects.
 *
 * ###In Depth
 * It is important to note that, unless you are implementing your own device picker, this listener is not needed in your code. Connect SDK's DevicePicker internally acts a separate listener to the DiscoveryManager and handles all of the same method calls.
 */
public interface DiscoveryManagerListener {

    /**
     * This method will be fired upon the first discovery of one of a ConnectableDevice's DeviceServices.
     *
     * @param manager DiscoveryManager that found device
     * @param device ConnectableDevice that was found
     */
    public void onDeviceAdded(DiscoveryManager manager, ConnectableDevice device);

    /**
     * This method is called when a ConnectableDevice gains or loses a DeviceService in discovery.
     *
     * @param manager DiscoveryManager that updated device
     * @param device ConnectableDevice that was updated
     */
    public void onDeviceUpdated(DiscoveryManager manager, ConnectableDevice device);

    /**
     * This method is called when connections to all of a ConnectableDevice's DeviceServices are lost. This will usually happen when a device is powered off or loses internet connectivity.
     *
     * @param manager DiscoveryManager that lost device
     * @param device ConnectableDevice that was lost
     */
    public void onDeviceRemoved(DiscoveryManager manager, ConnectableDevice device);

    /**
     * In the event of an error in the discovery phase, this method will be called.
     *
     * @param manager DiscoveryManager that experienced the error
     * @param error NSError with a description of the failure
     */
    public void onDiscoveryFailed(DiscoveryManager manager, ServiceCommandError error);
}