com.neeve.server.mon

Interface ISrvMonAppMessageLoggerStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonAppMessageLoggerStats

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

Holds stats for an application message logger.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
detachedPersist	Boolean	6	Indicates if the message logger is operating in detached mode.
disruptorStats	SrvMonDisruptorStats	7	The disruptor stats for a message logger operating in detached mode.
fileSize	Long	9	The size of the file on disk. This represents the actual size of the log file currently allocated. This may differs from getFileSizeUsed() in that this value may be greater if the log has been preallocated to a larger size.
fileSizeUsed	Long	10	The size of the allocated log file used in bytes. This represents the amount of space used in the log file which may be less than the size on disk if the file has been preallocated to a larger size.
numCommits	Long	5	The number of commits to the message logger.
numForks	Long	8	The number of forked message packets persisted.
numMessagesRecorded	Long	4	The number of messages persisted by the message logger.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearDetachedPersist() Clears the value of 'detachedPersist'.
void	clearDisruptorStats() Clears the value of 'disruptorStats'.
void	clearFileSize() Clears the value of 'fileSize'.
void	clearFileSizeUsed() Clears the value of 'fileSizeUsed'.
void	clearNumCommits() Clears the value of 'numCommits'.
void	clearNumForks() Clears the value of 'numForks'.
void	clearNumMessagesRecorded() Clears the value of 'numMessagesRecorded'.
boolean	getDetachedPersist() Gets the value of 'detachedPersist'.
SrvMonDisruptorStats	getDisruptorStats() Gets the value of 'disruptorStats'.
void	getDisruptorStatsTo(SrvMonDisruptorStats val) Copies the value of SrvMonDisruptorStats into the provided value.
long	getFileSize() Gets the value of 'fileSize'.
long	getFileSizeUsed() Gets the value of 'fileSizeUsed'.
long	getNumCommits() Gets the value of 'numCommits'.
long	getNumForks() Gets the value of 'numForks'.
long	getNumMessagesRecorded() Gets the value of 'numMessagesRecorded'.
boolean	hasDetachedPersist() Checks for the presence of 'detachedPersist'.
boolean	hasDisruptorStats() Checks for the presence of 'disruptorStats'.
boolean	hasFileSize() Checks for the presence of 'fileSize'.
boolean	hasFileSizeUsed() Checks for the presence of 'fileSizeUsed'.
boolean	hasNumCommits() Checks for the presence of 'numCommits'.
boolean	hasNumForks() Checks for the presence of 'numForks'.
boolean	hasNumMessagesRecorded() Checks for the presence of 'numMessagesRecorded'.
void	lendDisruptorStats(SrvMonDisruptorStats val) 'Lends' a reference of the SrvMonDisruptorStats to the message for this field.
void	setDetachedPersist(boolean val) Sets the value of 'detachedPersist'.
void	setDisruptorStats(SrvMonDisruptorStats val) Sets the value of 'disruptorStats'.
void	setFileSize(long val) Sets the value of 'fileSize'.
void	setFileSizeUsed(long val) Sets the value of 'fileSizeUsed'.
void	setNumCommits(long val) Sets the value of 'numCommits'.
void	setNumForks(long val) Sets the value of 'numForks'.
void	setNumMessagesRecorded(long val) Sets the value of 'numMessagesRecorded'.
SrvMonDisruptorStats	takeDisruptorStats() 'Takes' a reference to the disruptorStats field from the message.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setNumMessagesRecorded

void setNumMessagesRecorded(long val)

Sets the value of 'numMessagesRecorded'.

Field Description

The number of messages persisted by the message logger.

Parameters:

val - The value to set.

getNumMessagesRecorded

long getNumMessagesRecorded()

Gets the value of 'numMessagesRecorded'.

Field Description

The number of messages persisted by the message logger.

Returns:

The number of messages persisted by the message logger.

clearNumMessagesRecorded

void clearNumMessagesRecorded()

Clears the value of 'numMessagesRecorded'.

Field Description

The number of messages persisted by the message logger.

See Also:

setNumMessagesRecorded(long)

hasNumMessagesRecorded

boolean hasNumMessagesRecorded()

Checks for the presence of 'numMessagesRecorded'.

Field Description

The number of messages persisted by the message logger.

See Also:

getNumMessagesRecorded()

setNumCommits

void setNumCommits(long val)

Sets the value of 'numCommits'.

Field Description

The number of commits to the message logger.

Parameters:

val - The value to set.

getNumCommits

long getNumCommits()

Gets the value of 'numCommits'.

Field Description

The number of commits to the message logger.

Returns:

The number of commits to the message logger.

clearNumCommits

void clearNumCommits()

Clears the value of 'numCommits'.

Field Description

The number of commits to the message logger.

See Also:

setNumCommits(long)

hasNumCommits

boolean hasNumCommits()

Checks for the presence of 'numCommits'.

Field Description

The number of commits to the message logger.

See Also:

getNumCommits()

setDetachedPersist

void setDetachedPersist(boolean val)

Sets the value of 'detachedPersist'.

Field Description

Indicates if the message logger is operating in detached mode.

Parameters:

val - The value to set.

