blob: c8c9053f878ff3a3cb0ae10c19cc762f797c4282 [file] [log] [blame]
/*
*
* Copyright (c) 2020 Project CHIP Authors
* All rights reserved.
*
* 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.
*/
#pragma once
#include <controller/DeviceDiscoveryDelegate.h>
#include <lib/dnssd/ResolverProxy.h>
#include <lib/support/Span.h>
#include <platform/CHIPDeviceConfig.h>
namespace chip {
namespace Controller {
/**
* @brief
* Convenient superclass for controller implementations that need to discover
* Commissioners or CommissionableNodes using mDNS. This Abstract class
* provides base implementations for logic to setup mDNS discovery requests,
* handling of received DiscoveredNodeData, etc. while expecting child classes
* to maintain a list of DiscoveredNodes and providing the implementation
* of the template GetDiscoveredNodes() function.
*/
class DLL_EXPORT AbstractDnssdDiscoveryController : public Dnssd::DiscoverNodeDelegate
{
public:
explicit AbstractDnssdDiscoveryController(Dnssd::Resolver * resolver = nullptr) : mDNSResolver(resolver) {}
void OnNodeDiscovered(const chip::Dnssd::DiscoveredNodeData & nodeData) override;
CHIP_ERROR StopDiscovery() { return mDNSResolver.StopDiscovery(); };
protected:
using DiscoveredNodeList = FixedSpan<Dnssd::DiscoveredNodeData, CHIP_DEVICE_CONFIG_MAX_DISCOVERED_NODES>;
CHIP_ERROR SetUpNodeDiscovery();
const Dnssd::DiscoveredNodeData * GetDiscoveredNode(int idx);
virtual DiscoveredNodeList GetDiscoveredNodes() = 0;
DeviceDiscoveryDelegate * mDeviceDiscoveryDelegate = nullptr;
Dnssd::ResolverProxy mDNSResolver;
};
} // namespace Controller
} // namespace chip