com.inductiveautomation.xopc.driver.api.requests

Class AbstractBrowseRequest<M>

java.lang.Object

com.inductiveautomation.xopc.driver.api.requests.AbstractBrowseRequest<M>

All Implemented Interfaces:

Request<M>

Direct Known Subclasses:

BrowseRequest

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

An abstract partial implementation of a Request with a RequestType of RequestType.Browse. Holds the BrowseOperation and handles getType(), fail(), and getTimeout().

Field Summary

Fields

Modifier and Type	Field and Description
protected BrowseOperation	browseOperation
protected int	timeout

Constructor Summary

Constructors

Constructor and Description
AbstractBrowseRequest(BrowseOperation browseOperation, int timeout)

Method Summary

Modifier and Type	Method and Description
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.
RequestPriority	getPriority() Returns the RequestPriority of this request.
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.
boolean	isRetryAllowed()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.xopc.driver.api.requests.Request

getKey, receiveMessage, sendMessage

Field Detail

browseOperation

protected BrowseOperation browseOperation

timeout

protected int timeout

Constructor Detail

AbstractBrowseRequest

public AbstractBrowseRequest(BrowseOperation browseOperation,
                             int timeout)

Method Detail

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>

isRetryAllowed

public boolean isRetryAllowed()

Specified by:

isRetryAllowed in interface Request<M>

Returns:

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

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>

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.