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::Thread. 20 // 21 // This wrapper means that the user is not required to provide the indirection 22 // callback to call run based on the passed context. For example instead of: 23 // 24 // static auto invoke_foo_start = [](void *void_foo_ptr) { 25 // static_cast<Foo*>(void_foo_ptr)->Start(); 26 // }; 27 // Thread thread(options, invoke_foo_start, &foo).detach(); 28 // 29 // You can instead use the helper constructor in Thread: 30 // 31 // Thread thread(options, foo).detach(); 32 // 33 // WARNING: Because the thread may start after the pw::Thread creation, an 34 // object which implements the ThreadCore MUST meet or exceed the lifetime of 35 // its thread of execution! 36 class ThreadCore { 37 public: 38 virtual ~ThreadCore() = default; 39 40 // The public API to start a ThreadCore, note that this may return. Start()41 void Start() { Run(); } 42 43 private: 44 // This function may return. 45 virtual void Run() = 0; 46 }; 47 48 } // namespace pw::thread 49