Receiver

java.lang.Object
- org.qbroker.receiver.Receiver

All Implemented Interfaces:

MessageReceiver

Direct Known Subclasses:

DocumentReceiver, FileReceiver, HeartbeatGenerator, JDBCReceiver, JMSReceiver, JMSSubscriber, JMXReceiver, LogReceiver, LogScissor, PacketReceiver, RedisReceiver, RMQReceiver, ServerListener, ServerReceiver, StreamReceiver
```
public abstract class Receiver
extends java.lang.Object
implements MessageReceiver
```
Receiver is an abstract class of MessageReceiver.

tolerance: not used
maxRetry: number of times to reconnect in one period
repeatPeriod: quietPeriod + maxRetry, period of repeat operation
pauseTime: sleepTime in millisec for PAUSE state or default baseTime
standbyTime: sleepTime in millisec for STANDBY state or reconnect action
timeout: timeout in millisec to reset retryCount for a new session
waitTime: sleep time in millisec for disable action

RCVR_READY connected and ready to work
RCVR_RUNNING running normally
RCVR_RETRYING trying to get back to running state
RCVR_PAUSE pausing for a bit while still connected
RCVR_STANDBY standby for a bit longer while still connected
RCVR_DISABLED connection closed but still standby
RCVR_STOPPED completed the job and closed all connections
RCVR_CLOSED closed all connections and ready to destroy object

Author:

yannanlu@yahoo.com

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`capacity`
`protected int`	`displayMask`
`protected java.lang.String`	`linkName`
`protected int`	`maxRetry`
`protected int`	`mode`
`protected java.lang.String`	`operation`
`protected int[]`	`partition`
`protected int`	`pauseTime`
`protected java.lang.String[]`	`propertyName`
`protected java.lang.String[]`	`propertyValue`
`protected int`	`repeatPeriod`
`protected int`	`standbyTime`
`protected int`	`status`
`protected int`	`timeout`
`protected int`	`tolerance`
`protected java.lang.String`	`uri`
`protected long`	`waitTime`
`protected int`	`xaMode`

Fields inherited from interface org.qbroker.receiver.MessageReceiver
RCVR_CLOSED, RCVR_DISABLED, RCVR_PAUSE, RCVR_READY, RCVR_RETRYING, RCVR_RUNNING, RCVR_STANDBY, RCVR_STOPPED

Constructor Summary

Constructors
Constructor and Description

Receiver(java.util.Map props)

Constructors
Constructor and Description
`Receiver(java.util.Map props)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`close()` closes all opened resources
`int`	`getCapacity()` returns the capacity of the OutLink
`java.lang.String`	`getLinkName()` returns the name of the OutLink
`java.lang.String`	`getName()` returns the name of the receiver
`java.lang.String`	`getOperation()` returns the string of the operation
`int[]`	`getPartition()` returns the partiton array of the input XQueue for the reciever
`int`	`getStatus()` returns the status of the receiver
`int`	`getXAMode()` returns the transaction mode of the reciever
`protected boolean`	`isStopped(XQueue xq)`
`protected boolean`	`keepRunning(XQueue xq)`
`abstract void`	`receive(XQueue xq, int baseTime)` puts all the received JMS messages to the XQueue as the output.
`protected void`	`resetStatus(int current, int status)`
`void`	`setStatus(int status)` sets the status of the receiver

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

- Field Detail
  - uri
```
protected java.lang.String uri
```
  - operation
```
protected java.lang.String operation
```
  - linkName
```
protected java.lang.String linkName
```
  - mode
```
protected int mode
```
  - xaMode
```
protected int xaMode
```
  - capacity
```
protected int capacity
```
  - status
```
protected int status
```
  - repeatPeriod
```
protected int repeatPeriod
```
  - maxRetry
```
protected int maxRetry
```
  - tolerance
```
protected int tolerance
```
  - pauseTime
```
protected int pauseTime
```
  - standbyTime
```
protected int standbyTime
```
  - timeout
```
protected int timeout
```
  - displayMask
```
protected int displayMask
```
  - waitTime
```
protected long waitTime
```
  - propertyName
```
protected java.lang.String[] propertyName
```
  - propertyValue
```
protected java.lang.String[] propertyValue
```
  - partition
```
protected int[] partition
```
- Constructor Detail
  - Receiver
```
public Receiver(java.util.Map props)
```
- Method Detail
  - receive
```
public abstract void receive(XQueue xq,
                             int baseTime)
```
    Description copied from interface: MessageReceiver
    
    puts all the received JMS messages to the XQueue as the output. In case of failure, it should keep retry with the sleepTime in milliseconds.
    
    Specified by:
    
    receive in interface MessageReceiver
  - close
```
public abstract void close()
```
    Description copied from interface: MessageReceiver
    
    closes all opened resources
    
    Specified by:
    
    close in interface MessageReceiver
  - resetStatus
```
protected void resetStatus(int current,
                           int status)
```
  - keepRunning
```
protected boolean keepRunning(XQueue xq)
```
  - isStopped
```
protected boolean isStopped(XQueue xq)
```
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: MessageReceiver
    
    returns the name of the receiver
    
    Specified by:
    
    getName in interface MessageReceiver
  - getOperation
```
public java.lang.String getOperation()
```
    Description copied from interface: MessageReceiver
    
    returns the string of the operation
    
    Specified by:
    
    getOperation in interface MessageReceiver
  - getLinkName
```
public java.lang.String getLinkName()
```
    Description copied from interface: MessageReceiver
    
    returns the name of the OutLink
    
    Specified by:
    
    getLinkName in interface MessageReceiver
  - getXAMode
```
public int getXAMode()
```
    Description copied from interface: MessageReceiver
    
    returns the transaction mode of the reciever
    
    Specified by:
    
    getXAMode in interface MessageReceiver
  - getCapacity
```
public int getCapacity()
```
    Description copied from interface: MessageReceiver
    
    returns the capacity of the OutLink
    
    Specified by:
    
    getCapacity in interface MessageReceiver
  - getPartition
```
public int[] getPartition()
```
    Description copied from interface: MessageReceiver
    
    returns the partiton array of the input XQueue for the reciever
    
    Specified by:
    
    getPartition in interface MessageReceiver
  - getStatus
```
public int getStatus()
```
    Description copied from interface: MessageReceiver
    
    returns the status of the receiver
    
    Specified by:
    
    getStatus in interface MessageReceiver
  - setStatus
```
public void setStatus(int status)
```
    Description copied from interface: MessageReceiver
    
    sets the status of the receiver
    
    Specified by:
    
    setStatus in interface MessageReceiver

Class Receiver

Field Summary

Fields inherited from interface org.qbroker.receiver.MessageReceiver

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

uri

operation

linkName

mode

xaMode

capacity

status

repeatPeriod

maxRetry

tolerance

pauseTime

standbyTime

timeout

displayMask

waitTime

propertyName

propertyValue

partition

Constructor Detail

Receiver

Method Detail

receive

close

resetStatus

keepRunning

isStopped

getName

getOperation

getLinkName

getXAMode

getCapacity

getPartition

getStatus

setStatus