ByteQueue (common 0.2.2 API)

java.lang.Object
- xyz.cofe.ipc.sharedmem.ByteQueue

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class ByteQueue
extends Object
implements Closeable
```
Очередь байт-сообщений работающая через общуюю память (shared memory) используя синхронизацию (блокировки файлов на уровне ОС и java).

Очередь байт - сообщений связана через файл спроицированный в память.

Шаблон использования:

// Создание очереди ByteQueue bq = new ByteQueue(); // Открытие файла очереди bq.open( file ); if( bq.hasOwnerLock() ){ }else{ }

Author:

nt.gocha@gmail.com

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ByteQueue.InStream

static class ByteQueue.OutStream

Nested Classes
Modifier and Type	Class and Description
`static class`	`ByteQueue.InStream`
`static class`	`ByteQueue.OutStream`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<MutableBlockHead>`	`blocks`
`protected MappedByteBuffer`	`buff`
`protected long`	`buffLength`
`protected long`	`buffOffset`
`protected FileChannel`	`fchannel`
`protected File`	`file`
`protected MutableQueueHead`	`head`
`protected FileLock`	`ownerLock`
`protected RandomAccessFile`	`raFile`

Constructor Summary

Constructors
Constructor and Description

ByteQueue()

Constructors
Constructor and Description
`ByteQueue()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected BlockHead`	`appendBlock(byte[] data)` Добавляет блок в конец очереди, увеличивая ее
`protected void`	`checkBuffInfo()` Проверка буфера при открытии файла
`void`	`checkFreeBlocks()` Проверяет наличие свободных блоков, Последовательность (2 и более) пустых блоков объединяет в один блок
`protected void`	`checkFreeBlocks(boolean useLock)` Проверяет наличие свободных блоков, Последовательность (2 и более) пустых блоков объединяет в один блок
`protected void`	`checkHeadSCN()` Проверяет совпадение SCN номера в заголовке.
`void`	`close()`
`void`	`dumpBlocks()` Выводит таблицу блоков на STDIO
`void`	`dumpBlocks(Writer out)` Выводит таблицу блоков
`protected Pair<Integer,MutableBlockHead>`	`findFreeBlock_WSEMore(int size, int from)` Ищет свободный блок с указанным размером или больше
`protected List<MutableBlockHead>`	`getBlocksWithData()` Читает блоки и возвращает тек которые содержат данные, в последовательности увел.
`File`	`getFile()` Возвращает файл с которым происходит работа
`protected byte[]`	`getMD5Buff()` Возвращает MD5 буфера
`boolean`	`hasOwnerLock()` Очередь имеет блокировку владельца
`boolean`	`isClosed()`
`protected void`	`joinBlocks(List<MutableBlockHead> freeBlocks)`
`protected FileLock`	`lockHead()`
`protected void`	`logFreeBlocks()` Лог по свободным блокам
`void`	`open(File file)`
`protected void`	`readBlockHeaders()` Блокирует head Читает заголовки Снимает блокировку head
`long`	`readBlocks(OutputStream out)` Читает блоки с данными, отмечает их как не содержащие данные Устанавливает блокирову head.
`protected long`	`readBlocksTo(OutputStream out)` Читает блоки с данными и записывает их в указанный поток.
`protected void`	`rereadBlockHeaders()` Перепрочитывает заголовки, предпологается что блокировка head, установлена
`protected void`	`resetHeaders()`
`void`	`setFile(File file)` Указывает файл с которым происходит работа
`protected Pair<MutableBlockHead,MutableBlockHead>`	`splitBlock(MutableBlockHead block, int size)` Разделяет блок на два, Блоки не заносятся в таблицу блоков и не сохраняются в shared mem.
`protected Pair<Integer,MutableBlockHead>`	`tryInsert(byte[] data)`
`protected void`	`unlockHead(FileLock lock)`
`BlockHead`	`writeBlock(byte[] data)` Последовательность действий Устанавливает блокировку head Проверяет SCN Увеличивает SCN на 1 Добавляет блок данных в конец очереди SCN текущий Записывает блок и его заголовок в shared mem Обновляет заголовок очереди в shared mem Снимает блокировку head
`protected void`	`writeBuffInfo()` Записывает MD5 буфера в начало файла
`protected BlockHead`	`writeFirstBlock(byte[] data)` Создаеи первый блок

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

