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

Class Page

java.lang.Object

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

All Implemented Interfaces:

Comparable<Page>

public final class Page
extends Object
implements Comparable<Page>

Field Summary

Fields

Modifier and Type	Field	Description
static int	SIZE_RECORD

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addPendingCounter(PageSubscriptionCounter pageSubscriptionCounter)	This will indicate a page that will need to be called on cleanup when the page has been closed and confirmed
void	close(boolean sendEvent)
void	close(boolean sendEvent, boolean waitSync)	sendEvent means it's a close happening from a major event such moveNext.
int	compareTo(Page otherPage)
boolean	delete(PagedMessage[] messages)
boolean	equals(Object obj)
SequentialFile	getFile()
LivePageCache	getLiveCache()
int	getNumberOfMessages()
int	getPageId()
int	getSize()
int	hashCode()
boolean	isLive()
void	open(boolean createFile)
List<PagedMessage>	read()
List<PagedMessage>	read(StorageManager storage)
List<PagedMessage>	read(StorageManager storage, boolean onlyLargeMessages)
PagedMessage	readMessage(int startOffset, int startMessageNumber, int targetMessageNumber)
void	setLiveCache(LivePageCache pageCache)
void	sync()
String	toString()
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

Field Detail

SIZE_RECORD

public static final int SIZE_RECORD

See Also:

Constant Field Values

Constructor Detail

Page

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

Throws:

Exception

Method Detail

getPageId

public int getPageId()

setLiveCache

public void setLiveCache(LivePageCache pageCache)

getLiveCache

public LivePageCache getLiveCache()

readMessage

public PagedMessage readMessage(int startOffset,
                                int startMessageNumber,
                                int targetMessageNumber)
                         throws Exception

Throws:

Exception

read

public List<PagedMessage> read()
                        throws Exception

Throws:

Exception

read

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

Throws:

Exception

read

public List<PagedMessage> read(StorageManager storage,
                               boolean onlyLargeMessages)
                        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

open

public void 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

isLive

public boolean isLive()

delete

public boolean delete(PagedMessage[] messages)
               throws Exception

Throws:

Exception

getNumberOfMessages

public int getNumberOfMessages()

getSize

public int getSize()

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Page otherPage)

Specified by:

compareTo in interface Comparable<Page>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getFile

public SequentialFile getFile()

addPendingCounter

public void addPendingCounter(PageSubscriptionCounter pageSubscriptionCounter)

This will indicate a page that will need to be called on cleanup when the page has been closed and confirmed

Parameters:

pageSubscriptionCounter -