AbstractBatchGetRequest

java.lang.Object
- xal.ca.AbstractBatchGetRequest<RecordType>

All Implemented Interfaces:: BatchConnectionRequestListener

Direct Known Subclasses:: BatchGetValueRequest, BatchGetValueTimeRequest

public abstract class AbstractBatchGetRequest<RecordType extends ChannelRecord>
extends java.lang.Object
implements BatchConnectionRequestListener

AbstractBatchGetRequest

Constructor Summary

Constructors
Constructor and Description

AbstractBatchGetRequest(java.util.Collection<Channel> channels)
Primary Constructor

Constructors
Constructor and Description
`AbstractBatchGetRequest(java.util.Collection<Channel> channels)` Primary Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBatchGetRequestListener(BatchGetRequestListener<RecordType> listener)` add the specified listener as a receiver of batch get request events from this instance
`void`	`addChannel(Channel channel)` add a new channel to the batch request
`boolean`	`await(double timeout)` Synonym for waitForCompletion.
`void`	`batchConnectionRequestCompleted(BatchConnectionRequest connectionRequest, int connectedCount, int disconnectedCount, int exceptionCount)` event indicating that the batch request is complete
`void`	`connectionChangeInBatch(BatchConnectionRequest connectionRequest, Channel channel, boolean connected)` event indicating that a connection change has occurred for a channel
`void`	`connectionExceptionInBatch(BatchConnectionRequest connectionRequest, Channel channel, java.lang.Exception exception)` event indicating that an exception has been thrown for a channel
`protected void`	`finalize()` dispose of the executors
`java.util.Collection<Channel>`	`getChannels()` get the collection of channels to process
`java.lang.Exception`	`getException(Channel channel)` Get the exception if any for the specified channel
`int`	`getExceptionCount()` Get the number of exceptions
`java.util.Set<Channel>`	`getFailedChannels()` Get the failed channels for which exceptions were thrown during the request
`RecordType`	`getRecord(Channel channel)` Get the record if any for the specified channel
`int`	`getRecordCount()` get the number of records
`java.util.Set<Channel>`	`getResultChannels()` Get the channels which produced a result
`boolean`	`hasExceptions()` determine if there were any exceptions
`boolean`	`isComplete()` determine if there are any channels pending for either an exception or a completed get request
`protected void`	`processCurrentStatus()` check for the current status and post notifications if necessary
`protected void`	`processRecordEvent(Channel channel, RecordType record)` Process the receipt of a new record event
`protected void`	`processRequest(Channel channel)` Process the get request for a single channel
`void`	`removeBatchGetRequestListener(BatchGetRequestListener<RecordType> listener)` remove the specified listener from receiving batch get request events from this instance
`protected abstract void`	`requestChannelData(Channel channel)` Request to get the data for the channel
`void`	`submit()` submit as a batch the get requests for each channel
`boolean`	`submitAndWait(double timeout)` Submit a batch of get requests and wait for the requests to be completed or timeout.
`boolean`	`waitForCompletion(double timeout)` Wait up to the specified timeout for completion.

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

- Constructor Detail
  - AbstractBatchGetRequest
```
public AbstractBatchGetRequest(java.util.Collection<Channel> channels)
```
    Primary Constructor
    
    Parameters:
    
    channels - the channels for which get requests will be handled
- Method Detail
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    dispose of the executors
    
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable
  - addBatchGetRequestListener
```
public void addBatchGetRequestListener(BatchGetRequestListener<RecordType> listener)
```
    add the specified listener as a receiver of batch get request events from this instance
    
    Parameters:
    
    listener - a receiver which will receive events
  - removeBatchGetRequestListener
```
public void removeBatchGetRequestListener(BatchGetRequestListener<RecordType> listener)
```
    remove the specified listener from receiving batch get request events from this instance
    
    Parameters:
    
    listener - receiver to remove from receiving events
  - addChannel
```
public void addChannel(Channel channel)
```
    add a new channel to the batch request
    
    Parameters:
    
    channel - a channel to add to the batch request
  - getChannels
```
public java.util.Collection<Channel> getChannels()
```
    get the collection of channels to process
    
    Returns:
    
    a copy of the list of channels in the batch request
  - submit
```
public void submit()
```
    submit as a batch the get requests for each channel
  - submitAndWait
```
public boolean submitAndWait(double timeout)
```
    Submit a batch of get requests and wait for the requests to be completed or timeout. Note that if this is called, within a channel access callback, requests will not be processed until the callback completes, so it is useless to wait. Instead, call waitForCompletion separately outside of the callback.
    
    Parameters:
    
    timeout - the maximum time in seconds to wait for completion
    
    Returns:
    
    true if complete or false if not
  - await
```
public boolean await(double timeout)
```
    Synonym for waitForCompletion. Wait up to the specified timeout for completion. This method should be called outside of a Channel Access callback otherwise events will not be processed.
    
    Parameters:
    
    timeout - the maximum time in seconds to wait for completion
    
    Returns:
    
    true if complete or false if not
  - waitForCompletion
```
public boolean waitForCompletion(double timeout)
```
    Wait up to the specified timeout for completion. This method should be called outside of a Channel Access callback otherwise events will not be processed.
    
    Parameters:
    
    timeout - the maximum time in seconds to wait for completion
    
    Returns:
    
    true if complete or false if not
  - requestChannelData
```
protected abstract void requestChannelData(Channel channel)
                                    throws java.lang.Exception