- Field Detail
  - raFile
```
protected RandomAccessFile raFile
```
  - fchannel
```
protected FileChannel fchannel
```
  - buff
```
protected MappedByteBuffer buff
```
  - buffOffset
```
protected long buffOffset
```
  - buffLength
```
protected long buffLength
```
  - ownerLock
```
protected FileLock ownerLock
```
  - head
```
protected MutableQueueHead head
```
  - blocks
```
protected List<MutableBlockHead> blocks
```
  - file
```
protected File file
```
- Constructor Detail
  - ByteQueue
```
public ByteQueue()
```
- Method Detail
  - getFile
```
public File getFile()
```
    Возвращает файл с которым происходит работа
    
    Returns:
    
    файл с которым происходит работа
  - setFile
```
public void setFile(File file)
```
    Указывает файл с которым происходит работа
    
    Parameters:
    
    file - файл с которым происходит работа
  - hasOwnerLock
```
public boolean hasOwnerLock()
```
    Очередь имеет блокировку владельца
    
    Returns:
    
    true - владелец файла
  - open
```
public void open(File file)
          throws IOException
```
    Throws:
    
    IOException
  - isClosed
```
public boolean isClosed()
```
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - checkBuffInfo
```
protected void checkBuffInfo()
```
    Проверка буфера при открытии файла
  - writeBuffInfo
```
protected void writeBuffInfo()
```
    Записывает MD5 буфера в начало файла
  - getMD5Buff
```
protected byte[] getMD5Buff()
```
    Возвращает MD5 буфера
    
    Returns:
    
    md5 буфера
  - lockHead
```
protected FileLock lockHead()
                     throws IOException
```
    Throws:
    
    IOException
  - unlockHead
```
protected void unlockHead(FileLock lock)
                   throws IOException
```
    Throws:
    
    IOException
  - resetHeaders
```
protected void resetHeaders()
```
  - readBlockHeaders
```
protected void readBlockHeaders()
```
    Блокирует head
    Читает заголовки
    Снимает блокировку head
  - rereadBlockHeaders
```
protected void rereadBlockHeaders()
```
    Перепрочитывает заголовки, предпологается что блокировка head, установлена
  - checkHeadSCN
```
protected void checkHeadSCN()
```
    Проверяет совпадение SCN номера в заголовке.
    Если scn номер совпадает, то завершает свою работу.
    Если не совпадает, то перепрочитывает заголовоки.
    Предполагается что head блокировка установлена.
  - writeFirstBlock
```
protected BlockHead writeFirstBlock(byte[] data)
```
    Создаеи первый блок
    
    Parameters:
    
    data - Данные
    
    Returns:
    
    Заголовок блока
  - appendBlock
```
protected BlockHead appendBlock(byte[] data)
```
    Добавляет блок в конец очереди, увеличивая ее
    
    Parameters:
    
    data - Данные
    
    Returns:
    
    Заголовок блока
  - tryInsert
```
protected Pair<Integer,MutableBlockHead> tryInsert(byte[] data)
```
  - writeBlock
```
public BlockHead writeBlock(byte[] data)
```
    Последовательность действий
    1. Устанавливает блокировку head
    2. Проверяет SCN
    3. Увеличивает SCN на 1
    4. Добавляет блок данных
      
      в конец очереди
      
      SCN текущий
      
      Записывает блок и его заголовок в shared mem
      
      Обновляет заголовок очереди в shared mem
    5. Снимает блокировку head
    Parameters:
    
    data - Данные блока
    
    Returns:
    
    Записанный блок
  - getBlocksWithData
