Actors (kontraktor 3.16 API)

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

Direct Known Subclasses:

Actor
```
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 A set of static async helper methods. Note Actor inherits from this class.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONT` use value as error to indicate more messages are to come (else remoting will close channel).
`static boolean`	`DEFAULT_BOUNDED_QUEUE` use bounded queues if true. bounded queues block caller when they are full, unfortunately this completely changes behaviour and characteristics of an actorsystem and leads to hard to predict behaviour under high workload.
`static int`	`DEFAULT_TIMOUT`
`static Supplier<Scheduler>`	`defaultScheduler`
`static Timer`	`delayedCalls`
`static ThreadPoolExecutor`	`exec`
`static ActorsImpl`	`instance`
`static int`	`MAX_EXTERNAL_THREADS_POOL_SIZE`

Constructor Summary

Constructors
Constructor and Description

Actors()

Constructors
Constructor and Description
`Actors()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`AddDeadLetter(String s)`
`static <T> IPromise<IPromise<T>[]>`	`all(int count, Function<Integer,IPromise<T>> loop)`
`static <T> IPromise<IPromise<T>[]>`	`all(IPromise<T>... futures)` similar to es6 Promise.all method, however non-IPromise objects are not allowed returns a future which is settled once all promises provided are settled
`static <T> IPromise<List<IPromise<T>>>`	`all(List<IPromise<T>> futures)` similar to es6 Promise.all method, however non-IPromise objects are not allowed returns a future which is settled once all promises provided are settled
`static <T extends Actor> T`	`AsActor(Class<T> actorClazz)` create an new actor.
`static <T extends Actor> T`	`AsActor(Class<T> actorClazz, int qSize)` create an new actor.
`static <T extends Actor> T`	`AsActor(Class<T> actorClazz, Scheduler scheduler)` create an new actor dispatched in the given DispatcherThread
`static <T extends Actor> T`	`AsActor(Class<T> actorClazz, Scheduler scheduler, int qsize)` create an new actor dispatched in the given DispatcherThread
`static <T> Stream<T>`	`awaitAll(IPromise<T>... futures)` await until all futures are settled and stream their results.
`static <T> Stream<T>`	`awaitAll(List<IPromise<T>> futures)`
`static <T> Stream<T>`	`awaitAll(long timeoutMS, IPromise<T>... futures)` await until all futures are settled and stream their results
`static <T> Stream<T>`	`awaitAll(long timeoutMS, List<IPromise<T>> futures)`
`static IPromise`	`complete()` abbreviation for Promise creation to make code more concise
`static <T> IPromise<T>`	`complete(T res, Object err)` abbreviation for Promise creation to make code more concise
`static Queue<String>`	`DeadLetters()` messages that have been dropped or have been sent to stopped actors
`static <T> T`	`InThread(T anInterface)` in case called from an actor, wraps the given interface instance into a proxy such that all calls on the interface get scheduled on the calling actors thread (avoids accidental multithreading when handing out callback/listener interfaces from an actor) if called from outside an actor thread, NOP
`static boolean`	`isComplete(Object error)`
`static boolean`	`isCont(Object o)` helper to check for "special" error object "CONT". cont signals further callback results might be sent (important for remoting as channels need to get cleaned up)
`static boolean`	`isError(Object err)` helper to check for "special" error objects.
`static boolean`	`isErrorOrComplete(Object error)` return if given error Object signals an error or a 'complete' signal
`static boolean`	`isResult(Object error)`
`static boolean`	`isTimeout(Object error)`
`static <T> IPromise<T>`	`race(Collection<IPromise<T>> futures)` similar to es6 Promise.race method, however non-IPromise objects are not allowed returns a future which is settled once one of the futures provided gets settled
`static <T> IPromise<T>`	`race(IPromise<T>... futures)` similar to es6 Promise.race method, however non-IPromise objects are not allowed returns a future which is settled once one of the futures provided gets settled
`static <T> IPromise<T>`	`reject(Object err)` abbreviation for Promise creation to make code more concise
`static IPromise`	`resolve()` abbreviation for Promise creation to make code more concise
`static <T> IPromise<T>`	`resolve(T res)` abbreviation for Promise creation to make code more concise
`static <T> Stream<T>`	`stream(T... t)` utility addition to java 8 streams
`static void`	`SubmitDelayed(long millis, Runnable task)` utility function.
`static void`	`yield()` processes messages from mailbox / callbackqueue until no messages are left NOP if called from non actor thread.
`static void`	`yield(long timeout)` process messages on the mailbox/callback queue until timeout is reached.
`static void`	`yieldCallbacks(long timeout)` only process callbacks until timeout or cbQ is empty.

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

- Field Detail
  - MAX_EXTERNAL_THREADS_POOL_SIZE
```
public static int MAX_EXTERNAL_THREADS_POOL_SIZE
```
  - DEFAULT_TIMOUT
```
public static int DEFAULT_TIMOUT
```
  - exec
```
public static ThreadPoolExecutor exec
```
  - DEFAULT_BOUNDED_QUEUE
```
public static boolean DEFAULT_BOUNDED_QUEUE
```
    use bounded queues if true. bounded queues block caller when they are full, unfortunately this completely changes behaviour and characteristics of an actorsystem and leads to hard to predict behaviour under high workload. Default is to use Unbounded queues. Warning: calling queue size related methods is quite expensive then (except isEmpty()).
  - instance
```
public static ActorsImpl instance
```
  - delayedCalls
```
public static Timer delayedCalls
```
  - defaultScheduler
```
public static Supplier<Scheduler> defaultScheduler
```
  - CONT
```
public static final String CONT
```
    use value as error to indicate more messages are to come (else remoting will close channel).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Actors
```
public Actors()
```
- Method Detail
  - isErrorOrComplete
```
public static boolean isErrorOrComplete(Object error)
```
    return if given error Object signals an error or a 'complete' signal
    
    Parameters:
    
    error -
    
    Returns:
  - isTimeout
```
public static boolean isTimeout(Object error)
```
  - isComplete
```
public static boolean isComplete(Object error)
```
  - isCont
```
public static boolean isCont(Object o)
```
    helper to check for "special" error object "CONT". cont signals further callback results might be sent (important for remoting as channels need to get cleaned up)
    
    Parameters:
    
    o -
    
    Returns:
  - isResult
```
public static boolean isResult(Object error)
```
  - isError
```
public static boolean isError(Object err)
```
    helper to check for "special" error objects.
    
    Parameters:
    
    err -
    
    Returns:
  - SubmitDelayed
```
public static void SubmitDelayed(long millis,
                                 Runnable task)
