Class QueueOverrideSettings
- java.lang.Object
-
- simpleorm.dataset.SRecordInstance
-
- com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord
-
- com.inductiveautomation.ignition.gateway.gan.QueueOverrideSettings
-
- All Implemented Interfaces:
java.io.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 StringField
DESCR
static StringField
ID
static BooleanField
IS_SYNCHRONOUS
static IntField
MAX_OUTSTANDING
static RecordMeta<QueueOverrideSettings>
META
static StringField
NAME
static 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
java.lang.String
getId()
java.lang.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.java.lang.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(java.lang.String descr)
void
setId(java.lang.String queueId)
void
setMaxOutstanding(java.lang.Integer maxOutstanding)
void
setName(java.lang.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)
java.util.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
-
-
-
-
Field Detail
-
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
-
-
Method Detail
-
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 classPersistentRecord
-
getId
public java.lang.String getId()
-
setId
public void setId(java.lang.String queueId)
-
getMaxOutstanding
public java.lang.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(java.lang.Integer maxOutstanding)
-
getPriority
public com.inductiveautomation.metro.api.QueuePriority getPriority()
-
setPriority
public void setPriority(com.inductiveautomation.metro.api.QueuePriority priority)
-
getName
public java.lang.String getName()
-
setName
public void setName(java.lang.String name)
Note: this field should be used to set an easily readable queue name, not the id!
-
getDescription
public java.lang.String getDescription()
-
setDescr
public void setDescr(java.lang.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 java.util.Properties toProperties()
Returns a Properties object with the actual override properties that we care about.
-
-