com.inductiveautomation.xopc.driver.common.nodemap.requests

Class ReadRequest

java.lang.Object

com.inductiveautomation.xopc.driver.api.requests.AbstractReadRequest<java.lang.Integer>

com.inductiveautomation.xopc.driver.common.nodemap.requests.ReadRequest

All Implemented Interfaces:

Request<java.lang.Integer>

public class ReadRequest
extends AbstractReadRequest<java.lang.Integer>

Field Summary

Fields inherited from class com.inductiveautomation.xopc.driver.api.requests.AbstractReadRequest

items

Constructor Summary

Constructors

Constructor and Description
ReadRequest(NodeMapDriver driver, java.util.List<? extends ReadItem> readItems)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getKey()
ReceiveAction	receiveMessage(java.lang.Integer message, java.lang.Object key) Called when a response message is received for this Request.
boolean	sendMessage() Creates and puts the Requests message "on the wire".

Methods inherited from class com.inductiveautomation.xopc.driver.api.requests.AbstractReadRequest

fail, getPriority, getTimeout, isRetryAllowed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadRequest

public ReadRequest(NodeMapDriver driver,
                   java.util.List<? extends ReadItem> readItems)

Method Detail

getKey

public java.lang.Object getKey()

Returns:

A unique key that identifies this Request.

receiveMessage

public ReceiveAction receiveMessage(java.lang.Integer message,
                                    java.lang.Object key)

Description copied from interface: Request

Called when a response message is received for this Request. This function should process the message and update any ReadItems or WriteItems that it contains (if applicable).

If you are extending from AbstractSocketDriver you must do this work on the thread this call arrived on or risk the byte[] message being returned its pool and reused in the middle of processing it.

Parameters:

message - The message that was received for this Request.

key - The key used to retrieve this Request.

Returns:

a ReceiveAction that indicates what the driver should do with this request.

sendMessage

public boolean sendMessage()

Description copied from interface: Request

Creates and puts the Requests message "on the wire". Each call should send a unique message (different transaction ID, if applicable), in case the request is re-used.