1 /* 2 * Copyright (c) 2021, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** 30 * @file 31 * This file includes definitions of the vendor server. The implementation of the 32 * vendor server should be implemented by users. 33 */ 34 #ifndef OTBR_AGENT_VENDOR_HPP_ 35 #define OTBR_AGENT_VENDOR_HPP_ 36 37 #include "openthread-br/config.h" 38 39 #include "agent/application.hpp" 40 41 namespace otbr { 42 43 class Application; 44 45 namespace vendor { 46 47 /** 48 * An interface for customized behavior depending on OpenThread API and state. 49 */ 50 class VendorServer 51 { 52 public: 53 virtual ~VendorServer(void) = default; 54 55 /** 56 * Creates a new instance of VendorServer. 57 * 58 * Custom vendor servers should implement this method to return an object of the derived class. 59 * 60 * @param[in] aApplication The OTBR application. 61 * 62 * @returns New derived VendorServer instance. 63 */ 64 static std::shared_ptr<VendorServer> newInstance(Application &aApplication); 65 66 /** 67 * Initializes the vendor server. 68 * 69 * This will be called by `Application::Init()` after OpenThread instance and other built-in 70 * servers have been created and initialized. 71 */ 72 virtual void Init(void) = 0; 73 }; 74 75 } // namespace vendor 76 } // namespace otbr 77 #endif // OTBR_AGENT_VENDOR_HPP_ 78