org.jboss.messaging.core.paging
Interface PagingStore

All Superinterfaces:
MessagingComponent
All Known Subinterfaces:
TestSupportPageStore
All Known Implementing Classes:
PagingStoreImpl

public interface PagingStore
extends MessagingComponent

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

Look at the WIKI for more information.

Author:
Clebert Suconic
See Also:
PagingManager

Method Summary
 void addSize(long memoryEstimate)
           
 long getAddressSize()
           
 long getMaxSizeBytes()
          Maximum number of bytes allowed in memory
 int getNumberOfPages()
           
 long getPageSizeBytes()
           
 SimpleString getStoreName()
           
 boolean isDropWhenMaxSize()
           
 boolean isPaging()
           
 boolean page(PagedMessage message, boolean sync, boolean duplicateDetection)
           
 boolean readPage()
           
 boolean startDepaging()
           
 boolean startDepaging(java.util.concurrent.Executor executor)
          When start depaging from a global perspective, we don't want all the stores depaging at once what could saturate the servers
 boolean startPaging()
           
 void sync()
           
 
Methods inherited from interface org.jboss.messaging.core.server.MessagingComponent
isStarted, start, stop
 

Method Detail

getNumberOfPages

int getNumberOfPages()

getStoreName

SimpleString getStoreName()

getMaxSizeBytes

long getMaxSizeBytes()
Maximum number of bytes allowed in memory


isDropWhenMaxSize

boolean isDropWhenMaxSize()

getPageSizeBytes

long getPageSizeBytes()

getAddressSize

long getAddressSize()

startPaging

boolean startPaging()
                    throws java.lang.Exception
Returns:
true if paging was started, or false if paging was already started before this call
Throws:
java.lang.Exception

isPaging

boolean isPaging()

sync

void sync()
          throws java.lang.Exception
Throws:
java.lang.Exception

page

boolean page(PagedMessage message,
             boolean sync,
             boolean duplicateDetection)
             throws java.lang.Exception
Throws:
java.lang.Exception

readPage

boolean readPage()
                 throws java.lang.Exception
Throws:
java.lang.Exception

startDepaging

boolean startDepaging()
Returns:
false if a thread was already started, or if not in page mode
Throws:
java.lang.Exception

startDepaging

boolean startDepaging(java.util.concurrent.Executor executor)
When start depaging from a global perspective, we don't want all the stores depaging at once what could saturate the servers


addSize

void addSize(long memoryEstimate)
             throws java.lang.Exception
Parameters:
memoryEstimate -
Throws:
java.lang.Exception


Copyright © 2006 JBoss Inc. All Rights Reserved.