|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
@Generated(value="com.neeve.adm.AdmGenerator",
date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(compatLevel="3.8.0",
admVersion="nvx-adm v3.7.265 (build 0)",
date="3/28/18 10:54 AM",
buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
public interface ISrvMonAppEventMultiplexerStatsStats relating to an application's Aep Engine input queue.
The engine input queue holds stats that relate to how long events such as messages or acks are enqueued waiting for processing by the application's Aep Engine. Events enqueued for an engine go through two levels of queue to promote fairness and facilitate event scheduled. An event is first enqueued in a feeder queue private to the thread enqueueing it and then is promoted into the the engine's input disruptor.
| Method Summary | |
|---|---|
void |
addFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats val)
Adds the provided value to the list of 'feederQueueStats' values. |
void |
clearDisruptorStats()
Clears the value of 'disruptorStats' Field Description Stats relating to events' passage through the engine's input disruptor |
void |
clearFeederQueueStats()
Clears the value of 'feederQueueStats' Field Description Stats relating to events' passage through the engine's input multiplexer feeder queues. |
void |
clearLastDecongested()
Clears the value of 'lastDecongested' Field Description The last feeder queue decongested. |
void |
clearMaxConcurrency()
Clears the value of 'maxConcurrency' Field Description The maximum number of feeder queue supported by the multiplexer. |
void |
clearScheduleQueueSize()
Clears the value of 'scheduleQueueSize' Field Description The number of scheduled events awaiting dispatch. |
SrvMonDisruptorStats |
getDisruptorStats()
Gets the value of 'disruptorStats' Field Description Stats relating to events' passage through the engine's input disruptor |
void |
getDisruptorStatsTo(SrvMonDisruptorStats val)
Copies the value of SrvMonDisruptorStats into the provided value. |
SrvMonAppEventMultiplexerFeederQueueStats[] |
getFeederQueueStats()
Gets the value of 'feederQueueStats' If the field is not set this method will return null. |
SrvMonAppEventMultiplexerFeederQueueStats[] |
getFeederQueueStatsEmptyIfNull()
Gets the value of 'feederQueueStats' or an empty array if the value is null or not set. |
XIterator<SrvMonAppEventMultiplexerFeederQueueStats> |
getFeederQueueStatsIterator()
Gets the value of 'feederQueueStats' as iterator of values. |
int |
getLastDecongested()
Gets the value of 'lastDecongested' Field Description The last feeder queue decongested. |
int |
getMaxConcurrency()
Gets the value of 'maxConcurrency' Field Description The maximum number of feeder queue supported by the multiplexer. |
int |
getScheduleQueueSize()
Gets the value of 'scheduleQueueSize' Field Description The number of scheduled events awaiting dispatch. |
boolean |
hasDisruptorStats()
Checks for the presence of 'disruptorStats' Field Description Stats relating to events' passage through the engine's input disruptor |
boolean |
hasLastDecongested()
Checks for the presence of 'lastDecongested' Field Description The last feeder queue decongested. |
boolean |
hasMaxConcurrency()
Checks for the presence of 'maxConcurrency' Field Description The maximum number of feeder queue supported by the multiplexer. |
boolean |
hasScheduleQueueSize()
Checks for the presence of 'scheduleQueueSize' Field Description The number of scheduled events awaiting dispatch. |
void |
lendDisruptorStats(SrvMonDisruptorStats val)
'Lends' a reference of the SrvMonDisruptorStats to the message for this field. |
void |
lendFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats val)
Adds the provided value to the list of 'feederQueueStats' values and acquires a reference to it. |
void |
lendFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[] val)
Lends the value of 'feederQueueStats' Field Description Stats relating to events' passage through the engine's input multiplexer feeder queues. |
void |
lendFeederQueueStatsFrom(XIterator<SrvMonAppEventMultiplexerFeederQueueStats> val)
Sets the value of 'feederQueueStats' by lending the values from the provided iterator. |
void |
setDisruptorStats(SrvMonDisruptorStats val)
Sets the value of 'disruptorStats' Field Description Stats relating to events' passage through the engine's input disruptor |
void |
setFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[] val)
Sets the value of 'feederQueueStats' Field Description Stats relating to events' passage through the engine's input multiplexer feeder queues. |
void |
setFeederQueueStatsFrom(XIterator<SrvMonAppEventMultiplexerFeederQueueStats> val)
Sets the value of 'feederQueueStats' using the values from the provided iterator. |
void |
setLastDecongested(int val)
Sets the value of 'lastDecongested' Field Description The last feeder queue decongested. |
void |
setMaxConcurrency(int val)
Sets the value of 'maxConcurrency' Field Description The maximum number of feeder queue supported by the multiplexer. |
void |
setScheduleQueueSize(int val)
Sets the value of 'scheduleQueueSize' Field Description The number of scheduled events awaiting dispatch. |
SrvMonDisruptorStats |
takeDisruptorStats()
'Takes' a reference to the disruptorStats field from the message. |
SrvMonAppEventMultiplexerFeederQueueStats[] |
takeFeederQueueStats()
Takes the value of 'feederQueueStats' Field Description Stats relating to events' passage through the engine's input multiplexer feeder queues. |
| Methods inherited from interface com.neeve.rog.IRogValidatable |
|---|
getValidationErrors, isValid |
| Method Detail |
|---|
void setLastDecongested(int val)
val - The value to set.int getLastDecongested()
void clearLastDecongested()
setLastDecongested(int)boolean hasLastDecongested()
getLastDecongested()void setMaxConcurrency(int val)
val - The value to set.int getMaxConcurrency()
void clearMaxConcurrency()
setMaxConcurrency(int)boolean hasMaxConcurrency()
getMaxConcurrency()void setScheduleQueueSize(int val)
val - The value to set.int getScheduleQueueSize()
void clearScheduleQueueSize()
setScheduleQueueSize(int)boolean hasScheduleQueueSize()
getScheduleQueueSize()void setDisruptorStats(SrvMonDisruptorStats val)
val - The value to set.void lendDisruptorStats(SrvMonDisruptorStats val)
NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
val - the value to 'lend' to lend.SrvMonDisruptorStats getDisruptorStats()
void getDisruptorStatsTo(SrvMonDisruptorStats val)
IF the value is not set, then the contents of the provided SrvMonDisruptorStats are cleared.
val - the value to copy intoSrvMonDisruptorStats.copyInto(SrvMonDisruptorStats)SrvMonDisruptorStats takeDisruptorStats()
NOTE:
A nested entity reference returned by getXXX() is only valid until the entity is disposed
i.e. the act of getting an entity does not transfer ownership of the entity to the application
A message disposes of its reference to its contained entities when it is disposed itself.
An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
null if the field is not set.boolean hasDisruptorStats()
getDisruptorStats()void clearDisruptorStats()
setDisruptorStats(SrvMonDisruptorStats)void setFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[] val)
val - The value to set.void setFeederQueueStatsFrom(XIterator<SrvMonAppEventMultiplexerFeederQueueStats> val)
This method will call XIterator.toFirst() before and after setting the values, meaning
that all values from the iterator will be set and the iterator will be reset on return.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'feederQueueStats' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[]) with
a value of null.
val - the values to set.void lendFeederQueueStatsFrom(XIterator<SrvMonAppEventMultiplexerFeederQueueStats> val)
This method will call XIterator.toFirst() before and after setting the values, meaning
that all values from the iterator will be set and the iterator will be reset on return.
This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'feederQueueStats' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[]) with
a value of null.
val - the values to set.void addFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'feederQueueStats' accessor can copy the values without iteration.
For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
val - the value to add.void lendFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats val)
Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'feederQueueStats' accessor can copy the values without iteration.
For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
val - the value to add.XIterator<SrvMonAppEventMultiplexerFeederQueueStats> getFeederQueueStatsIterator()
This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).
This method is zero garbage for Xbuf generated classes, and this method is optimized such that
passing the returned iterator to another object's setXXX(XIterator
void lendFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[] val)
NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message.
This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
val - the value to 'lend' to lend.SrvMonAppEventMultiplexerFeederQueueStats[] getFeederQueueStats()
If the field is not set this method will return null.
null.SrvMonAppEventMultiplexerFeederQueueStats[] getFeederQueueStatsEmptyIfNull()
null or not set.
null if not set.getFeederQueueStats()SrvMonAppEventMultiplexerFeederQueueStats[] takeFeederQueueStats()
NOTE:
A nested entity reference returned by getFeederQueueStats() is only valid until the entity is disposed
i.e. the act of getting an entity does not transfer ownership of the entity to the application
A message disposes of its reference to its contained entities when it is disposed itself.
An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.
null if the field is not set.void clearFeederQueueStats()
setFeederQueueStats(SrvMonAppEventMultiplexerFeederQueueStats[])
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||