SEMState (SAFS API DOCUMENT)

java.lang.Object
- org.safs.staf.service.sem.SEMState

Direct Known Subclasses:

MutexState
```
public class SEMState
extends java.lang.Object
```
Author:

Carl Nagle

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MAX_STATE`
`static int`	`MIN_STATE`
`protected java.util.concurrent.Semaphore`	`sem`
`static java.lang.String[]`	`STATE_DESC`
`static int`	`STATE_INVALID`
`static int`	`STATE_POSTED`
`static int`	`STATE_RELEASED`
`static int`	`STATE_REQUESTED`
`static int`	`STATE_RESET`
`static int`	`STATE_WAITING`

Constructor Summary

Constructors
Constructor and Description

SEMState(java.lang.String itemname, int itemstate)
Creates a default Semaphore controlled item.

Constructors
Constructor and Description
`SEMState(java.lang.String itemname, int itemstate)` Creates a default Semaphore controlled item.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.ibm.staf.STAFResult`	`addWaiter()` Blocks the calling thread--which should be from an EmbeddedHandle--until the item is triggered with another thread's call to releaseWaiters.
`com.ibm.staf.STAFResult`	`addWaiter(long msTimeout)` Blocks the calling thread--which should be from an EmbeddedHandle-- until the item is triggered with another thread's call to releaseWaiters or the timeout has been reached.
`void`	`addWaiterId(java.lang.String waitername)`
`java.lang.String`	`getItemName()`
`int`	`getItemState()`
`java.lang.String`	`getStateDesc()` Return a description of the current item state.
`java.util.Vector<java.lang.String>`	`getWaiterIds()`
`boolean`	`hasWaiters()`
`void`	`releaseWaiters()` Release all waiters currently registered for the item.
`void`	`removeWaiterId(java.lang.String waitername)`
`protected void`	`setItemState(int state)`

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

- Field Detail
  - MIN_STATE
```
public static final int MIN_STATE
```
    See Also:
    
    Constant Field Values
  - STATE_WAITING
```
public static final int STATE_WAITING
```
    See Also:
    
    Constant Field Values
  - STATE_POSTED
```
public static final int STATE_POSTED
```
    See Also:
    
    Constant Field Values
  - STATE_RESET
```
public static final int STATE_RESET
```
    See Also:
    
    Constant Field Values
  - STATE_REQUESTED
```
public static final int STATE_REQUESTED
```
    See Also:
    
    Constant Field Values
  - STATE_RELEASED
```
public static final int STATE_RELEASED
```
    See Also:
    
    Constant Field Values
  - MAX_STATE
```
public static final int MAX_STATE
```
    See Also:
    
    Constant Field Values
  - STATE_INVALID
```
public static final int STATE_INVALID
```
    See Also:
    
    Constant Field Values
  - STATE_DESC
```
public static final java.lang.String[] STATE_DESC
```
  - sem
```
protected java.util.concurrent.Semaphore sem
```
- Constructor Detail
  - SEMState
```
public SEMState(java.lang.String itemname,
                int itemstate)
```
    Creates a default Semaphore controlled item. The default implementation allows any number of waiters to be registered and released for the given item--typically an Event.
    
    Parameters:
    
    itemname -
    
    itemstate -
    
    Throws:
    
    java.lang.IllegalArgumentException - if itemname or itemstate are invalid.
- Method Detail
  - getItemName
```
public java.lang.String getItemName()
```
  - getItemState
```
public int getItemState()
```
  - setItemState
```
protected void setItemState(int state)
```
  - addWaiterId
```
public void addWaiterId(java.lang.String waitername)
```
  - removeWaiterId
```
public void removeWaiterId(java.lang.String waitername)
```
  - getWaiterIds
```
public java.util.Vector<java.lang.String> getWaiterIds()
```
  - getStateDesc
```
public java.lang.String getStateDesc()
                              throws java.lang.IllegalArgumentException
```
    Return a description of the current item state.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - hasWaiters
```
public boolean hasWaiters()
```
    Returns:
    
    true if we have waiters already waiting. false if there are no known waiters.
  - releaseWaiters
```
public void releaseWaiters()
```
    Release all waiters currently registered for the item.
  - addWaiter
```
public com.ibm.staf.STAFResult addWaiter()
                                  throws java.lang.InterruptedException
```
    Blocks the calling thread--which should be from an EmbeddedHandle--until the item is triggered with another thread's call to releaseWaiters.
    Example call from an EmbeddedHandle:
    Returns:
    
    STAFResult.Ok when the item is available/posted/pulsed.
    
    Throws:
    
    java.lang.InterruptedException
  - addWaiter
```
public com.ibm.staf.STAFResult addWaiter(long msTimeout)
                                  throws java.lang.InterruptedException
```
    Blocks the calling thread--which should be from an EmbeddedHandle-- until the item is triggered with another thread's call to releaseWaiters or the timeout has been reached.
    Example call from an EmbeddedHandle:
    Returns:
    
    STAFResult.Ok, or STAFResult.Timeout
    
    Throws:
    
    java.lang.InterruptedException - if the waiting thread gets interrupted.

Class SEMState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_STATE

STATE_WAITING

STATE_POSTED

STATE_RESET

STATE_REQUESTED

STATE_RELEASED

MAX_STATE

STATE_INVALID

STATE_DESC

sem

Constructor Detail

SEMState

Method Detail

getItemName

getItemState

setItemState

addWaiterId

removeWaiterId

getWaiterIds

getStateDesc

hasWaiters

releaseWaiters

addWaiter

addWaiter