BlockPublishStore (AMPS Java Client (5.3.2.1.6d15937f.540279))

java.lang.Object
- com.crankuptheamps.client.BlockPublishStore

All Implemented Interfaces:

Store, java.lang.AutoCloseable

Direct Known Subclasses:

MemoryPublishStore, PublishStore
```
public class BlockPublishStore
extends java.lang.Object
implements Store
```
BlockPublishStore is a base class for publish Store implementations. As messages are stored, space is allocated from a pre-created flat buffer. As messages are discarded, space in that buffer is marked "free" for future store operations. If messages are stored faster than they are published, the buffer is re-sized to create more capacity.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BlockPublishStore.Buffer` Interface which is used to hold the BlockPublishStore buffer data.
`static class`	`BlockPublishStore.ByteSequence` A simple wrapper object around a byte array that allows a sub-range to be specified using its offset and length properties.

Nested classes/interfaces inherited from interface com.crankuptheamps.client.Store
Store.StoreReplayer

Field Summary

Fields
Modifier and Type	Field and Description
`protected BlockPublishStore.Buffer`	`_buffer`
`protected PublishStoreResizeHandler`	`_resizeHandler`
`protected static int`	`AMPS_MIN_PUB_STORE_DISCARDED_VERSION`
`protected static int`	`METADATA_LAST_DISCARDED_LOCATION`
`protected static int`	`METADATA_VERSION_LOCATION`

Fields inherited from interface com.crankuptheamps.client.Store
SOWDeleteByBookmark, SOWDeleteByBookmarkCancel, SOWDeleteByData, SOWDeleteByFilter, SOWDeleteByKeys

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BlockPublishStore(BlockPublishStore.Buffer buffer)`
`protected`	`BlockPublishStore(BlockPublishStore.Buffer buffer, int blocksPerRealloc)`
`protected`	`BlockPublishStore(BlockPublishStore.Buffer buffer, int blocksPerRealloc, boolean isAFile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`discardUpTo(long index)` Discard all operations up to the index provided.
`void`	`flush()` Wait for the store to discard everything that has been stored up to the point in time when flush is called, then return.
`void`	`flush(long timeout)` Wait for the store to discard everything that has been stored up to the point in time when flush is called, then return.
`long`	`getHighestUnpersisted()`
`long`	`getLastPersisted()` Return the last persisted index in the store.
`long`	`getLowestUnpersisted()` Return the oldest index in the store.
`protected void`	`growFreeListIfEmpty()`
`protected void`	`recover()`
`void`	`replay(Store.StoreReplayer replayer)` Replay all operations in the store using the provided StoreReplayer.
`boolean`	`replaySingle(Store.StoreReplayer replayer, long index)` Replay the operation at the specified index.
`void`	`setMessage(Message m)` Provide the Store with a preallocated Message for use in replay.
`void`	`setResizeHandler(PublishStoreResizeHandler handler)` Set the resize handler for the publish store.
`void`	`store(Message m)` Store the provided message.
`protected void`	`store(Message m, boolean assignSequence)`
`long`	`unpersistedCount()` Return the number of operations in the store.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _resizeHandler
```
protected PublishStoreResizeHandler _resizeHandler
```
  - _buffer
```
protected BlockPublishStore.Buffer _buffer
```
  - AMPS_MIN_PUB_STORE_DISCARDED_VERSION
```
protected static final int AMPS_MIN_PUB_STORE_DISCARDED_VERSION
```
    See Also:
    
    Constant Field Values
  - METADATA_VERSION_LOCATION
```
protected static final int METADATA_VERSION_LOCATION
```
    See Also:
    
    Constant Field Values
  - METADATA_LAST_DISCARDED_LOCATION
```
protected static final int METADATA_LAST_DISCARDED_LOCATION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BlockPublishStore
```
protected BlockPublishStore(BlockPublishStore.Buffer buffer,
                            int blocksPerRealloc,
                            boolean isAFile)
```
  - BlockPublishStore
```
protected BlockPublishStore(BlockPublishStore.Buffer buffer,
                            int blocksPerRealloc)
```
  - BlockPublishStore
```
protected BlockPublishStore(BlockPublishStore.Buffer buffer)
```
- Method Detail
  - store
```
public void store(Message m)
           throws StoreException
```
    Description copied from interface: Store
    
    Store the provided message. The sequence of the message is a key that the client can later use to replay the operation or remove the operation from the store. Implementations may assume that the sequence increases monotonically.
    
    Specified by:
    
    store in interface Store
    
    Parameters:
    
    m - the message to store
    
    Throws:
    
    StoreException - Thrown if the Store is unable to store the message.
  - close
```
public void close()
           throws java.lang.Exception
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.lang.Exception
  - store
```
protected void store(Message m,
                     boolean assignSequence)
              throws StoreException
```
    Throws:
    
    StoreException
  - discardUpTo
```
public void discardUpTo(long index)
                 throws StoreException
