1 // Copyright 2021 The Pigweed Authors 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not 4 // use this file except in compliance with the License. You may obtain a copy of 5 // the License at 6 // 7 // https://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 12 // License for the specific language governing permissions and limitations under 13 // the License. 14 #pragma once 15 16 namespace pw::thread { 17 18 // An optional virtual interface which can be implemented by objects which are 19 // a thread as a helper to use pw::Thread. 20 // 21 // ThreadCore was originally intended to avoid indirection when threads were 22 // constructed from a function pointer and void* argument. Since Thread now uses 23 // pw::Function<void()>, ThreadCore is no longer necessary. Its use is 24 // discouraged in new code. 25 // 26 // WARNING: Because the thread may start after the pw::Thread creation, an 27 // object which implements the ThreadCore MUST meet or exceed the lifetime of 28 // its thread of execution! 29 class ThreadCore { 30 public: 31 virtual ~ThreadCore() = default; 32 33 // The public API to start a ThreadCore, note that this may return. Start()34 void Start() { Run(); } 35 36 private: 37 // This function may return. 38 virtual void Run() = 0; 39 }; 40 41 } // namespace pw::thread 42