Package com.inductiveautomation.ignition.gateway.gan

Class QueueOverrideSettings

java.lang.Object

simpleorm.dataset.SRecordInstance

com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord

com.inductiveautomation.ignition.gateway.gan.QueueOverrideSettings

All Implemented Interfaces:

Serializable

public class QueueOverrideSettings
extends PersistentRecord

Allows a gateway network's hard-coded default queue settings to be overridden by the user.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class simpleorm.dataset.SRecordInstance

SRecordInstance.BrokenOptimisticLockException

Field Summary

Fields

Modifier and Type	Field	Description
static final StringField	DESCR
static final StringField	ID
static final BooleanField	IS_SYNCHRONOUS
static final IntField	MAX_OUTSTANDING
static final RecordMeta<QueueOverrideSettings>	META
static final StringField	NAME
static final EnumField<com.inductiveautomation.metro.api.QueuePriority>	PRIORITY

Fields inherited from class com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord

DEFAULT_VALUE, FORM_META_KEY, INDEXED, UNIQUE

Constructor Summary

Constructors

Constructor	Description
QueueOverrideSettings()

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getId()
Integer	getMaxOutstanding()
RecordMeta<?>	getMeta()	This must be defined in every user record's definition to access the SRecord which provides the meta data for this instance.
String	getName()
com.inductiveautomation.metro.api.QueuePriority	getPriority()
boolean	isSynchronous()	Indicates whether the queue has been hard-coded in synchronous mode, meaning that another message cannot be dispatched until there are no outstanding messages.
void	setDescr(String descr)
void	setId(String queueId)
void	setMaxOutstanding(Integer maxOutstanding)
void	setName(String name)	Note: this field should be used to set an easily readable queue name, not the id!
void	setPriority(com.inductiveautomation.metro.api.QueuePriority priority)
void	setSynchronous(boolean isSynchronous)
Properties	toProperties()	Returns a Properties object with the actual override properties that we care about.

Methods inherited from class com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord

getBoolean, getDoubleObj, getIntObj, getLongObj, getString, installDefaultValues

Methods inherited from class simpleorm.dataset.SRecordInstance

allFields, assertNewRow, assertNotNewRow, defineInitialValue, deleteRecord, doQueryRecord, doValidateRecord, equals, findReference, findReference, findReference, findReference, getBigDecimal, getBytes, getDataSet, getDate, getDouble, getEnum, getInitialValue, getInt, getLogger, getLong, getObject, getRawArrayValue, getReferenceNoQuery, getTime, getTimestamp, hashCode, isAttached, isDeleted, isDirty, isDirty, isEmpty, isNewRow, isNotDestroyed, isNull, isReadOnly, isValid, onQueryRecord, onValidateField, onValidateRecord, setBigDecimal, setBoolean, setBytes, setDate, setDirty, setDouble, setEmpty, setEnum, setInt, setLong, setNewRow, setNull, setObject, setObject, setRawArrayValue, setReadOnly, setReference, setString, setTime, setTimestamp, toString, validatePrimaryKeys, wasInCache

Methods inherited from class java.lang.Object

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

Field Details

META

public static final RecordMeta<QueueOverrideSettings> META

ID

public static final StringField ID

NAME

public static final StringField NAME

DESCR

public static final StringField DESCR

IS_SYNCHRONOUS

public static final BooleanField IS_SYNCHRONOUS

MAX_OUTSTANDING

public static final IntField MAX_OUTSTANDING

PRIORITY

public static final EnumField<com.inductiveautomation.metro.api.QueuePriority> PRIORITY

Constructor Details

QueueOverrideSettings

public QueueOverrideSettings()

Method Details

getMeta

public RecordMeta<?> getMeta()

Description copied from class: SRecordInstance

This must be defined in every user record's definition to access the SRecord which provides the meta data for this instance. It is normally defined as:-

 SRecord getMeta() {
   return meta;
 };
 

The actual meta variable is thus not Serialized, but it would not be anyway as it is usually static.

Specified by:

getMeta in class PersistentRecord

getId

public String getId()

setId

public void setId(String queueId)

getMaxOutstanding

public Integer getMaxOutstanding()

Returns:

the maximum number of messages that can be in an outstanding state, that is, are being actively sent over the connection

setMaxOutstanding

public void setMaxOutstanding(Integer maxOutstanding)

getPriority

public com.inductiveautomation.metro.api.QueuePriority getPriority()

setPriority

public void setPriority(com.inductiveautomation.metro.api.QueuePriority priority)

getName

public String getName()

setName

public void setName(String name)

Note: this field should be used to set an easily readable queue name, not the id!

getDescription

public String getDescription()

setDescr

public void setDescr(String descr)

isSynchronous

public boolean isSynchronous()

Indicates whether the queue has been hard-coded in synchronous mode, meaning that another message cannot be dispatched until there are no outstanding messages.

setSynchronous

public void setSynchronous(boolean isSynchronous)

toProperties

public Properties toProperties()

Returns a Properties object with the actual override properties that we care about.