IpcChannel (root 0.2-SNAPSHOT API)

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

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class IpcChannel
extends Object
implements Closeable
```
Канал данных

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IpcChannel.InReader

static class IpcChannel.OutWriter

Nested Classes
Modifier and Type	Class and Description
`static class`	`IpcChannel.InReader`
`static class`	`IpcChannel.OutWriter`

Field Summary

Fields
Modifier and Type	Field and Description
`protected ByteQueue`	`byteQueue`
`protected long`	`delay`
`protected File`	`file`
`protected int`	`id`
`protected static AtomicInteger`	`idseq`
`protected ByteQueue.InStream`	`input`
`protected static WeakHashMap<IpcChannel,Boolean>`	`instances`
`protected ByteQueue.OutStream`	`output`
`protected IpcChannel.InReader`	`reader`
`protected int`	`readTimeout`
`protected IpcChannel.OutWriter`	`writer`

Constructor Summary

Constructors
Constructor and Description

IpcChannel()

IpcChannel(File file)

IpcChannel(File file)

IpcChannel(String file)

Constructors
Constructor and Description
`IpcChannel()`
`IpcChannel(File file)`
`IpcChannel(File file)`
`IpcChannel(String file)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`protected void`	`finalize()`
`ByteQueue`	`getByteQueue()`
`long`	`getDelay()` Указывает задержку в цикле чтения данных в нано секундах.
`File`	`getFile()`
`int`	`getId()` Возвращает уникальный идентификатор объекта (в пределах процесса java.exe)
`ByteQueue.InStream`	`getInput()`
`static IpcChannel[]`	`getInstances()` Возвращает созданные экземпляры
`ByteQueue.OutStream`	`getOutput()`
`IpcChannel.InReader`	`getReader()`
`int`	`getReadTimeout()` Указывает максимальное время ожидания поступления данных
`IpcChannel.OutWriter`	`getWriter()`
`boolean`	`hasOwnerLock()` Очередь имеет блокировку владельца
`void`	`setDelay(long d)` Указывает задержку в цикле чтения данных в нано секундах.
`void`	`setFile(File file)`
`void`	`setReadTimeout(int readTimeout)` Указывает максимальное время ожидания поступления данных

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

- Field Detail
  - idseq
```
protected static final AtomicInteger idseq
```
  - id
```
protected final int id
```
  - instances
```
protected static final WeakHashMap<IpcChannel,Boolean> instances
```
  - file
```
protected File file
```
  - byteQueue
```
protected ByteQueue byteQueue
```
  - readTimeout
```
protected int readTimeout
```
  - delay
```
protected long delay
```
  - input
```
protected ByteQueue.InStream input
```
  - output
```
protected ByteQueue.OutStream output
```
  - reader
```
protected IpcChannel.InReader reader
```
  - writer
```
protected IpcChannel.OutWriter writer
```
- Constructor Detail
  - IpcChannel
```
public IpcChannel()
```
  - IpcChannel
```
public IpcChannel(String file)
```
  - IpcChannel
```
public IpcChannel(File file)
```
  - IpcChannel
```
public IpcChannel(File file)
```
- Method Detail
  - getInstances
```
public static IpcChannel[] getInstances()
```
    Возвращает созданные экземпляры
    
    Returns:
    
    экземпляры
  - getId
```
public int getId()
```
    Возвращает уникальный идентификатор объекта (в пределах процесса java.exe)
    
    Returns:
    
    идентификатор объекта
  - getFile
```
public File getFile()
```
  - setFile
```
public void setFile(File file)
```
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - getByteQueue
```
public ByteQueue getByteQueue()
```
  - hasOwnerLock
```
public boolean hasOwnerLock()
```
    Очередь имеет блокировку владельца
    
    Returns:
    
    true - владелец файла
  - getReadTimeout
```
public int getReadTimeout()
```
    Указывает максимальное время ожидания поступления данных
    
    Returns:
    
    макс. время ожидания в милисекундах или -1 - бесколнечно
  - setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
    Указывает максимальное время ожидания поступления данных
    
    Parameters:
    
    readTimeout - макс. время ожидания в милисекундах или -1 - бесколнечно
  - getDelay
```
public long getDelay()
```
    Указывает задержку в цикле чтения данных в нано секундах. По умолчанию 10000.
    0 - без задержки, -1 - поток передает управление yeild()
    
    Returns:
    
    задержка
  - setDelay
```
public void setDelay(long d)
```
    Указывает задержку в цикле чтения данных в нано секундах. По умолчанию 10000.
    0 - без задержки, -1 - поток передает управление yeild()
    
    Parameters:
    
    d - задержка
  - getInput
```
public ByteQueue.InStream getInput()
```
  - getOutput
```
public ByteQueue.OutStream getOutput()
```
  - getReader
```
public IpcChannel.InReader getReader()
```
  - getWriter
```
public IpcChannel.OutWriter getWriter()
```

Class IpcChannel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

idseq

id

instances

file

byteQueue

readTimeout

delay

input

output

reader

writer

Constructor Detail

IpcChannel

IpcChannel

IpcChannel

IpcChannel

Method Detail

getInstances

getId

getFile

setFile

close

finalize

getByteQueue

hasOwnerLock

getReadTimeout

setReadTimeout

getDelay

setDelay

getInput

getOutput

getReader

getWriter