org.eclipse.milo.opcua.sdk.server.items

Class BaseMonitoredItem<T>

java.lang.Object

org.eclipse.milo.opcua.sdk.server.items.BaseMonitoredItem<T>

All Implemented Interfaces:

MonitoredItem

Direct Known Subclasses:

MonitoredDataItem, MonitoredEventItem

public abstract class BaseMonitoredItem<T>
extends Object
implements MonitoredItem

Field Summary

Fields

Modifier and Type	Field and Description
protected long	clientHandle
protected boolean	discardOldest
protected UInteger	id
protected MonitoringMode	monitoringMode
protected RingBuffer<T>	queue
protected int	queueSize
protected ReadValueId	readValueId
protected double	samplingInterval
protected OpcUaServer	server
protected Session	session
protected UInteger	subscriptionId
protected TimestampsToReturn	timestamps
protected boolean	triggered
protected Map<UInteger,BaseMonitoredItem<?>>	triggeredItems

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseMonitoredItem(OpcUaServer server, Session session, UInteger id, UInteger subscriptionId, ReadValueId readValueId, MonitoringMode monitoringMode, TimestampsToReturn timestamps, UInteger clientHandle, double samplingInterval, UInteger queueSize, boolean discardOldest)

Method Summary

Modifier and Type	Method and Description
protected abstract void	enqueue(T value)
long	getClientHandle()
abstract ExtensionObject	getFilterResult()
UInteger	getId()
MonitoringMode	getMonitoringMode()
boolean	getNotifications(List<UaStructure> notifications, int max)
int	getQueueSize()
ReadValueId	getReadValueId()
double	getSamplingInterval()
Session	getSession()
UInteger	getSubscriptionId()
TimestampsToReturn	getTimestampsToReturn()
Map<UInteger,BaseMonitoredItem<?>>	getTriggeredItems()
boolean	hasNotifications()
abstract void	installFilter(MonitoringFilter filter)
boolean	isDiscardOldest()
boolean	isTriggered()
void	modify(TimestampsToReturn timestamps, UInteger clientHandle, double samplingInterval, MonitoringFilter filter, UInteger queueSize, boolean discardOldest)
void	setMonitoringMode(MonitoringMode monitoringMode)
protected void	setQueueSize(UInteger queueSize)
void	setSession(Session session)
protected abstract UaStructure	wrapQueueValue(T value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.milo.opcua.sdk.server.api.MonitoredItem

isSamplingEnabled

Field Detail

triggeredItems

protected volatile Map<UInteger,BaseMonitoredItem<?>> triggeredItems

triggered

protected volatile boolean triggered

queue

protected volatile RingBuffer<T> queue

clientHandle

protected volatile long clientHandle

queueSize

protected volatile int queueSize

samplingInterval

protected volatile double samplingInterval

discardOldest

protected volatile boolean discardOldest

server

protected final OpcUaServer server

session

protected volatile Session session

id

protected final UInteger id

subscriptionId

protected final UInteger subscriptionId

readValueId

protected final ReadValueId readValueId

monitoringMode

protected volatile MonitoringMode monitoringMode

timestamps

protected volatile TimestampsToReturn timestamps

Constructor Detail

BaseMonitoredItem

protected BaseMonitoredItem(OpcUaServer server,
                            Session session,
                            UInteger id,
                            UInteger subscriptionId,
                            ReadValueId readValueId,
                            MonitoringMode monitoringMode,
                            TimestampsToReturn timestamps,
                            UInteger clientHandle,
                            double samplingInterval,
                            UInteger queueSize,
                            boolean discardOldest)

Method Detail

setQueueSize

protected void setQueueSize(UInteger queueSize)

getNotifications

public boolean getNotifications(List<UaStructure> notifications,
                                int max)

hasNotifications

public boolean hasNotifications()

modify

public void modify(TimestampsToReturn timestamps,
                   UInteger clientHandle,
                   double samplingInterval,
                   MonitoringFilter filter,
                   UInteger queueSize,
                   boolean discardOldest)
            throws UaException

Throws:

UaException

enqueue

protected abstract void enqueue(T value)

setMonitoringMode

public void setMonitoringMode(MonitoringMode monitoringMode)

setSession

public void setSession(Session session)

getSession

public Session getSession()

Specified by:

getSession in interface MonitoredItem

Returns:

the most recent Session that owned the subscription this item belongs to.

getId

public UInteger getId()

Specified by:

getId in interface MonitoredItem

Returns:

the server-side id of this item.

getSubscriptionId

public UInteger getSubscriptionId()

Specified by:

getSubscriptionId in interface MonitoredItem

Returns:

the id of the Subscription this item belongs to.

getReadValueId

public ReadValueId getReadValueId()

Specified by:

getReadValueId in interface MonitoredItem

Returns:

the ReadValueId being monitored.

getTimestampsToReturn

public TimestampsToReturn getTimestampsToReturn()

Specified by:

getTimestampsToReturn in interface MonitoredItem

Returns:

the TimestampsToReturn.

getClientHandle

public long getClientHandle()

getQueueSize

public int getQueueSize()

getSamplingInterval

public double getSamplingInterval()

isDiscardOldest

public boolean isDiscardOldest()

getMonitoringMode

public MonitoringMode getMonitoringMode()

getTriggeredItems

public Map<UInteger,BaseMonitoredItem<?>> getTriggeredItems()

isTriggered

public boolean isTriggered()

getFilterResult

public abstract ExtensionObject getFilterResult()

installFilter

public abstract void installFilter(MonitoringFilter filter)
                            throws UaException

Throws:

UaException

wrapQueueValue

protected abstract UaStructure wrapQueueValue(T value)