com.neeve.server.mon

Interface ISrvMonAppEventMultiplexerFeederQueueStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonAppEventMultiplexerFeederQueueStats

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(compatLevel="4.0.0",
              admVersion="nvx-rumi-adm v3.14 (build 29)",
              date="5/7/20 3:37 PM",
              buildInfo="nvx-talon-3.14.19 (nvx-codegen-plugin)")
public interface ISrvMonAppEventMultiplexerFeederQueueStats
extends IRogValidatable

Holds stats related to an Aep Engine's input multiplexer feeder queue.

An input multiplexer maintains several feeder queues one for each thread to allow efficient enqueue and schdeduling of events by multiple input threads. These stats provide insight into the depth of such feeder queues.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
decongestCount	Integer	3	The number of times the draining thread has woken up to drain the feeder queue.
offerToPollLatencies	SrvMonIntSeries	4	Latency information for the amount of time that elements spend in the feeder queue.
owner	String	1	The owner thread for the feeder queue (the source of events).
size	Integer	2	The current number of events in the queue.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearDecongestCount() Clears the value of 'decongestCount'.
void	clearOfferToPollLatencies() Clears the value of 'offerToPollLatencies'.
void	clearOwner() Clears the value of 'owner'.
void	clearSize() Clears the value of 'size'.
int	getDecongestCount() Gets the value of 'decongestCount'.
SrvMonIntSeries	getOfferToPollLatencies() Gets the value of 'offerToPollLatencies'.
void	getOfferToPollLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
String	getOwner() Gets the value of 'owner'.
<T extends XString> T	getOwnerTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getOwnerTo(XString val) Copies the value of 'owner' into the provided XString.
XString	getOwnerUnsafe() Gets the raw value of 'owner'.
int	getSize() Gets the value of 'size'.
boolean	hasDecongestCount() Checks for the presence of 'decongestCount'.
boolean	hasOfferToPollLatencies() Checks for the presence of 'offerToPollLatencies'.
boolean	hasOwner() Checks for the presence of 'owner'.
boolean	hasSize() Checks for the presence of 'size'.
void	lendOfferToPollLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendOwner(XString val) Lends the value of 'owner' to this object.
void	setDecongestCount(int val) Sets the value of 'decongestCount'.
void	setOfferToPollLatencies(SrvMonIntSeries val) Sets the value of 'offerToPollLatencies'.
void	setOwner(String val) Sets the value of 'owner'.
void	setOwnerFrom(long val) Sets the value of this String field to the given numeric value.
void	setOwnerFrom(XString val) Copies the provided XString value into this object's 'owner'.
void	setSize(int val) Sets the value of 'size'.
SrvMonIntSeries	takeOfferToPollLatencies() 'Takes' a reference to the offerToPollLatencies field from the message.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setSize

void setSize(int val)

Sets the value of 'size'.

Field Description

The current number of events in the queue.

Parameters:

val - The value to set.

getSize

int getSize()

Gets the value of 'size'.

Field Description

The current number of events in the queue.

Returns:

The current number of events in the queue.

clearSize

void clearSize()

Clears the value of 'size'.

Field Description

The current number of events in the queue.

See Also:

setSize(int)

hasSize

boolean hasSize()

Checks for the presence of 'size'.

Field Description

The current number of events in the queue.

See Also:

getSize()

setDecongestCount

void setDecongestCount(int val)

Sets the value of 'decongestCount'.

Field Description

The number of times the draining thread has woken up to drain the feeder queue.

Parameters:

val - The value to set.

getDecongestCount

int getDecongestCount()

Gets the value of 'decongestCount'.

Field Description

The number of times the draining thread has woken up to drain the feeder queue.

Returns:

The number of times the draining thread has woken up to drain the feeder queue.

clearDecongestCount

void clearDecongestCount()

Clears the value of 'decongestCount'.

Field Description

The number of times the draining thread has woken up to drain the feeder queue.

