com.inductiveautomation.xopc.driver.api

Class RequestExecutor.ScheduledRequest

java.lang.Object

com.inductiveautomation.xopc.driver.api.RequestExecutor.ScheduledRequest

All Implemented Interfaces:

RequestExecutor.Request

Enclosing class:

RequestExecutor

public static final class RequestExecutor.ScheduledRequest
extends java.lang.Object
implements RequestExecutor.Request

A RequestExecutor.Request implementation that reschedules itself after execution, attempting to run periodically at the provided rate, until cancelled.

Constructor Summary

Constructors

Constructor and Description
ScheduledRequest(RequestExecutor.Request request, java.time.Duration rate, com.codahale.metrics.Timer timer)
ScheduledRequest(RequestExecutor.Request request, long rateNanos, com.codahale.metrics.Timer timer)

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	execute(RequestExecutor.RequestPermit permit) Execute this request.
long	getRateNanos()

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.RequestExecutor.Request

isPriority

Constructor Detail

ScheduledRequest

public ScheduledRequest(RequestExecutor.Request request,
                        java.time.Duration rate,
                        com.codahale.metrics.Timer timer)

ScheduledRequest

public ScheduledRequest(RequestExecutor.Request request,
                        long rateNanos,
                        com.codahale.metrics.Timer timer)

Method Detail

execute

public final void execute(RequestExecutor.RequestPermit permit)

Description copied from interface: RequestExecutor.Request

Execute this request. RequestExecutor.RequestPermit.release() must be called when execution is complete.

Specified by:

execute in interface RequestExecutor.Request

Parameters:

permit - the RequestExecutor.RequestPermit associated with this RequestExecutor.Request.

cancel

public final void cancel()

getRateNanos

public final long getRateNanos()