Package org.apache.activemq.artemis.core.paging.impl

Class Page

java.lang.Object

org.apache.activemq.artemis.core.paging.impl.Page

public final class Page
extends Object

Constructor Summary

Constructors

Constructor	Description
Page(SimpleString storeName, StorageManager storageManager, SequentialFileFactory factory, SequentialFile file, long pageId)

Method Summary

Modifier and Type	Method	Description
void	close(boolean sendEvent)
void	close(boolean sendEvent, boolean waitSync)	sendEvent means it's a close happening from a major event such moveNext.
String	debugMessages()
boolean	delete(LinkedList<PagedMessage> messages)
boolean	equals(Object o)
SequentialFile	getFile()
LinkedList<PagedMessage>	getMessages()
int	getNumberOfMessages()
long	getPageId()
long	getSize()
int	hashCode()
boolean	isOpen()
LinkedListIterator<PagedMessage>	iterator()
boolean	open(boolean createFile)
LinkedList<PagedMessage>	read()
LinkedList<PagedMessage>	read(StorageManager storage)
LinkedList<PagedMessage>	read(StorageManager storage, boolean onlyLargeMessages)
int	readNumberOfMessages()
void	releaseTask(Consumer<Page> releaseTask)	to be called when the page is supposed to be released
void	sync()
String	toString()
int	usageDown()
void	usageExhaust()
int	usageUp()
void	write(PagedMessage message)
void	writeDirect(PagedMessage message)	This write will not interact back with the storage manager.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Page

public Page(SimpleString storeName,
            StorageManager storageManager,
            SequentialFileFactory factory,
            SequentialFile file,
            long pageId)
     throws Exception

Throws:

Exception

Method Detail

usageExhaust

public void usageExhaust()

usageUp

public int usageUp()

usageDown

public int usageDown()

releaseTask

public void releaseTask(Consumer<Page> releaseTask)

to be called when the page is supposed to be released

getPageId

public long getPageId()

iterator

public LinkedListIterator<PagedMessage> iterator()
                                          throws Exception

Throws:

Exception

getMessages

public LinkedList<PagedMessage> getMessages()
                                     throws Exception

Throws:

Exception

read

public LinkedList<PagedMessage> read()
                              throws Exception

Throws:

Exception

read

public LinkedList<PagedMessage> read(StorageManager storage)
                              throws Exception

Throws:

Exception

read

public LinkedList<PagedMessage> read(StorageManager storage,
                                     boolean onlyLargeMessages)
                              throws Exception

Throws:

Exception

debugMessages

public String debugMessages()
                     throws Exception

Throws:

Exception

write

public void write(PagedMessage message)
           throws Exception

Throws:

Exception

writeDirect

public void writeDirect(PagedMessage message)
                 throws Exception

This write will not interact back with the storage manager. To avoid ping pongs with Journal retaining events and any other stuff.

Throws:

Exception

sync

public void sync()
          throws Exception

Throws:

Exception

isOpen

public boolean isOpen()

open

public boolean open(boolean createFile)
             throws Exception

Throws:

Exception

close

public void close(boolean sendEvent)
           throws Exception

Throws:

Exception

close

public void close(boolean sendEvent,
                  boolean waitSync)
           throws Exception

sendEvent means it's a close happening from a major event such moveNext. While reading the cache we don't need (and shouldn't inform the backup

Throws:

Exception

delete

public boolean delete(LinkedList<PagedMessage> messages)
               throws Exception

Throws:

Exception

readNumberOfMessages

public int readNumberOfMessages()
                         throws Exception

Throws:

Exception

getNumberOfMessages

public int getNumberOfMessages()

getSize

public long getSize()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getFile

public SequentialFile getFile()