com.neeve.ods

Interface IStoreWriter

All Known Subinterfaces:

IStorePersister, IStoreSender

All Known Implementing Classes:

RogLog, com.neeve.ods.impl.StorePacketPersisterBase

public interface IStoreWriter

Represents a store writer.

This interface defines a store writer. Store writers durably write store objects and/or transactions to an abstract destination.

Threading:

A writer is not safe for concurrent access by multiple threads.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IStoreWriter.LogCounters Holds transaction log related counters.
static class	IStoreWriter.Parameters Contains writer parameters

Method Summary

Modifier and Type	Method and Description
void	flush(boolean sync) Sync any locally buffered data.
IStoreWriter.Parameters	getParameters() Get a writer's operating parameters
boolean	isShared() Indicates whether the writer is writing to a shared resource.
void	onRoleChange(IStoreBinding.Role role) Invoked to notify of a change to the role of the using store binding.
void	writeCommitEntry(PktPacket packet, boolean sync) Write a commit entry

Method Detail

getParameters

IStoreWriter.Parameters getParameters()

Get a writer's operating parameters

isShared

boolean isShared()

Indicates whether the writer is writing to a shared resource.

This method returns whether the writer is accessing a shared resource between primary and backup cluster members. Shared writers are only opened on the primary cluster members while non-shared writers are opened concurrently on both. However, transactions are recorded and committed concurrently on both shared and non-shared writers.

onRoleChange

void onRoleChange(IStoreBinding.Role role)

Invoked to notify of a change to the role of the using store binding.

This method is invoked by a store binding to notify a writer of a a change in the binding's role.

writeCommitEntry

void writeCommitEntry(PktPacket packet,
                      boolean sync)

Write a commit entry

Parameters:

packet - The commit entry packet to write

sync - Indicates whether to perform a flush(boolean) with sync after writing this commit entry.

Threading:

This method is not safe for concurrent access by multiple threads.

Note: This method assumes that the supplied packet has already been sync'd

flush

void flush(boolean sync)

Sync any locally buffered data.

Write operations performed using the writer can cache the written data in local memory. This operation flushes any buffered data out of the local memory. If the sync parameter is set to true, then the flush must synchornously push all the data to the destination e.g. cut through all intermediate buffers such as OS caches, CPU caches and network buffers.

No record operations will be invoked concurrently with this method.