ConnectionQueue (cssoftware-app 1.0.16 API)

java.lang.Object
- com.cs.software.engine.datastore.database.ConnectionQueue

public class ConnectionQueue
extends Object

Describe class Queue here.

Author:: Steve Crombie

Constructor Summary

Constructors
Constructor and Description
`ConnectionQueue(DBAccess aDBAccess, String aPoolName, String anUrl, String anUser, String aPassword, int aMinPool, int aMaxPool, boolean aReadOnly)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConnection(JDCConnection aCon)` Synchronized - Adds a connection that is now available for use to the list of connections
`void`	`addConnectionInUse(JDCConnection aCon)`
`void`	`addReader(ConnectionPool aReader)` Synchronized - Will add a new Reader (PoolMgr) to the Queue
`void`	`addWriter(JDCConnection aWriter)` Synchronized - Will add a new Worker to the Queue
`void`	`close()` Will remove all messages from the queue and remove the queue
`JDCConnection`	`createConnection()`
`JDCConnection`	`getConnection()` Synchronized - Will retrieve the next Thread from the queue note: This call will block until a message is received
`JDCConnection`	`getConnectionNoWait()` Will retrieve the next available Connection from the queue note: This call will NOT BLOCK if not Connection returns null
`int`	`getMaxPoolSize()`
`int`	`getMinPoolSize()`
`String`	`getPoolName()`
`int`	`getPoolSize()`
`String`	`getQueueName()` Returns the Queue Reference Name
`void`	`removeConnection(JDCConnection aCon)`
`void`	`removeReader(ConnectionPool aReader)` Synchronized - Will remove a Reader (PoolMgr) from the Queue
`void`	`removeWriter(JDCConnection aWriter)` Synchronized - Will remove a Worker from the Queue
`int`	`size()` Synchronized - Will return the number of messages left in the Queue
`void`	`wakeUp()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConnectionQueue
```
public ConnectionQueue(DBAccess aDBAccess,
                       String aPoolName,
                       String anUrl,
                       String anUser,
                       String aPassword,
                       int aMinPool,
                       int aMaxPool,
                       boolean aReadOnly)
                throws SQLException
```
    Parameters:
    
    aDBAccess - db
    
    aPoolName - pool name
    
    anUrl - url
    
    anUser - user
    
    aPassword - pass
    
    aMinPool - min
    
    aMaxPool - max
    
    aReadOnly - read only
    
    Throws:
    
    SQLException - sql
- Method Detail
  - getQueueName
```
public String getQueueName()
```
    Returns the Queue Reference Name
    
    Returns:
    
    String Queue Reference Name
  - wakeUp
```
public void wakeUp()
```
  - addConnection
```
public void addConnection(JDCConnection aCon)
```
    Synchronized - Adds a connection that is now available for use to the list of connections
    
    Parameters:
    
    aCon - connection
  - addConnectionInUse
```
public void addConnectionInUse(JDCConnection aCon)
```
  - removeConnection
```
public void removeConnection(JDCConnection aCon)
```
  - getConnection
```
public JDCConnection getConnection()
```
    Synchronized - Will retrieve the next Thread from the queue note: This call will block until a message is received
    
    Returns:
    
    WorkerThread next Thread ready for work
  - getPoolName
```
public String getPoolName()
```
  - getMinPoolSize
```
public int getMinPoolSize()
```
  - getMaxPoolSize
```
public int getMaxPoolSize()
```
  - createConnection
```
public JDCConnection createConnection()
                               throws SQLException
```
    Throws:
    
    SQLException
  - getConnectionNoWait
```
public JDCConnection getConnectionNoWait()
```
    Will retrieve the next available Connection from the queue note: This call will NOT BLOCK if not Connection returns null
    
    Returns:
    
    JDCConnection next available connection
  - size
```
public int size()
```
    Synchronized - Will return the number of messages left in the Queue
    
    Returns:
    
    int number of messages
  - getPoolSize
```
public int getPoolSize()
```
  - close
```
public void close()
```
    Will remove all messages from the queue and remove the queue
  - addReader
```
public void addReader(ConnectionPool aReader)
```
    Synchronized - Will add a new Reader (PoolMgr) to the Queue
    
    Parameters:
    
    aReader - QueueReader New queue reader (PoolMgr) object
  - removeReader
```
public void removeReader(ConnectionPool aReader)
```
    Synchronized - Will remove a Reader (PoolMgr) from the Queue
    
    Parameters:
    
    aReader - PoolMgr Is a reader object
  - addWriter
```
public void addWriter(JDCConnection aWriter)
```
    Synchronized - Will add a new Worker to the Queue
    
    Parameters:
    
    aWriter - Worker New queue worker object
  - removeWriter
```
public void removeWriter(JDCConnection aWriter)
```
    Synchronized - Will remove a Worker from the Queue
    
    Parameters:
    
    aWriter - Worker Class which performs work

Class ConnectionQueue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectionQueue

Method Detail

getQueueName

wakeUp

addConnection

addConnectionInUse

removeConnection

getConnection

getPoolName

getMinPoolSize

getMaxPoolSize

createConnection

getConnectionNoWait

size

getPoolSize

close

addReader

removeReader

addWriter

removeWriter