improv.actor

Module Contents

Classes

AbstractActor	Base class for an actor that Nexus
ManagedActor	Base class for an actor that Nexus
AsyncActor	Base class for an actor that Nexus
RunManager
AsyncRunManager	Asynchronous run manager. Communicates with nexus core using q_sig and q_comm.
Signal	Class containing definition of signals Nexus uses

Attributes

logger
Actor

improv.actor.logger

class improv.actor.AbstractActor(name, store_loc, method='fork')

Base class for an actor that Nexus controls and interacts with. Needs to have a store and links for communication Also needs to be responsive to sent Signals (e.g. run, setup, etc)

setStoreInterface(client)

Sets the client interface to the store

Parameters:

client (improv.store.StoreInterface) – Set client interface to the store

setLinks(links)

General full dict set for links

Parameters:

links (dict) – The dict to store all the links

setCommLinks(q_comm, q_sig)

Set explicit communication links to/from Nexus (q_comm, q_sig)

Parameters:

• q_comm (improv.nexus.Link) – for messages from this actor to Nexus

• q_sig (improv.nexus.Link) – signals from Nexus and must be checked first

setLinkIn(q_in)

Set the dedicated input queue

Parameters:

q_in (improv.nexus.Link) – for input signals to this actor

setLinkOut(q_out)

Set the dedicated output queue

Parameters:

q_out (improv.nexus.Link) – for output signals from this actor

setLinkWatch(q_watch)

Set the dedicated watchout queue

Parameters:

q_watch (improv.nexus.Link) – watchout queue

addLink(name, link)

Function provided to add additional data links by name using same form as q_in or q_out Must be done during registration and not during run

Parameters:

• name (string) – customized link name

• link (improv.nexus.Link) – customized data link

getLinks()

Returns dictionary of links for the current actor

Returns:

dictionary of links

Return type:

dict

put(idnames, q_out=None, save=None)

TODO: This is deprecated? Prefer using Links explicitly

setup()

Essenitally the registration process Can also be an initialization for the actor options is a list of options, can be empty

abstract run()

Must run in continuous mode Also must check q_sig either at top of a run-loop or as async with the primary function

Suggested implementation for synchronous running: see RunManager class below

stop()

Specify method for momentarily stopping the run and saving data. Not used by default

changePriority()

Try to lower this process’ priority Only changes priority if lower_priority is set TODO: Only works on unix machines. Add Windows functionality

class improv.actor.ManagedActor(*args, **kwargs)

Bases: AbstractActor

Base class for an actor that Nexus controls and interacts with. Needs to have a store and links for communication Also needs to be responsive to sent Signals (e.g. run, setup, etc)

run()

Must run in continuous mode Also must check q_sig either at top of a run-loop or as async with the primary function

Suggested implementation for synchronous running: see RunManager class below

abstract runStep()

class improv.actor.AsyncActor(*args, **kwargs)

Bases: AbstractActor

Base class for an actor that Nexus controls and interacts with. Needs to have a store and links for communication Also needs to be responsive to sent Signals (e.g. run, setup, etc)

run()

Run the actor in an async loop

async setup()

Essenitally the registration process Can also be an initialization for the actor options is a list of options, can be empty

abstract async runStep()

async stop()

improv.actor.Actor

class improv.actor.RunManager(name, actions, links, runStoreInterface=None, timeout=1e-06)

class improv.actor.AsyncRunManager(name, actions, links, runStore=None, timeout=1e-06)

Asynchronous run manager. Communicates with nexus core using q_sig and q_comm. To be used with [async with] Afterwards, the run manager listens for signals without blocking.

async run_actor()

class improv.actor.Signal

Class containing definition of signals Nexus uses to communicate with its actors TODO: doc each of these with expected handling behavior

static run()

static quit()

static pause()

static resume()

static reset()

static load()

static setup()

static ready()

static kill()

static revive()

static stop()

static stop_success()