Actors (kontraktor 2.00 API)

java.lang.Object
- org.nustaq.kontraktor.Actors

```
public class Actors
extends Object
```
Copyright (c) 2012, Ruediger Moeller. All rights reserved. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Date: 04.01.14 Time: 19:50 To change this template use File | Settings | File Templates.

Field Summary

Fields
Modifier and Type Field and Description

protected ActorProxyFactory factory

static Actors instance

Fields
Modifier and Type	Field and Description
`protected ActorProxyFactory`	`factory`
`static Actors`	`instance`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Actors()

Constructors
Modifier	Constructor and Description
`protected`	`Actors()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`AddDeadLetter(String s)`
`static <T extends Actor> T`	`AsActor(Class<? extends Actor> actorClazz)` create an new actor.
`static <T extends Actor> T`	`AsActor(Class<? extends Actor> actorClazz, int qSize)` create an new actor.
`static <T extends Actor> T`	`AsActor(Class<? extends Actor> actorClazz, Scheduler scheduler)` create an new actor dispatched in the given DispatcherThread
`static <T extends Actor> T`	`AsActor(Class<? extends Actor> actorClazz, Scheduler scheduler, int qsize)` create an new actor dispatched in the given DispatcherThread
`static Future<Future[]>`	`async(Callable<Future>... toexec)` mimics scala's async macro. callables are executed in order. if a callable returns a promise, execution of the next callable is deferred until the promise is fulfilled.
`protected Queue`	`createQueue(int qSize)`
`static ConcurrentLinkedQueue<String>`	`DeadLetters()` messages that have been dropped or have been sent to stopped actors
`ActorProxyFactory`	`getFactory()`
`static <T> T`	`InThread(T anInterface)` in case called from an actor, wraps the given interface instance into a proxy such that a calls on the interface get schedulled on the actors thread (avoids accidental multithreading when handing out callback/listener interfaces from an actor)
`protected Actor`	`makeProxy(Class<? extends Actor> clz, DispatcherThread disp, int qs)`
`protected Actor`	`newProxy(Class<? extends Actor> clz, Scheduler sched, int qsize)`
`<T> T`	`sync(Future<T> fut)` block until future returns.
`static Object[]`	`toResults(Future[] futs)`
`static Future<Future[]>`	`yield(Future... futures)`
`static Future<List<Future>>`	`yield(List<Future> futures)`

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

- Field Detail
  - instance
```
public static Actors instance
```
  - factory
```
protected ActorProxyFactory factory
```
- Constructor Detail
  - Actors
```
protected Actors()
```
- Method Detail
  - AddDeadLetter
```
public static void AddDeadLetter(String s)
```
  - InThread
```
public static <T> T InThread(T anInterface)
```
    in case called from an actor, wraps the given interface instance into a proxy such that a calls on the interface get schedulled on the actors thread (avoids accidental multithreading when handing out callback/listener interfaces from an actor)
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    anInterface -
    
    Returns:
  - DeadLetters
```
public static ConcurrentLinkedQueue<String> DeadLetters()
```
    messages that have been dropped or have been sent to stopped actors
    
    Returns:
    
    queue of dead letters. Note: only strings are recorded to avoid accidental references.
  - AsActor
```
public static <T extends Actor> T AsActor(Class<? extends Actor> actorClazz)
```
    create an new actor. If this is called outside an actor, a new DispatcherThread will be scheduled. If called from inside actor code, the new actor will share the thread+queue with the caller.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    actorClazz -
    
    Returns:
  - AsActor
```
public static <T extends Actor> T AsActor(Class<? extends Actor> actorClazz,
                                          int qSize)
```
    create an new actor. If this is called outside an actor, a new DispatcherThread will be scheduled. If called from inside actor code, the new actor will share the thread+queue with the caller.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    actorClazz -
    
    Returns:
  - AsActor
```
public static <T extends Actor> T AsActor(Class<? extends Actor> actorClazz,
                                          Scheduler scheduler)
```
    create an new actor dispatched in the given DispatcherThread
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    actorClazz -
    
    Returns:
  - AsActor
```
public static <T extends Actor> T AsActor(Class<? extends Actor> actorClazz,
                                          Scheduler scheduler,
                                          int qsize)
```
    create an new actor dispatched in the given DispatcherThread
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    actorClazz -
    
    Returns:
  - yield
```
public static Future<Future[]> yield(Future... futures)
```
  - yield
```
public static Future<List<Future>> yield(List<Future> futures)
```
  - async
```
public static Future<Future[]> async(Callable<Future>... toexec)
```
    mimics scala's async macro. callables are executed in order. if a callable returns a promise, execution of the next callable is deferred until the promise is fulfilled. The future resulting from the last callable is returned. Helps keeping future chains readable. (see https://gist.github.com/RuedigerMoeller/10c583819616f2563969 for an example)
    
    Parameters:
    
    toexec -
    
    Returns:
  - getFactory
```
public ActorProxyFactory getFactory()
```
  - sync
```
public <T> T sync(Future<T> fut)
```
    block until future returns. Warning: this can be called only from non-actor code as it blocks the calling thread. If called from inside an actor, an exception is thrown. Sometimes this is required/handy when setting up stuff or interoperating with non-actorish old-school multithreading code. if the future returns an error, an exception is thrown.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    fut -
    
    Returns:
  - makeProxy
```
protected Actor makeProxy(Class<? extends Actor> clz,
                          DispatcherThread disp,
                          int qs)
```
  - createQueue
```
protected Queue createQueue(int qSize)
```
  - newProxy
```
protected Actor newProxy(Class<? extends Actor> clz,
                         Scheduler sched,
                         int qsize)
```
  - toResults
```
public static Object[] toResults(Future[] futs)
```

Class Actors

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

instance

factory

Constructor Detail

Actors

Method Detail

AddDeadLetter

InThread

DeadLetters

AsActor

AsActor

AsActor

AsActor

yield

yield

async

getFactory

sync

makeProxy

createQueue

newProxy

toResults