gil_scoped_acquire Class Reference

#include <gil.h>

Public Member Functions
PYBIND11_NOINLINE void	dec_ref ()
PYBIND11_NOINLINE void	disarm ()
PYBIND11_NOINLINE	gil_scoped_acquire ()
	gil_scoped_acquire (const gil_scoped_acquire &)=delete
void	inc_ref ()
gil_scoped_acquire &	operator= (const gil_scoped_acquire &)=delete
PYBIND11_NOINLINE	~gil_scoped_acquire ()

Private Attributes
bool	active = true
bool	release = true
PyThreadState *	tstate = nullptr

Detailed Description

Definition at line 53 of file gil.h.

Constructor & Destructor Documentation

gil_scoped_acquire() [1/2]

PYBIND11_NOINLINE gil_scoped_acquire::gil_scoped_acquire ( )

inline

Definition at line 55 of file gil.h.

gil_scoped_acquire() [2/2]

gil_scoped_acquire::gil_scoped_acquire ( const gil_scoped_acquire &  )

delete

~gil_scoped_acquire()

PYBIND11_NOINLINE gil_scoped_acquire::~gil_scoped_acquire ( )

inline

Definition at line 125 of file gil.h.

Member Function Documentation

dec_ref()

PYBIND11_NOINLINE void gil_scoped_acquire::dec_ref ( )

inline

Definition at line 93 of file gil.h.

disarm()

PYBIND11_NOINLINE void gil_scoped_acquire::disarm ( )

inline

This method will disable the PyThreadState_DeleteCurrent call and the GIL won't be acquired. This method should be used if the interpreter could be shutting down when this is called, as thread deletion is not allowed during shutdown. Check _Py_IsFinalizing() on Python 3.7+, and protect subsequent code.

Definition at line 123 of file gil.h.

inc_ref()

void gil_scoped_acquire::inc_ref ( )

inline

Definition at line 91 of file gil.h.

operator=()

gil_scoped_acquire& gil_scoped_acquire::operator= ( const gil_scoped_acquire &  )

delete

Member Data Documentation

active

bool gil_scoped_acquire::active = true

private

Definition at line 135 of file gil.h.

release

bool gil_scoped_acquire::release = true

private

Definition at line 134 of file gil.h.

tstate

PyThreadState* gil_scoped_acquire::tstate = nullptr

private

Definition at line 133 of file gil.h.

---

The documentation for this class was generated from the following file:

• gil.h