StreamReceiver

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

All Implemented Interfaces:

MessageReceiver
```
public class StreamReceiver
extends Receiver
```
StreamReceiver listens to an InputStream and receives byte stream from it. It puts the JMS Messages to an XQueue as the output. StreamReceiver supports flow control and allows object control from its owner. It is fault tolerant with retry and idle options.

In case that Destination is defined and scheme is tcp, StreamReceiver will send a request to the server to open the destination after the connection and waits for the response. The request is supposed to contain all the properties about the connection, the destination and the operation. After the connection is established and the destination is opened, StreamReceiver will read JMS messages out of the InputStream for the normal operation. In this case, SOTimeout is used for connection timeout while ReceiveTime is used to timeout read().

Author:

yannanlu@yahoo.com

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CLIENTERROR`
`static int`	`CMDFAILED`
`static int`	`CMDOK`
`static int`	`CONNREFUSED`
`static int`	`CONNTIMEOUT`
`static int`	`DATAERROR`
`static int`	`ERRORFOUND`
`static int`	`NOTCONNECTED`
`static int`	`READFAILED`
`static int`	`SERVERERROR`
`static int`	`WRITEFAILED`

Fields inherited from class org.qbroker.receiver.Receiver
capacity, displayMask, linkName, maxRetry, mode, operation, partition, pauseTime, propertyName, propertyValue, repeatPeriod, standbyTime, status, timeout, tolerance, uri, waitTime, 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

StreamReceiver(java.util.Map props)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` closes all opened resources
`protected void`	`finalize()`
`void`	`receive(XQueue xq, int baseTime)` puts all the received JMS messages to the XQueue as the output.
`int`	`send(javax.jms.Message message)` extracts the content from the message and writes it to the OutputStream of the existing connection and returns 0 on success or none zero otherwise
`int`	`send(java.lang.String text)` writes the text to the OutputStream of the existing connection and returns 0 on success or none zero otherwise

Methods inherited from class org.qbroker.receiver.Receiver
getCapacity, getLinkName, getName, getOperation, getPartition, getStatus, getXAMode, isStopped, keepRunning, resetStatus, setStatus

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

- Field Detail
  - NOTCONNECTED
```
public static final int NOTCONNECTED
```
    See Also:
    
    Constant Field Values
  - CMDOK
```
public static final int CMDOK
```
    See Also:
    
    Constant Field Values
  - DATAERROR
```
public static final int DATAERROR
```
    See Also:
    
    Constant Field Values
  - CMDFAILED
```
public static final int CMDFAILED
```
    See Also:
    
    Constant Field Values
  - ERRORFOUND
```
public static final int ERRORFOUND
```
    See Also:
    
    Constant Field Values
  - CLIENTERROR
```
public static final int CLIENTERROR
```
    See Also:
    
    Constant Field Values
  - SERVERERROR
```
public static final int SERVERERROR
```
    See Also:
    
    Constant Field Values
  - READFAILED
```
public static final int READFAILED
```
    See Also:
    
    Constant Field Values
  - WRITEFAILED
```
public static final int WRITEFAILED
```
    See Also:
    
    Constant Field Values
  - CONNTIMEOUT
```
public static final int CONNTIMEOUT
```
    See Also:
    
    Constant Field Values
  - CONNREFUSED
```
public static final int CONNREFUSED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StreamReceiver
```
public StreamReceiver(java.util.Map props)
```
- Method Detail
  - receive
```
public 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
    
    Specified by:
    
    receive in class Receiver
  - send
```
public int send(java.lang.String text)
```
    writes the text to the OutputStream of the existing connection and returns 0 on success or none zero otherwise
  - send
```
public int send(javax.jms.Message message)
```
    extracts the content from the message and writes it to the OutputStream of the existing connection and returns 0 on success or none zero otherwise
  - close
```
public void close()
```
    Description copied from interface: MessageReceiver
    
    closes all opened resources
    
    Specified by:
    
    close in interface MessageReceiver
    
    Specified by:
    
    close in class Receiver
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class java.lang.Object

Class StreamReceiver

Field Summary

Fields inherited from class org.qbroker.receiver.Receiver

Fields inherited from interface org.qbroker.receiver.MessageReceiver

Constructor Summary

Method Summary

Methods inherited from class org.qbroker.receiver.Receiver

Methods inherited from class java.lang.Object

Field Detail

NOTCONNECTED

CMDOK

DATAERROR

CMDFAILED

ERRORFOUND

CLIENTERROR

SERVERERROR

READFAILED

WRITEFAILED

CONNTIMEOUT

CONNREFUSED

Constructor Detail

StreamReceiver

Method Detail

receive

send

send

close

finalize