getDetachedPersist

boolean getDetachedPersist()

Gets the value of 'detachedPersist'.

Field Description

Indicates if the message logger is operating in detached mode.

Returns:

Indicates if the message logger is operating in detached mode.

clearDetachedPersist

void clearDetachedPersist()

Clears the value of 'detachedPersist'.

Field Description

Indicates if the message logger is operating in detached mode.

See Also:

setDetachedPersist(boolean)

hasDetachedPersist

boolean hasDetachedPersist()

Checks for the presence of 'detachedPersist'.

Field Description

Indicates if the message logger is operating in detached mode.

See Also:

getDetachedPersist()

setNumForks

void setNumForks(long val)

Sets the value of 'numForks'.

Field Description

The number of forked message packets persisted.

Parameters:

val - The value to set.

getNumForks

long getNumForks()

Gets the value of 'numForks'.

Field Description

The number of forked message packets persisted.

Returns:

The number of forked message packets persisted.

clearNumForks

void clearNumForks()

Clears the value of 'numForks'.

Field Description

The number of forked message packets persisted.

See Also:

setNumForks(long)

hasNumForks

boolean hasNumForks()

Checks for the presence of 'numForks'.

Field Description

The number of forked message packets persisted.

See Also:

getNumForks()

setFileSize

void setFileSize(long val)

Sets the value of 'fileSize'.

Field Description

The size of the file on disk.

This represents the actual size of the log file currently allocated. This may differs from getFileSizeUsed() in that this value may be greater if the log has been preallocated to a larger size.

Parameters:

val - The value to set.

getFileSize

long getFileSize()

Gets the value of 'fileSize'.

Field Description

The size of the file on disk.

This represents the actual size of the log file currently allocated. This may differs from getFileSizeUsed() in that this value may be greater if the log has been preallocated to a larger size.

Returns:

The size of the file on disk.

clearFileSize

void clearFileSize()

Clears the value of 'fileSize'.

Field Description

The size of the file on disk.

This represents the actual size of the log file currently allocated. This may differs from getFileSizeUsed() in that this value may be greater if the log has been preallocated to a larger size.

See Also:

setFileSize(long)

hasFileSize

boolean hasFileSize()

Checks for the presence of 'fileSize'.

Field Description

The size of the file on disk.

This represents the actual size of the log file currently allocated. This may differs from getFileSizeUsed() in that this value may be greater if the log has been preallocated to a larger size.

See Also:

getFileSize()

setFileSizeUsed

void setFileSizeUsed(long val)

Sets the value of 'fileSizeUsed'.

Field Description

The size of the allocated log file used in bytes.

This represents the amount of space used in the log file which may be less than the size on disk if the file has been preallocated to a larger size.

Parameters:

val - The value to set.

getFileSizeUsed

long getFileSizeUsed()

Gets the value of 'fileSizeUsed'.

Field Description

The size of the allocated log file used in bytes.

This represents the amount of space used in the log file which may be less than the size on disk if the file has been preallocated to a larger size.

Returns:

The size of the allocated log file used in bytes.

clearFileSizeUsed

void clearFileSizeUsed()

Clears the value of 'fileSizeUsed'.

Field Description

The size of the allocated log file used in bytes.

This represents the amount of space used in the log file which may be less than the size on disk if the file has been preallocated to a larger size.

See Also:

setFileSizeUsed(long)

hasFileSizeUsed

boolean hasFileSizeUsed()

Checks for the presence of 'fileSizeUsed'.

Field Description

The size of the allocated log file used in bytes.

This represents the amount of space used in the log file which may be less than the size on disk if the file has been preallocated to a larger size.

See Also:

getFileSizeUsed()

setDisruptorStats

void setDisruptorStats(SrvMonDisruptorStats val)

Sets the value of 'disruptorStats'.

Field Description

The disruptor stats for a message logger operating in detached mode.

Parameters:

val - The value to set.

lendDisruptorStats

void lendDisruptorStats(SrvMonDisruptorStats val)

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

Field Description

The disruptor stats for a message logger operating in detached mode.

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.

getDisruptorStats

SrvMonDisruptorStats getDisruptorStats()

Gets the value of 'disruptorStats'.

Field Description

The disruptor stats for a message logger operating in detached mode.

Returns:

The disruptor stats for a message logger operating in detached mode.

getDisruptorStatsTo

void getDisruptorStatsTo(SrvMonDisruptorStats val)

Copies the value of SrvMonDisruptorStats into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonDisruptorStats.copyInto(SrvMonDisruptorStats)

takeDisruptorStats

SrvMonDisruptorStats takeDisruptorStats()

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

Field Description

The disruptor stats for a message logger operating in detached mode.

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.

hasDisruptorStats

boolean hasDisruptorStats()

Checks for the presence of 'disruptorStats'.

Field Description

The disruptor stats for a message logger operating in detached mode.

See Also:

getDisruptorStats()

clearDisruptorStats

void clearDisruptorStats()

Clears the value of 'disruptorStats'.

Field Description

The disruptor stats for a message logger operating in detached mode.

See Also:

setDisruptorStats(SrvMonDisruptorStats)