OpenQuizz
Une application de gestion des contenus pédagogiques
ConnectionPoolListener Class Reference
Inheritance diagram for ConnectionPoolListener:
Collaboration diagram for ConnectionPoolListener:

Public Member Functions

def pool_created (self, event)
 
def pool_cleared (self, event)
 
def pool_closed (self, event)
 
def connection_created (self, event)
 
def connection_ready (self, event)
 
def connection_closed (self, event)
 
def connection_check_out_started (self, event)
 
def connection_check_out_failed (self, event)
 
def connection_checked_out (self, event)
 
def connection_checked_in (self, event)
 

Detailed Description

Abstract base class for connection pool listeners.

Handles all of the connection pool events defined in the Connection
Monitoring and Pooling Specification:
:class:`PoolCreatedEvent`, :class:`PoolClearedEvent`,
:class:`PoolClosedEvent`, :class:`ConnectionCreatedEvent`,
:class:`ConnectionReadyEvent`, :class:`ConnectionClosedEvent`,
:class:`ConnectionCheckOutStartedEvent`,
:class:`ConnectionCheckOutFailedEvent`,
:class:`ConnectionCheckedOutEvent`,
and :class:`ConnectionCheckedInEvent`.

.. versionadded:: 3.9

Member Function Documentation

◆ connection_check_out_failed()

def connection_check_out_failed (   self,
  event 
)
Abstract method to handle a :class:`ConnectionCheckOutFailedEvent`.

Emitted when the driver's attempt to check out a connection fails.

:Parameters:
  - `event`: An instance of :class:`ConnectionCheckOutFailedEvent`.

Reimplemented in ConnectionPoolLogger.

◆ connection_check_out_started()

def connection_check_out_started (   self,
  event 
)
Abstract method to handle a :class:`ConnectionCheckOutStartedEvent`.

Emitted when the driver starts attempting to check out a connection.

:Parameters:
  - `event`: An instance of :class:`ConnectionCheckOutStartedEvent`.

Reimplemented in ConnectionPoolLogger.

◆ connection_checked_in()

def connection_checked_in (   self,
  event 
)
Abstract method to handle a :class:`ConnectionCheckedInEvent`.

Emitted when the driver checks in a Connection back to the Connection
Pool.

:Parameters:
  - `event`: An instance of :class:`ConnectionCheckedInEvent`.

Reimplemented in ConnectionPoolLogger.

◆ connection_checked_out()

def connection_checked_out (   self,
  event 
)
Abstract method to handle a :class:`ConnectionCheckedOutEvent`.

Emitted when the driver successfully checks out a Connection.

:Parameters:
  - `event`: An instance of :class:`ConnectionCheckedOutEvent`.

Reimplemented in ConnectionPoolLogger.

◆ connection_closed()

def connection_closed (   self,
  event 
)
Abstract method to handle a :class:`ConnectionClosedEvent`.

Emitted when a Connection Pool closes a Connection.

:Parameters:
  - `event`: An instance of :class:`ConnectionClosedEvent`.

Reimplemented in ConnectionPoolLogger.

◆ connection_created()

def connection_created (   self,
  event 
)
Abstract method to handle a :class:`ConnectionCreatedEvent`.

Emitted when a Connection Pool creates a Connection object.

:Parameters:
  - `event`: An instance of :class:`ConnectionCreatedEvent`.

Reimplemented in ConnectionPoolLogger.

◆ connection_ready()

def connection_ready (   self,
  event 
)
Abstract method to handle a :class:`ConnectionReadyEvent`.

Emitted when a Connection has finished its setup, and is now ready to
use.

:Parameters:
  - `event`: An instance of :class:`ConnectionReadyEvent`.

Reimplemented in ConnectionPoolLogger.

◆ pool_cleared()

def pool_cleared (   self,
  event 
)
Abstract method to handle a `PoolClearedEvent`.

Emitted when a Connection Pool is cleared.

:Parameters:
  - `event`: An instance of :class:`PoolClearedEvent`.

Reimplemented in ConnectionPoolLogger.

◆ pool_closed()

def pool_closed (   self,
  event 
)
Abstract method to handle a `PoolClosedEvent`.

Emitted when a Connection Pool is closed.

:Parameters:
  - `event`: An instance of :class:`PoolClosedEvent`.

Reimplemented in ConnectionPoolLogger.

◆ pool_created()

def pool_created (   self,
  event 
)
Abstract method to handle a :class:`PoolCreatedEvent`.

Emitted when a Connection Pool is created.

:Parameters:
  - `event`: An instance of :class:`PoolCreatedEvent`.

Reimplemented in ConnectionPoolLogger.


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