```
protected List<MutableBlockHead> getBlocksWithData()
```
    Читает блоки и возвращает тек которые содержат данные, в последовательности увел. SCN
    
    Returns:
    
    блоки данных
  - readBlocksTo
```
protected long readBlocksTo(OutputStream out)
                     throws IOException
```
    Читает блоки с данными и записывает их в указанный поток.
    Отмечает прочитанные блоки как без данных, setHasData( false ).
    Если прочитаен хоть один бок, увеличивает номер SCN и обновляет заголовок очереди.
    
    Parameters:
    
    out - Поток куда записываются данные
    
    Returns:
    
    Кол-во байт прочитанных
    
    Throws:
    
    IOException - ошибка IO
  - readBlocks
```
public long readBlocks(OutputStream out)
```
    Читает блоки с данными, отмечает их как не содержащие данные
    - Устанавливает блокирову head.
    - Вызывает метод readBlocksTo.
    - Снимает блокирову head.
    Parameters:
    
    out - Куда будут записаны данные
    
    Returns:
    
    Кол-во прочитаных байт, возможно 0 - т.е. новых не поступало
  - dumpBlocks
```
public void dumpBlocks()
```
    Выводит таблицу блоков на STDIO
  - dumpBlocks
```
public void dumpBlocks(Writer out)
```
    Выводит таблицу блоков
    
    Parameters:
    
    out - Куда вывести
  - logFreeBlocks
```
protected void logFreeBlocks()
```
    Лог по свободным блокам
  - splitBlock
```
protected Pair<MutableBlockHead,MutableBlockHead> splitBlock(MutableBlockHead block,
                                                             int size)
```
    Разделяет блок на два,
    Блоки не заносятся в таблицу блоков и не сохраняются в shared mem.
    У новых блоков установлены только по два поля: position и dataLen
    Исходный блок из таблицы не удален.
    
    Parameters:
    
    block - Исходный блок
    
    size - Требуемый размер
    
    Returns:
    
    Блок с требуемым размером / Блок с оставшиеми данными; или null разделяемый блок мал
  - findFreeBlock_WSEMore
```
protected Pair<Integer,MutableBlockHead> findFreeBlock_WSEMore(int size,
                                                               int from)
```
    Ищет свободный блок с указанным размером или больше
    
    Parameters:
    
    size - необходимый размер
    
    from - С какого начинать поиск, 0 - с начала
    
    Returns:
    
    Индекс/Блок или null если не найден
  - checkFreeBlocks
```
public void checkFreeBlocks()
```
    Проверяет наличие свободных блоков, Последовательность (2 и более) пустых блоков объединяет в один блок
  - checkFreeBlocks
```
protected void checkFreeBlocks(boolean useLock)
```
    Проверяет наличие свободных блоков, Последовательность (2 и более) пустых блоков объединяет в один блок
    
    Parameters:
    
    useLock - использовать блокировку
  - joinBlocks
```
protected void joinBlocks(List<MutableBlockHead> freeBlocks)
```

Class ByteQueue

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

raFile

fchannel

buff

buffOffset

buffLength

ownerLock

head

blocks

file

Constructor Detail

ByteQueue

Method Detail

getFile

setFile

hasOwnerLock

open

isClosed

close

checkBuffInfo

writeBuffInfo

getMD5Buff

lockHead

unlockHead

resetHeaders

readBlockHeaders

rereadBlockHeaders

checkHeadSCN

writeFirstBlock

appendBlock

tryInsert

writeBlock

getBlocksWithData

readBlocksTo

readBlocks

dumpBlocks

dumpBlocks

logFreeBlocks

splitBlock

findFreeBlock_WSEMore

checkFreeBlocks

checkFreeBlocks

joinBlocks