com.neeve.server.mon

Interface ISrvMonDisruptorStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonDisruptorStats

@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 ISrvMonDisruptorStats
extends IRogValidatable

Holds stats for a disruptor.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
capacity	Integer	1	The size of the diruptor's ringbuffer.
claimStrategy	SrvMonDisruptorClaimStrategy	3	The claim strategy used by threads inputing events to the disruptor.
offerToPollLatencies	SrvMonIntSeries	5	Measures latency of events passing in the disruptor.
remaining	Integer	2	The number of free ringbuffer slots.
waitStrategy	SrvMonDisruptorWaitStrategy	4	The wait strategy used by thread processing events in the disruptor.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCapacity() Clears the value of 'capacity'.
void	clearClaimStrategy() Clears the value of 'claimStrategy'.
void	clearOfferToPollLatencies() Clears the value of 'offerToPollLatencies'.
void	clearRemaining() Clears the value of 'remaining'.
void	clearWaitStrategy() Clears the value of 'waitStrategy'.
int	getCapacity() Gets the value of 'capacity'.
SrvMonDisruptorClaimStrategy	getClaimStrategy() Gets the value of 'claimStrategy'.
SrvMonIntSeries	getOfferToPollLatencies() Gets the value of 'offerToPollLatencies'.
void	getOfferToPollLatenciesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided value.
int	getRemaining() Gets the value of 'remaining'.
SrvMonDisruptorWaitStrategy	getWaitStrategy() Gets the value of 'waitStrategy'.
boolean	hasCapacity() Checks for the presence of 'capacity'.
boolean	hasClaimStrategy() Checks for the presence of 'claimStrategy'.
boolean	hasOfferToPollLatencies() Checks for the presence of 'offerToPollLatencies'.
boolean	hasRemaining() Checks for the presence of 'remaining'.
boolean	hasWaitStrategy() Checks for the presence of 'waitStrategy'.
void	lendOfferToPollLatencies(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	setCapacity(int val) Sets the value of 'capacity'.
void	setClaimStrategy(SrvMonDisruptorClaimStrategy val) Sets the value of 'claimStrategy'.
void	setOfferToPollLatencies(SrvMonIntSeries val) Sets the value of 'offerToPollLatencies'.
void	setRemaining(int val) Sets the value of 'remaining'.
void	setWaitStrategy(SrvMonDisruptorWaitStrategy val) Sets the value of 'waitStrategy'.
SrvMonIntSeries	takeOfferToPollLatencies() 'Takes' a reference to the offerToPollLatencies field from the message.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setCapacity

void setCapacity(int val)

Sets the value of 'capacity'.

Field Description

The size of the diruptor's ringbuffer.

Parameters:

val - The value to set.

getCapacity

int getCapacity()

Gets the value of 'capacity'.

Field Description

The size of the diruptor's ringbuffer.

Returns:

The size of the diruptor's ringbuffer.

clearCapacity

void clearCapacity()

Clears the value of 'capacity'.

Field Description

The size of the diruptor's ringbuffer.

See Also:

setCapacity(int)

hasCapacity

boolean hasCapacity()

Checks for the presence of 'capacity'.

Field Description

The size of the diruptor's ringbuffer.

See Also:

getCapacity()

setRemaining

void setRemaining(int val)

Sets the value of 'remaining'.

Field Description

The number of free ringbuffer slots.

Parameters:

val - The value to set.

getRemaining

int getRemaining()

Gets the value of 'remaining'.

Field Description

The number of free ringbuffer slots.

Returns:

The number of free ringbuffer slots.

clearRemaining

void clearRemaining()

Clears the value of 'remaining'.

Field Description

The number of free ringbuffer slots.

See Also:

setRemaining(int)

hasRemaining

boolean hasRemaining()

Checks for the presence of 'remaining'.

Field Description

The number of free ringbuffer slots.

See Also:

getRemaining()

setClaimStrategy

void setClaimStrategy(SrvMonDisruptorClaimStrategy val)

Sets the value of 'claimStrategy'.

Field Description

The claim strategy used by threads inputing events to the disruptor.

Parameters:

val - The value to set.

getClaimStrategy

SrvMonDisruptorClaimStrategy getClaimStrategy()

Gets the value of 'claimStrategy'.

Field Description

The claim strategy used by threads inputing events to the disruptor.

Returns:

The claim strategy used by threads inputing events to the disruptor.

clearClaimStrategy

void clearClaimStrategy()

Clears the value of 'claimStrategy'.

Field Description

The claim strategy used by threads inputing events to the disruptor.

See Also:

setClaimStrategy(SrvMonDisruptorClaimStrategy)

hasClaimStrategy

boolean hasClaimStrategy()

Checks for the presence of 'claimStrategy'.

Field Description

The claim strategy used by threads inputing events to the disruptor.

See Also:

getClaimStrategy()

setWaitStrategy

void setWaitStrategy(SrvMonDisruptorWaitStrategy val)

Sets the value of 'waitStrategy'.

Field Description

The wait strategy used by thread processing events in the disruptor.

Parameters:

val - The value to set.

getWaitStrategy

SrvMonDisruptorWaitStrategy getWaitStrategy()

Gets the value of 'waitStrategy'.

Field Description

The wait strategy used by thread processing events in the disruptor.

Returns:

The wait strategy used by thread processing events in the disruptor.

clearWaitStrategy

void clearWaitStrategy()

Clears the value of 'waitStrategy'.

Field Description

The wait strategy used by thread processing events in the disruptor.

See Also:

setWaitStrategy(SrvMonDisruptorWaitStrategy)

hasWaitStrategy

boolean hasWaitStrategy()

Checks for the presence of 'waitStrategy'.

Field Description

The wait strategy used by thread processing events in the disruptor.

See Also:

getWaitStrategy()

setOfferToPollLatencies

void setOfferToPollLatencies(SrvMonIntSeries val)

Sets the value of 'offerToPollLatencies'.

Field Description

Measures latency of events passing in the disruptor.

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

Measures latency of events passing in the disruptor.

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

Measures latency of events passing in the disruptor.

Returns:

Measures latency of events passing in the disruptor.

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

Measures latency of events passing in the disruptor.

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

Measures latency of events passing in the disruptor.

See Also:

getOfferToPollLatencies()

clearOfferToPollLatencies

void clearOfferToPollLatencies()

Clears the value of 'offerToPollLatencies'.

Field Description

Measures latency of events passing in the disruptor.

See Also:

setOfferToPollLatencies(SrvMonIntSeries)