```
    Request to get the data for the channel
    
    Parameters:
    
    channel - the channel for which to request data
    
    Throws:
    
    java.lang.Exception - when the request fails
  - processRequest
```
protected void processRequest(Channel channel)
```
    Process the get request for a single channel
    
    Parameters:
    
    channel - the channel for which to process the request
  - isComplete
```
public boolean isComplete()
```
    determine if there are any channels pending for either an exception or a completed get request
    
    Returns:
    
    true if complete and false if not
  - hasExceptions
```
public boolean hasExceptions()
```
    determine if there were any exceptions
    
    Returns:
    
    true if there are any exceptions and false if not
  - getRecordCount
```
public int getRecordCount()
```
    get the number of records
    
    Returns:
    
    the number of records
  - getExceptionCount
```
public int getExceptionCount()
```
    Get the number of exceptions
    
    Returns:
    
    the number of channels for which there was an exception during the request
  - getRecord
```
public RecordType getRecord(Channel channel)
```
    Get the record if any for the specified channel
    
    Parameters:
    
    channel - the channel for which the record is fetched
    
    Returns:
    
    the record for the specified channel or null if there is none
  - getException
```
public java.lang.Exception getException(Channel channel)
```
    Get the exception if any for the specified channel
    
    Parameters:
    
    channel - the channel for which the exception is fetched
    
    Returns:
    
    the exception for the specified channel or null if there is none
  - getFailedChannels
```
public java.util.Set<Channel> getFailedChannels()
```
    Get the failed channels for which exceptions were thrown during the request
    
    Returns:
    
    the set of failed channels
  - getResultChannels
```
public java.util.Set<Channel> getResultChannels()
```
    Get the channels which produced a result
    
    Returns:
    
    the set of channels each for which a record was successfully fetched
  - processRecordEvent
```
protected void processRecordEvent(Channel channel,
                                  RecordType record)
```
    Process the receipt of a new record event
    
    Parameters:
    
    channel - the channel for which the event will be processed
    
    record - the fetched record
  - processCurrentStatus
```
protected void processCurrentStatus()
```
    check for the current status and post notifications if necessary
  - batchConnectionRequestCompleted
```
public void batchConnectionRequestCompleted(BatchConnectionRequest connectionRequest,
                                            int connectedCount,
                                            int disconnectedCount,
                                            int exceptionCount)
```
    event indicating that the batch request is complete
    
    Specified by:
    
    batchConnectionRequestCompleted in interface BatchConnectionRequestListener
    
    Parameters:
    
    connectionRequest - request for which the connection completed
    
    connectedCount - number of channels connected
    
    disconnectedCount - number of channels disconnected
    
    exceptionCount - number of channels for which there were connection exceptions
  - connectionExceptionInBatch
```
public void connectionExceptionInBatch(BatchConnectionRequest connectionRequest,
                                       Channel channel,
                                       java.lang.Exception exception)
```
    event indicating that an exception has been thrown for a channel
    
    Specified by:
    
    connectionExceptionInBatch in interface BatchConnectionRequestListener
    
    Parameters:
    
    connectionRequest - in which the exception occured
    
    channel - for which the exception occured
    
    exception - the exception thrown while attempting to connect
  - connectionChangeInBatch
```
public void connectionChangeInBatch(BatchConnectionRequest connectionRequest,
                                    Channel channel,
                                    boolean connected)
```
    event indicating that a connection change has occurred for a channel
    
    Specified by:
    
    connectionChangeInBatch in interface BatchConnectionRequestListener
    
    Parameters:
    
    connectionRequest - in which the connection changed
    
    channel - for which the connection changed
    
    connected - status of the connection (true for connected and false for disconnected)

Class AbstractBatchGetRequest<RecordType extends ChannelRecord>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractBatchGetRequest

Method Detail

finalize

addBatchGetRequestListener

removeBatchGetRequestListener

addChannel

getChannels

submit

submitAndWait

await

waitForCompletion

requestChannelData

processRequest

isComplete

hasExceptions

getRecordCount

getExceptionCount

getRecord

getException

getFailedChannels

getResultChannels

processRecordEvent

processCurrentStatus

batchConnectionRequestCompleted

connectionExceptionInBatch

connectionChangeInBatch