stub_client_death_observer.h

Go to the documentation of this file.

/*
 * Copyright © 2016 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Jim Hodapp <jim.hodapp@canonical.com>
 */
 
#ifndef CORE_UBUNTU_MEDIA_STUB_CLIENT_DEATH_OBSERVER_H_
#define CORE_UBUNTU_MEDIA_STUB_CLIENT_DEATH_OBSERVER_H_
 
#include <core/media/client_death_observer.h>
 
namespace core
{
namespace ubuntu
{
namespace media
{
// Models functionality to be notified whenever a client
// of the service goes away, and thus allows us to clean
// up in that case.
// Generic empty implementation.
class StubClientDeathObserver : public ClientDeathObserver,
                                public std::enable_shared_from_this<StubClientDeathObserver>
{
public:
    // Our static callback that we inject to the hybris world.
    static void on_client_died_cb(void* context);
 
    // Creates an instance of the StubClientDeathObserver or throws
    // if the underlying platform does not support it.
    static ClientDeathObserver::Ptr create();
 
    // Make std::unique_ptr happy for forward declared Private internals.
    ~StubClientDeathObserver();
 
    // Registers the client with the given key for death notifications.
    void register_for_death_notifications_with_key(const Player::PlayerKey&) override;
 
    // Emitted whenever a client dies, reporting the key under which the
    // respective client was known.
    const core::Signal<Player::PlayerKey>& on_client_with_key_died() const override;
 
private:
    StubClientDeathObserver();
 
    core::Signal<media::Player::PlayerKey> client_with_key_died;
};
}
}
}
 
#endif // CORE_UBUNTU_MEDIA_STUB_CLIENT_DEATH_OBSERVER_H_