```
    Description copied from interface: Store
    
    Discard all operations up to the index provided.
    
    Specified by:
    
    discardUpTo in interface Store
    
    Parameters:
    
    index - the index number to keep -- all previous index numbers will be discarded
    
    Throws:
    
    StoreException - Thrown if the Store is unable to discard the messages.
  - getLastPersisted
```
public long getLastPersisted()
                      throws StoreException
```
    Description copied from interface: Store
    
    Return the last persisted index in the store.
    
    Specified by:
    
    getLastPersisted in interface Store
    
    Returns:
    
    The sequence number of the last discarded message.
    
    Throws:
    
    StoreException - Thrown if the store is unable to produce the last persisted index.
  - getLowestUnpersisted
```
public long getLowestUnpersisted()
```
    Description copied from interface: Store
    
    Return the oldest index in the store.
    
    Specified by:
    
    getLowestUnpersisted in interface Store
    
    Returns:
    
    The lowest sequence number of an operation in the store.
  - getHighestUnpersisted
```
public long getHighestUnpersisted()
```
  - setMessage
```
public void setMessage(Message m)
```
    Description copied from interface: Store
    
    Provide the Store with a preallocated Message for use in replay.
    
    Specified by:
    
    setMessage in interface Store
    
    Parameters:
    
    m - The message object for the Store to use during replay.
  - replay
```
public void replay(Store.StoreReplayer replayer)
            throws StoreException,
                   DisconnectedException
```
    Description copied from interface: Store
    
    Replay all operations in the store using the provided StoreReplayer.
    
    Specified by:
    
    replay in interface Store
    
    Parameters:
    
    replayer - the StoreReplayer to use to replay the operations
    
    Throws:
    
    StoreException - Thrown if the Store is unable to replay the operations.
    
    DisconnectedException - Thrown if the Store receives a DisconnectedException while replaying.
  - replaySingle
```
public boolean replaySingle(Store.StoreReplayer replayer,
                            long index)
                     throws StoreException,
                            DisconnectedException
```
    Description copied from interface: Store
    
    Replay the operation at the specified index.
    
    Specified by:
    
    replaySingle in interface Store
    
    Parameters:
    
    replayer - the StoreReplayer to use to replay the operations
    
    index - The index of the message to replay within the store
    
    Returns:
    
    Success returns true, false if the index is not in the Store
    
    Throws:
    
    StoreException - Thrown if the Store is unable to replay the operations.
    
    DisconnectedException - Thrown if the Store receives a DisconnectedException while replaying.
  - unpersistedCount
```
public long unpersistedCount()
```
    Description copied from interface: Store
    
    Return the number of operations in the store.
    
    Specified by:
    
    unpersistedCount in interface Store
    
    Returns:
    
    The number of operations in the store.
  - recover
```
protected void recover()
                throws StoreException
```
    Throws:
    
    StoreException
  - growFreeListIfEmpty
```
protected void growFreeListIfEmpty()
                            throws StoreException
```
    Throws:
    
    StoreException
  - flush
```
public void flush()
           throws TimedOutException
```
    Description copied from interface: Store
    
    Wait for the store to discard everything that has been stored up to the point in time when flush is called, then return.
    
    Specified by:
    
    flush in interface Store
    
    Throws:
    
    TimedOutException - Not thrown from this overload.
  - flush
```
public void flush(long timeout)
           throws TimedOutException
```
    Description copied from interface: Store
    
    Wait for the store to discard everything that has been stored up to the point in time when flush is called, then return. Throw an exception if this is not completed in the number of milliseconds specified by the timeout.
    
    Specified by:
    
    flush in interface Store
    
    Parameters:
    
    timeout - the number of milliseconds to wait for the flush
    
    Throws:
    
    TimedOutException - Thrown if the timeout period passes without the messages being discarded.
  - setResizeHandler
```
public void setResizeHandler(PublishStoreResizeHandler handler)
```
    Description copied from interface: Store
    
    Set the resize handler for the publish store. An implementation can call the resize handler in the event that it needs to grow the size of the publish store.
    
    Specified by:
    
    setResizeHandler in interface Store
    
    Parameters:
    
    handler - The handler to install.

Class BlockPublishStore

Nested Class Summary

Nested classes/interfaces inherited from interface com.crankuptheamps.client.Store

Field Summary

Fields inherited from interface com.crankuptheamps.client.Store

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_resizeHandler

_buffer

AMPS_MIN_PUB_STORE_DISCARDED_VERSION

METADATA_VERSION_LOCATION

METADATA_LAST_DISCARDED_LOCATION

Constructor Detail

BlockPublishStore

BlockPublishStore

BlockPublishStore

Method Detail

store

close

store

discardUpTo

getLastPersisted

getLowestUnpersisted

getHighestUnpersisted

setMessage

replay

replaySingle

unpersistedCount

recover

growFreeListIfEmpty

flush

flush

setResizeHandler