com.inductiveautomation.xopc.driver.api

Class ScheduledRequest<M>

java.lang.Object

com.inductiveautomation.xopc.driver.api.ScheduledRequest<M>

All Implemented Interfaces:

Request<M>

public class ScheduledRequest<M>
extends java.lang.Object
implements Request<M>

A ScheduledRequest holds a Request and the corresponding Set of AggregateSubscriptionItems making up that Request that a driver implementation has optimized.

ScheduledRequests are what make up the bulk of the "subscription" logic for a driver; that is, repeated and perpetually self-scheduling read Requests.

Equality and hash code are based on the Set of AggregateSubscriptionItems and the rate.

Constructor Summary

Constructors

Constructor and Description
ScheduledRequest(Request<M> request, RequestCycle<M> requestCycle, int rate, java.util.List<AggregateSubscriptionItem> items, long idealSendTime, com.codahale.metrics.Timer timer)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
void	fail(FailureType type, DriverState state, java.lang.Exception ex) Called if the response to the most recently created message is not going to be received.
long	getIdealSendTime()
java.util.List<AggregateSubscriptionItem>	getItems()
java.lang.Object	getKey()
long	getLastPost()
long	getLastReceive()
long	getLastSend()
RequestPriority	getPriority() Returns the RequestPriority of this request.
int	getRate()
int	getTimeout() Returns the amount of time (in milliseconds) that this request should be given to run, before it is failed out for a timeout.
int	hashCode()
boolean	isCanceled()
boolean	isRetryAllowed()
ReceiveAction	receiveMessage(M 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".
void	setCanceled(boolean canceled)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScheduledRequest

public ScheduledRequest(Request<M> request,
                        RequestCycle<M> requestCycle,
                        int rate,
                        java.util.List<AggregateSubscriptionItem> items,
                        long idealSendTime,
                        com.codahale.metrics.Timer timer)

Method Detail

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.

Specified by:

sendMessage in interface Request<M>

getKey

public java.lang.Object getKey()

Specified by:

getKey in interface Request<M>

Returns:

A unique key that identifies this Request.

receiveMessage

public ReceiveAction receiveMessage(M 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.

Specified by:

receiveMessage in interface Request<M>

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.

fail

public void fail(FailureType type,
                 DriverState state,
                 java.lang.Exception ex)

Description copied from interface: Request

Called if the response to the most recently created message is not going to be received. Can be called before createMessage() in the case when it is known that any message will fail (for example, trying to issue a read request before a driver is connected).

Specified by:

fail in interface Request<M>

getTimeout

public int getTimeout()

Description copied from interface: Request

Returns the amount of time (in milliseconds) that this request should be given to run, before it is failed out for a timeout.

Specified by:

getTimeout in interface Request<M>

isRetryAllowed

public final boolean isRetryAllowed()

Specified by:

isRetryAllowed in interface Request<M>

Returns:

true if retrying is allowed if Request.sendMessage() returns false.

getPriority

public RequestPriority getPriority()

Description copied from interface: Request

Returns the RequestPriority of this request.

Specified by:

getPriority in interface Request<M>

Returns:

The RequestPriority of this request.

isCanceled

public boolean isCanceled()

setCanceled

public void setCanceled(boolean canceled)

getItems

public java.util.List<AggregateSubscriptionItem> getItems()

getRate

public int getRate()

getIdealSendTime

public long getIdealSendTime()

getLastSend

public long getLastSend()

getLastPost

public long getLastPost()

getLastReceive

public long getLastReceive()

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object