Actor (artifact-actor 1.0.5 API)

所有超级接口:

Runnable

所有已知实现类:

AbstractActor, SafeActor
```
public interface Actor
extends Runnable
```
An Actor is a (repeatedly) dispatchable unit of execution. Actors accept messages and perform the operation (subject) they request. In response to messages actors can perform business logic and/or send messages to other actors (including themselves). Actors can be grouped into categories. This allows senders to direct messages to a category and have them processed by an arbitrary actor supporting that category. Often some load balancing scheme is used to distribute messages between actors if multiple actors belong to a category. Since an actor consumes a thread while processing a message and threads are a constrained resource, the actor should keep message processing as brief as possible. If possible, long running operations should be broken down into a sequence of messages. Actors should not take much time to process a message - in particular they should not block on long running actions, such as waiting for human input and sometime I/O; if they must do this, some form of polling (repeated message sends checking for completion, perhaps after a time delay) should be used to implement a wait. Messages have subjects and optional data. Subjects (AKA commands) determine what the message is requesting and the data (often an array, list or map) are any parameters to the subject. The run() method is called once when the actor registers with a manager. The loop() message is called whenever a message is received; actors can provide implementations to allow filtering of messages before reception.

作者:

bfeigenb

另请参阅:

ActorManager

字段概要

字段
限定符和类型字段和说明

static String DEFAULT_CATEGORY

字段
限定符和类型	字段和说明
`static String`	`DEFAULT_CATEGORY`

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`void`	`activate()` Tell this actor it is active.
`void`	`deactivate()` Tell this actor it is no longer active.
`String`	`getCategory()` Get the actor's category.
`int`	`getMaxMessageCount()` Get the maximum number of allowed pending messages.
`int`	`getMessageCount()` Get the number of pending messages.
`String`	`getName()` Get an actor's name.
`boolean`	`isShutdown()` Has shutdown() been called.
`boolean`	`isSuspended()` Test to see if suspended.
`Message`	`peekNext()` See if there is a pending message.
`Message`	`peekNext(String subject)` See if there is a pending message for a subject using exact match.
`Message`	`peekNext(String subject, boolean isRegExpr)` See if there is a pending message for a subject using reg expr match.
`boolean`	`receive()` Process the next incoming message.
`boolean`	`remove(Message message)` Remove (cancel) an unprocessed message.
`void`	`setCategory(String category)` Set the actor's category.
`void`	`setName(String name)` Set an actors name.
`void`	`setSuspended(boolean f)` Temporarily suspend the reception of messages.
`void`	`shutdown()` End reception of new messages.
`boolean`	`willReceive(String subject)` Test if this actor will receive a send with a specified subject.

从接口继承的方法 java.lang.Runnable
run

- 字段详细资料
  - DEFAULT_CATEGORY
```
static final String DEFAULT_CATEGORY
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getName
```
String getName()
```
    Get an actor's name. Must not be null once assigned to a manager
  - setName
```
void setName(String name)
```
    Set an actors name. Use with caution as the name must not change after being assigned to a manager.
  - getCategory
```
String getCategory()
```
    Get the actor's category. The category is used to group actors as send targets.
  - setCategory
```
void setCategory(String category)
```
    Set the actor's category. Do not set to null (use DEFAULT_CATEGORY).
  - receive
```
boolean receive()
```
    Process the next incoming message.
  - willReceive
```
boolean willReceive(String subject)
```
    Test if this actor will receive a send with a specified subject.
  - peekNext
```
Message peekNext()
```
    See if there is a pending message.
  - peekNext
```
Message peekNext(String subject)
```
    See if there is a pending message for a subject using exact match.
    
    参数:
    
    subject - target subject of the message
  - peekNext
```
Message peekNext(String subject,
                 boolean isRegExpr)
```
    See if there is a pending message for a subject using reg expr match.
    
    参数:
    
    subject - target subject of the message
    
    isRegExpr - the subject is a reg expr (vs. simple string)
  - remove
```
boolean remove(Message message)
```
    Remove (cancel) an unprocessed message.
    
    参数:
    
    message - to remove
    
    返回:
    
    true if removed
  - activate
```
void activate()
```
    Tell this actor it is active. Messages may be received before this call but they should be ignored.
  - deactivate
```
void deactivate()
```
    Tell this actor it is no longer active. Messages may be received after this call but they should be ignored.
  - setSuspended
```
void setSuspended(boolean f)
```
    Temporarily suspend the reception of messages.
    
    参数:
    
    f -
  - isSuspended
```
boolean isSuspended()
```
    Test to see if suspended.
  - shutdown
```
void shutdown()
```
    End reception of new messages. Typically used before removing an actor. Actors with pending messages should not be removed.
  - isShutdown
```
boolean isShutdown()
```
    Has shutdown() been called.
  - getMessageCount
```
int getMessageCount()
```
    Get the number of pending messages.
  - getMaxMessageCount
```
int getMaxMessageCount()
```
    Get the maximum number of allowed pending messages. Should be > 0; rarely more than (say) 100.

接口 Actor

字段概要

方法概要

从接口继承的方法 java.lang.Runnable

字段详细资料

DEFAULT_CATEGORY

方法详细资料

getName

setName

getCategory

setCategory

receive

willReceive

peekNext

peekNext

peekNext

remove

activate

deactivate

setSuspended

isSuspended

shutdown

isShutdown

getMessageCount

getMaxMessageCount