SoDaThread.hxx

Go to the documentation of this file.

/*
Copyright (c) 2012,2013,2014,2019, 2025, 2026 Matthew H. Reilly (kb1vc)
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
 
    Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
    Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#pragma once
 
#include "SoDaBase.hxx"
 
#include <string>
#include "Debug.hxx"
#include <thread>
#include <chrono>
#include <mutex>
#include <memory>
#include <condition_variable>
 
#include <SoDa/MailBox.hxx>
 
#include "version.h"
 
 
namespace SoDa {
  
  class BaseMBox; 
  class Command;
 
  class Thread;
  typedef std::shared_ptr<Thread> ThreadPtr;
  typedef std::weak_ptr<Thread> ThreadWeakPtr;
  
  class Thread : public Base, public Debug {
  protected:
    
    Thread(const std::string & oname, const std::string & version = std::string(SoDaRadio_VERSION));
 
  public:
    void registerThread(SoDa::ThreadPtr me);
    
    virtual void subscribeToMailBoxes(const std::vector<MailBoxBasePtr> & mailboxes) = 0;
  public:
    
    void operator() () {
      // we woke up with a "start" or "join" call
      outerRun();
    }

    void start() {
      thread_ptr = std::unique_ptr<std::thread>(new std::thread(&SoDa::Thread::outerRun, this));
    }

    void join() {
      thread_ptr->join(); 
    }

    virtual void run() {
      std::cerr << "Thread " << getObjName() << " has no run method\n";
    }

    void execCommand(CommandPtr cmd);
    
    virtual void execGetCommand(CommandPtr cmd) { (void) cmd; }

    virtual void execSetCommand(CommandPtr cmd) { (void) cmd; }

    virtual void execRepCommand(CommandPtr cmd) { (void) cmd; } 

    virtual void shutDown() {
      return; 
    }
 
    void sleep_ms(unsigned int milliseconds) {
      std::this_thread::sleep_for(std::chrono::milliseconds(milliseconds));
    }
    void sleep_us(unsigned int microseconds) {
      std::this_thread::sleep_for(std::chrono::microseconds(microseconds));
    }
 
    uint32_t getID();
    
  protected:
    std::weak_ptr<Thread> self;
 
  private:
    std::unique_ptr<std::thread> thread_ptr;
 
    
    void outerRun();
    
    static void sigsegHandler(int sig);
    
    void hookSigSeg();
 
    std::string version; 
  };
 
  class MissingMailBox : public SDR::Exception {
  public:
    MissingMailBox(const std::string & mbox_name, BasePtr thrower) :
      SDR::Exception(SoDa::Format("Mailbox %0 could not be found.").addS(mbox_name).str(),
               thrower)
    {
    }
  };
  
}