Cell

java.lang.Object
- kilim.Cell<T>

All Implemented Interfaces:

EventPublisher, PauseReason
```
public class Cell<T>
extends java.lang.Object
implements PauseReason, EventPublisher
```
A cell is a single-space buffer that supports multiple producers and a single consumer, functionally identical to Mailbox bounded to a size of 1 (and hence optimized for this size)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Cell.BlockingSubscriber

Nested Classes
Modifier and Type	Class and Description
`class`	`Cell.BlockingSubscriber`

Field Summary

Fields
Modifier and Type	Field and Description
`static Event`	`messageAvailable`
`static int`	`MSG_AVAILABLE`
`static int`	`SPACE_AVAILABLE`
`static Event`	`spaceAvailble`
`static int`	`TIMED_OUT`
`static Event`	`timedOut`

Constructor Summary

Constructors
Constructor and Description

Cell()

Constructors
Constructor and Description
`Cell()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMsgAvailableListener(EventSubscriber msgSub)`
`void`	`addSpaceAvailableListener(EventSubscriber spcSub)`
`T`	`get()`
`T`	`get(EventSubscriber eo)` Non-blocking, nonpausing get.
`T`	`get(long timeoutMillis)`
`T`	`getb()` retrieve a message, blocking the thread indefinitely.
`T`	`getb(long timeoutMillis)` retrieve a msg, and block the Java thread for the time given.
`T`	`getnb()` Get, don't pause or block.
`boolean`	`hasMessage()`
`boolean`	`hasSpace()`
`boolean`	`isValid(Task t)` True if the given task's reason for pausing is still valid.
`void`	`put(T msg)`
`boolean`	`put(T msg, EventSubscriber eo)` Non-blocking, nonpausing put.
`boolean`	`put(T msg, int timeoutMillis)`
`void`	`putb(T msg)`
`void`	`putb(T msg, long timeoutMillis)`
`boolean`	`putnb(T msg)`
`void`	`removeMsgAvailableListener(EventSubscriber msgSub)`
`void`	`removeSpaceAvailableListener(EventSubscriber spcSub)`
`java.lang.String`	`toString()`

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

- Field Detail
  - SPACE_AVAILABLE
```
public static final int SPACE_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - MSG_AVAILABLE
```
public static final int MSG_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - TIMED_OUT
```
public static final int TIMED_OUT
```
    See Also:
    
    Constant Field Values
  - spaceAvailble
```
public static final Event spaceAvailble
```
  - messageAvailable
```
public static final Event messageAvailable
```
  - timedOut
```
public static final Event timedOut
```
- Constructor Detail
  - Cell
```
public Cell()
```
- Method Detail
  - get
```
public T get(EventSubscriber eo)
```
    Non-blocking, nonpausing get.
    
    Parameters:
    
    eo - . If non-null (and if there is no message), registers this observer. The observer is notified with a MessageAvailable event when a put() is done.
    
    Returns:
    
    buffered message if there's one, or null
  - put
```
public boolean put(T msg,
                   EventSubscriber eo)
```
    Non-blocking, nonpausing put.
    
    Parameters:
    
    eo - . If non-null, registers this observer and calls it with an SpaceAvailable event when there's space.
    
    Returns:
    
    buffered message if there's one, or null
  - getnb
```
public T getnb()
```
    Get, don't pause or block.
    
    Returns:
    
    stored message, or null if no message found.
  - get
```
public T get()
      throws Pausable
```
    Returns:
    
    non-null message.
    
    Throws:
    
    Pausable
  - get
```
public T get(long timeoutMillis)
      throws Pausable
```
    Returns:
    
    non-null message.
    
    Throws:
    
    Pausable
  - addSpaceAvailableListener
```
public void addSpaceAvailableListener(EventSubscriber spcSub)
```
  - removeSpaceAvailableListener
```
public void removeSpaceAvailableListener(EventSubscriber spcSub)
```
  - addMsgAvailableListener
```
public void addMsgAvailableListener(EventSubscriber msgSub)
```
  - removeMsgAvailableListener
```
public void removeMsgAvailableListener(EventSubscriber msgSub)
```
  - putnb
```
public boolean putnb(T msg)
```
  - put
```
public void put(T msg)
         throws Pausable
```
    Throws:
    
    Pausable
  - put
```
public boolean put(T msg,
                   int timeoutMillis)
            throws Pausable
```
    Throws:
    
    Pausable
  - putb
```
public void putb(T msg)
```
  - putb
```
public void putb(T msg,
                 long timeoutMillis)
```
  - hasMessage
```
public boolean hasMessage()
```
  - hasSpace
```
public boolean hasSpace()
```
  - getb
```
public T getb()
```
    retrieve a message, blocking the thread indefinitely. Note, this is a heavyweight block, unlike #get() that pauses the Fiber but doesn't block the thread.
  - getb
```
public T getb(long timeoutMillis)
```
    retrieve a msg, and block the Java thread for the time given.
    
    Parameters:
    
    millis - . max wait time
    
    Returns:
    
    null if timed out.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isValid
```
public boolean isValid(Task t)
```
    Description copied from interface: PauseReason
    
    True if the given task's reason for pausing is still valid.
    
    Specified by:
    
    isValid in interface PauseReason

Class Cell<T>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SPACE_AVAILABLE

MSG_AVAILABLE

TIMED_OUT

spaceAvailble

messageAvailable

timedOut

Constructor Detail

Cell

Method Detail

get

put

getnb

get

get

addSpaceAvailableListener

removeSpaceAvailableListener

addMsgAvailableListener

removeMsgAvailableListener

putnb

put

put

putb

putb

hasMessage

hasSpace

getb

getb

toString

isValid