See Also:

setDecongestCount(int)

hasDecongestCount

boolean hasDecongestCount()

Checks for the presence of 'decongestCount'.

Field Description

The number of times the draining thread has woken up to drain the feeder queue.

See Also:

getDecongestCount()

setOwner

void setOwner(String val)

Sets the value of 'owner'.

Field Description

The owner thread for the feeder queue (the source of events).

Parameters:

val - The value to set.

getOwner

String getOwner()

Gets the value of 'owner'.

Field Description

The owner thread for the feeder queue (the source of events).

Returns:

The owner thread for the feeder queue (the source of events).

lendOwner

void lendOwner(XString val)

Lends the value of 'owner' to this object.

This method is equivalent to setOwner except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.

Field Description

The owner thread for the feeder queue (the source of events).

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setOwnerFrom

void setOwnerFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

The owner thread for the feeder queue (the source of events).

NOTE:
This is the same as calling setOwner(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getOwnerTo

<T extends XString> T getOwnerTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

The owner thread for the feeder queue (the source of events).

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setOwnerFrom

void setOwnerFrom(XString val)

Copies the provided XString value into this object's 'owner'.

Field Description

The owner thread for the feeder queue (the source of events).

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setOwner(String) because it avoids encoding the value into a String if the given XString is already encoded.

getOwnerTo

void getOwnerTo(XString val)

Copies the value of 'owner' into the provided XString.

Field Description

The owner thread for the feeder queue (the source of events).

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getOwner() bec because it can avoid decoding the value into an String.

See Also:

getOwner()

getOwnerUnsafe

XString getOwnerUnsafe()

Gets the raw value of 'owner'.

Field Description

The owner thread for the feeder queue (the source of events).

NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.

However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.

Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.

Returns:

the field's raw value

See Also:

getOwner()

clearOwner

void clearOwner()

Clears the value of 'owner'.

Field Description

The owner thread for the feeder queue (the source of events).

See Also:

setOwner(String)

hasOwner

boolean hasOwner()

Checks for the presence of 'owner'.

Field Description

The owner thread for the feeder queue (the source of events).

See Also:

getOwner()

setOfferToPollLatencies

void setOfferToPollLatencies(SrvMonIntSeries val)

Sets the value of 'offerToPollLatencies'.

Field Description

Latency information for the amount of time that elements spend in the feeder queue.

Parameters:

val - The value to set.

lendOfferToPollLatencies

void lendOfferToPollLatencies(SrvMonIntSeries val)

'Lends' a reference of the SrvMonIntSeries to the message for this field.

Field Description

Latency information for the amount of time that elements spend in the feeder queue.

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.

Parameters:

val - the value to 'lend' to lend.

getOfferToPollLatencies

SrvMonIntSeries getOfferToPollLatencies()

Gets the value of 'offerToPollLatencies'.

Field Description

Latency information for the amount of time that elements spend in the feeder queue.

Returns:

Latency information for the amount of time that elements spend in the feeder queue.

getOfferToPollLatenciesTo

void getOfferToPollLatenciesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

IF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeOfferToPollLatencies

SrvMonIntSeries takeOfferToPollLatencies()

'Takes' a reference to the offerToPollLatencies field from the message.

Field Description

Latency information for the amount of time that elements spend in the feeder queue.

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.

Returns:

a 'taken' reference to the field or null if the field is not set.

hasOfferToPollLatencies

boolean hasOfferToPollLatencies()

Checks for the presence of 'offerToPollLatencies'.

Field Description

Latency information for the amount of time that elements spend in the feeder queue.

See Also:

getOfferToPollLatencies()

clearOfferToPollLatencies

void clearOfferToPollLatencies()

Clears the value of 'offerToPollLatencies'.

Field Description

Latency information for the amount of time that elements spend in the feeder queue.

See Also:

setOfferToPollLatencies(SrvMonIntSeries)