1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
|
/*
* Copyright 2025 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef API_LOCAL_NETWORK_ACCESS_PERMISSION_H_
#define API_LOCAL_NETWORK_ACCESS_PERMISSION_H_
#include <memory>
#include "absl/functional/any_invocable.h"
#include "rtc_base/socket_address.h"
namespace webrtc {
// This interface defines methods to request a Local Network Access permission
// asynchronously. The LocalNetworkAccessPermissionInterface class encapsulates
// a single permission request.
//
// Usage:
// // An implementation of the factory should be passed in by the embedder.
// std::unique_ptr<LocalNetworkAccessPermissionFactoryInterface> factory =
// embedder_factory;
//
// Stores pending permission requests.
// std::vector<std::unique_ptr<LocalNetworkAccessPermissionInterface>>
// permission_list;
//
// std::unique_ptr<LocalNetworkAccessPermissionInterface> permission =
// factory->Create();
// permission->RequestPermission(
// target_address,
// [&, r = permission.get()](LocalNetworkAccessPermissionStatus status) {
// permission_list.erase(std::remove_if(
// permission_list.begin(), permission_list.end(),
// [&](const auto& refptr) { return refptr.get() == r; }));
//
// if (status == LocalNetworkAccessPermissionStatus::kGranted) {
// // Permission was granted.
// } else {
// // Permission was denied.
// }
// });
// permission_list.push_back(std::move(permission));
enum class LocalNetworkAccessPermissionStatus {
kGranted,
kDenied,
};
// The API for a single permission query.
// The constructor, destructor and all functions must be called from
// the same sequence, and the callback will also be called on that sequence.
// The class guarantees that the callback will not be called if the
// permission's destructor has been called.
class LocalNetworkAccessPermissionInterface {
public:
virtual ~LocalNetworkAccessPermissionInterface() = default;
// The callback will be called when the permission is granted or denied. The
// callback will be called on the sequence that the caller runs on.
virtual void RequestPermission(
const SocketAddress& addr,
absl::AnyInvocable<void(LocalNetworkAccessPermissionStatus)>
callback) = 0;
};
// An abstract factory for creating LocalNetworkPermissionInterfaces. This
// allows client applications to provide WebRTC with their own mechanism for
// checking and requesting Local Network Access permission.
class LocalNetworkAccessPermissionFactoryInterface {
public:
virtual ~LocalNetworkAccessPermissionFactoryInterface() = default;
// Creates a LocalNetworkAccessPermission.
virtual std::unique_ptr<LocalNetworkAccessPermissionInterface> Create() = 0;
};
} // namespace webrtc
#endif // API_LOCAL_NETWORK_ACCESS_PERMISSION_H_
|