1. interface
  2. Hypervel
  3. \
  4. Contracts
  5. \
  6. Pool
  7. \
  8. PoolInterface

PoolInterface

interface PoolInterface

Methods

string
getName()

Get the pool name.

ConnectionInterface
get()

Get a connection from the connection pool.

void
release(ConnectionInterface $connection)

Release a connection back to the connection pool.

void
discard(ConnectionInterface $connection)

Discard a borrowed connection from the connection pool.

void
flush()

Close idle connections while the total managed count exceeds the configured minimum.

void
close()

Close the connection pool and release its resources.

bool
isClosed()

Determine if the connection pool is closed.

PoolOptionInterface
getOption()

Get the pool configuration options.

Details

at line 12
string getName()

Get the pool name.

Return Value

string

at line 17
ConnectionInterface get()

Get a connection from the connection pool.

Return Value

ConnectionInterface

at line 22
void release(ConnectionInterface $connection)

Release a connection back to the connection pool.

Parameters

ConnectionInterface $connection

Return Value

void

at line 27
void discard(ConnectionInterface $connection)

Discard a borrowed connection from the connection pool.

Parameters

ConnectionInterface $connection

Return Value

void

at line 32
void flush()

Close idle connections while the total managed count exceeds the configured minimum.

Return Value

void

at line 37
void close()

Close the connection pool and release its resources.

Return Value

void

at line 42
bool isClosed()

Determine if the connection pool is closed.

Return Value

bool

at line 47
PoolOptionInterface getOption()

Get the pool configuration options.

Return Value

PoolOptionInterface