thread.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
 * Copyright (C) 2019, Google Inc.
 *
 * Thread support
 */
 
#pragma once
 
#include <memory>
#include <string>
#include <sys/types.h>
#include <thread>
 
#include <libcamera/base/private.h>
 
#include <libcamera/base/class.h>
#include <libcamera/base/message.h>
#include <libcamera/base/signal.h>
#include <libcamera/base/span.h>
#include <libcamera/base/utils.h>
 
namespace libcamera {
 
class EventDispatcher;
class Message;
class Object;
class ThreadData;
class ThreadMain;
 
class Thread
{
public:
    Thread(std::string name = {});
    virtual ~Thread();
 
    void start();
    void exit(int code = 0);
    bool wait(utils::duration duration = utils::duration::max());
 
    int setThreadAffinity(const Span<const unsigned int> &cpus);
 
    bool isRunning();
 
    Signal<> finished;
 
    static Thread *current();
    static pid_t currentId();
 
    EventDispatcher *eventDispatcher();
 
    void dispatchMessages(Message::Type type = Message::Type::None,
                  Object *receiver = nullptr);
    void removeMessages(Object *receiver);
 
protected:
    int exec();
    virtual void run();
 
private:
    LIBCAMERA_DISABLE_COPY_AND_MOVE(Thread)
 
    void startThread();
    void finishThread();
 
    void setThreadAffinityInternal();
 
    void postMessage(std::unique_ptr<Message> msg, Object *receiver);
 
    friend class Object;
    friend class ThreadData;
    friend class ThreadMain;
 
    void moveObject(Object *object);
    void moveObject(Object *object, ThreadData *currentData,
            ThreadData *targetData);
 
    std::string name_;
    std::thread thread_;
    std::unique_ptr<ThreadData> data_;
};
 
} /* namespace libcamera */