org.hornetq.core.paging

Interface PagingStore

All Superinterfaces:

HornetQComponent

All Known Subinterfaces:

TestSupportPageStore

All Known Implementing Classes:

PagingStoreImpl

public interface PagingStore
extends HornetQComponent

The implementation will take care of details such as PageSize.

The producers will write directly to PagingStore and that will decide what Page file should be used based on configured size

Author:

Clebert Suconic

See Also:

PagingManager

Method Summary

Methods

Modifier and Type	Method and Description
void	addSize(int size)
void	applySetting(AddressSettings addressSettings)
boolean	checkPage(int page)
Page	createPage(int page)
Page	depage() Remove the first page from the Writing Queue.
void	executeRunnableWhenMemoryAvailable(Runnable runnable)
void	flushExecutors() This is used mostly by tests.
void	forceAnotherPage()
SimpleString	getAddress()
AddressFullMessagePolicy	getAddressFullMessagePolicy()
long	getAddressSize()
Page	getCurrentPage()
int	getCurrentWritingPage()
PageCursorProvider	getCursorProvier()
long	getFirstPage()
String	getFolder()
long	getMaxSize()
int	getNumberOfPages()
long	getPageSizeBytes()
PagingManager	getPagingManager()
SimpleString	getStoreName()
long	getTopPage()
void	ioSync()
boolean	isPaging()
void	lock() This method will hold and producer, but it wait operations to finish before locking (write lock)
boolean	page(ServerMessage message, RoutingContext ctx)
boolean	page(ServerMessage message, RoutingContext ctx, RouteContextList listCtx)
void	processReload()
boolean	startPaging()
void	stopPaging()
void	sync()
void	unlock() Call this method using the same thread used by the last call of lock()

Methods inherited from interface org.hornetq.core.server.HornetQComponent

isStarted, start, stop

Method Detail

getAddress

SimpleString getAddress()

getNumberOfPages

int getNumberOfPages()

getCurrentWritingPage

int getCurrentWritingPage()

getStoreName

SimpleString getStoreName()

getFolder

String getFolder()

getAddressFullMessagePolicy

AddressFullMessagePolicy getAddressFullMessagePolicy()

getFirstPage

long getFirstPage()

getTopPage

long getTopPage()

getPageSizeBytes

long getPageSizeBytes()

getAddressSize

long getAddressSize()

getMaxSize

long getMaxSize()

applySetting

void applySetting(AddressSettings addressSettings)

isPaging

boolean isPaging()

sync

void sync()
          throws Exception

Throws:

Exception

ioSync

void ioSync()
            throws Exception

Throws:

Exception

page

boolean page(ServerMessage message,
           RoutingContext ctx)
             throws Exception

Throws:

Exception

page

boolean page(ServerMessage message,
           RoutingContext ctx,
           RouteContextList listCtx)
             throws Exception

Throws:

Exception

createPage

Page createPage(int page)
                throws Exception

Throws:

Exception

checkPage

boolean checkPage(int page)
                  throws Exception

Throws:

Exception

getPagingManager

PagingManager getPagingManager()

getCursorProvier

PageCursorProvider getCursorProvier()

processReload

void processReload()
                   throws Exception

Throws:

Exception

depage

Page depage()
            throws Exception

Remove the first page from the Writing Queue. The file will still exist until Page.delete is called, So, case the system is reloaded the same Page will be loaded back if delete is not called.

Throws:

Exception - Note: This should still be part of the interface, even though HornetQ only uses through the

forceAnotherPage

void forceAnotherPage()
                      throws Exception

Throws:

Exception

getCurrentPage

Page getCurrentPage()

startPaging

boolean startPaging()
                    throws Exception

Returns:

true if paging was started, or false if paging was already started before this call

Throws:

Exception

stopPaging

void stopPaging()
                throws Exception

Throws:

Exception

addSize

void addSize(int size)

executeRunnableWhenMemoryAvailable

void executeRunnableWhenMemoryAvailable(Runnable runnable)

lock

void lock()

This method will hold and producer, but it wait operations to finish before locking (write lock)

unlock

void unlock()

Call this method using the same thread used by the last call of lock()

flushExecutors

void flushExecutors()

This is used mostly by tests. We will wait any pending runnable to finish its execution