```
    utility function. Executed in foreign thread. Use Actor::delayed() to have the runnable executed inside actor thread
  - 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 all calls on the interface get scheduled on the calling actors thread (avoids accidental multithreading when handing out callback/listener interfaces from an actor) if called from outside an actor thread, NOP
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    anInterface -
    
    Returns:
  - DeadLetters
```
public static Queue<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<T> 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<T> 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<T> 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<T> actorClazz,
                                          Scheduler scheduler,
                                          int qsize)
```
    create an new actor dispatched in the given DispatcherThread
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    actorClazz -
    
    Returns:
  - all
```
public static <T> IPromise<IPromise<T>[]> all(int count,
                                              Function<Integer,IPromise<T>> loop)
```
  - all
```
public static <T> IPromise<IPromise<T>[]> all(IPromise<T>... futures)
```
    similar to es6 Promise.all method, however non-IPromise objects are not allowed returns a future which is settled once all promises provided are settled
  - all
```
public static <T> IPromise<List<IPromise<T>>> all(List<IPromise<T>> futures)
```
    similar to es6 Promise.all method, however non-IPromise objects are not allowed returns a future which is settled once all promises provided are settled
  - awaitAll
```
public static <T> Stream<T> awaitAll(long timeoutMS,
                                     IPromise<T>... futures)
```
    await until all futures are settled and stream their results
  - awaitAll
```
public static <T> Stream<T> awaitAll(IPromise<T>... futures)
```
    await until all futures are settled and stream their results. Uses Actors.DEFAULT_TIMEOUT
  - awaitAll
```
public static <T> Stream<T> awaitAll(List<IPromise<T>> futures)
```
  - awaitAll
```
public static <T> Stream<T> awaitAll(long timeoutMS,
                                     List<IPromise<T>> futures)
```
  - race
```
public static <T> IPromise<T> race(IPromise<T>... futures)
```
    similar to es6 Promise.race method, however non-IPromise objects are not allowed returns a future which is settled once one of the futures provided gets settled
  - race
```
public static <T> IPromise<T> race(Collection<IPromise<T>> futures)
```
    similar to es6 Promise.race method, however non-IPromise objects are not allowed returns a future which is settled once one of the futures provided gets settled
  - stream
```
public static <T> Stream<T> stream(T... t)
```
    utility addition to java 8 streams
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    t -
    
    Returns:
  - resolve
```
public static <T> IPromise<T> resolve(T res)
```
    abbreviation for Promise creation to make code more concise
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    res -
    
    Returns:
  - reject
```
public static <T> IPromise<T> reject(Object err)
```
    abbreviation for Promise creation to make code more concise
  - complete
```
public static <T> IPromise<T> complete(T res,
                                       Object err)
```
    abbreviation for Promise creation to make code more concise
  - complete
```
public static IPromise complete()
```
    abbreviation for Promise creation to make code more concise
  - resolve
```
public static IPromise resolve()
```
    abbreviation for Promise creation to make code more concise
  - yield
```
public static void yield()
```
    processes messages from mailbox / callbackqueue until no messages are left NOP if called from non actor thread.
  - yield
```
public static void yield(long timeout)
```
    process messages on the mailbox/callback queue until timeout is reached. In case timeout is 0, process until mailbox+callback queue is empty. If called from a non-actor thread, either sleep until timeout or (if timeout == 0) its a NOP.
    
    Parameters:
    
    timeout -
  - yieldCallbacks
```
public static void yieldCallbacks(long timeout)
```
    only process callbacks until timeout or cbQ is empty. Messages are not polled and processed. Useful in order to stall a producer, but preserve message processing order.
    
    Parameters:
    
    timeout -

Class Actors

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_EXTERNAL_THREADS_POOL_SIZE

DEFAULT_TIMOUT

exec

DEFAULT_BOUNDED_QUEUE

instance

delayedCalls

defaultScheduler

CONT

Constructor Detail

Actors

Method Detail

isErrorOrComplete

isTimeout

isComplete

isCont

isResult

isError

SubmitDelayed

AddDeadLetter

InThread

DeadLetters

AsActor

AsActor

AsActor

AsActor

all

all

all

awaitAll

awaitAll

awaitAll

awaitAll

race

race

stream

resolve

reject

complete

complete

resolve

yield

yield

yieldCallbacks