lldb/API/SBQueue.h

0001 //===-- SBQueue.h -----------------------------------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLDB_API_SBQUEUE_H
0010 #define LLDB_API_SBQUEUE_H
0011
0012 #include <vector>
0013
0014 #include "lldb/API/SBDefines.h"
0015 #include "lldb/lldb-forward.h"
0016
0017 namespace lldb {
0018
0019 class LLDB_API SBQueue {
0020 public:
0021   SBQueue();
0022
0023   SBQueue(const SBQueue &rhs);
0024
0025   const SBQueue &operator=(const lldb::SBQueue &rhs);
0026
0027   ~SBQueue();
0028
0029   explicit operator bool() const;
0030
0031   bool IsValid() const;
0032
0033   void Clear();
0034
0035   lldb::SBProcess GetProcess();
0036
0037   lldb::queue_id_t GetQueueID() const;
0038
0039   const char *GetName() const;
0040
0041   uint32_t GetIndexID() const;
0042
0043   uint32_t GetNumThreads();
0044
0045   lldb::SBThread GetThreadAtIndex(uint32_t);
0046
0047   uint32_t GetNumPendingItems();
0048
0049   lldb::SBQueueItem GetPendingItemAtIndex(uint32_t);
0050
0051   uint32_t GetNumRunningItems();
0052
0053   lldb::QueueKind GetKind();
0054
0055 protected:
0056   friend class SBProcess;
0057   friend class SBThread;
0058
0059   SBQueue(const QueueSP &queue_sp);
0060
0061   void SetQueue(const lldb::QueueSP &queue_sp);
0062
0063 private:
0064   std::shared_ptr<lldb_private::QueueImpl> m_opaque_sp;
0065 };
0066
0067 } // namespace lldb
0068
0069 #endif // LLDB_API_SBQUEUE_H