Welcome to riaps-pycom documentation!
This documents the APIs for RIAPS application management (riaps_ctrl and riaps_deplo), Python component framework (riaps_actor and riaps_device), node management tool (riaps_fab using fabric), code generation tool (riaps_gen) and an alternate discovery service (redis-based).
riaps package
Subpackages
riaps.consts package
Submodules
Module contents
riaps.ctrl package
Submodules
Module contents
riaps.deplo package
Submodules
riaps.deplo.appdb module
Application database Created on Apr 2, 2018
@author: riaps
- class riaps.deplo.appdb.AppDbase[source]
Bases:
objectApplication database. The database is a collection of key -> value pairs, where values are pickled Python objects (i.e. bytearrays). Structure: RIAPSAPPS -> [ appNames* ] appName -> [ actorRecords* ]
- RIAPSAPPS = 'RIAPSAPPS'
- RIAPSDISCO = 'RIAPSDISCO'
- RIAPSDISCOCMD = 'RIAPSDISCOCMD'
riaps.deplo.cpumon module
Resource monitors
Created on Nov 23, 2017
@author: riaps
- class riaps.deplo.cpumon.CPUMonitorThread(parent, interval, usage)[source]
Bases:
ThreadThread for monitoring an actor and enforcing resource limits.
- run()[source]
Method representing the thread’s activity.
You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.
riaps.deplo.deplo module
riaps.deplo.depm module
riaps.deplo.fm module
riaps.deplo.main module
riaps.deplo.memmon module
Resource monitors
Created on Nov 23, 2017
@author: riaps
- class riaps.deplo.memmon.MemMonitorThread(parent, efd, usage)[source]
Bases:
Thread- run()[source]
Method representing the thread’s activity.
You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.
riaps.deplo.netmon module
Resource monitors
Created on Nov 23, 2017
@author: riaps
- class riaps.deplo.netmon.NHAction[source]
Bases:
object- MAP = {1: 'SET', 2: 'REMOVE'}
- REMOVE = 2
- SET = 1
- class riaps.deplo.netmon.NHLoopStatus[source]
Bases:
objectReturn codes from nethogsmonitor_loop()
- FAILURE = 1
- MAP = {0: 'OK', 1: 'FAILURE', 2: 'NO_DEVICE'}
- NO_DEVICE = 2
- OK = 0
- class riaps.deplo.netmon.NHMonitorRecord[source]
Bases:
Structurectypes version of the struct of the same name from libnethogs.h
- device_name
Structure/Union member
- name
Structure/Union member
- pid
Structure/Union member
- record_id
Structure/Union member
- recv_bytes
Structure/Union member
- recv_kbs
Structure/Union member
- sent_bytes
Structure/Union member
- sent_kbs
Structure/Union member
- uid
Structure/Union member
- class riaps.deplo.netmon.NetMonitorThread(parent)[source]
Bases:
Thread- dev_args(devnames)[source]
Return the appropriate ctypes arguments for a device name list, to pass to libnethogs
nethogsmonitor_loop_devices. The return value is a 2-tuple of devc (ctypes.c_int) and devicenames (ctypes.POINTER) to an array ofctypes.c_char).
- run()[source]
Method representing the thread’s activity.
You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.
riaps.deplo.procm module
Created on Apr 7, 2018
@author: riaps
- class riaps.deplo.procm.ProcessManager(parent)[source]
Bases:
objectManages processes: service(s) and actors started by deplo
- class riaps.deplo.procm.ProcessMonitor(parent, qualName)[source]
Bases:
ThreadThread for monitoring a process
- run()[source]
Method representing the thread’s activity.
You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.
riaps.deplo.resm module
Resource manager
Created on Nov 23, 2017
@author: riaps
- class riaps.deplo.resm.ActorResourceManager(parent, actorName, actorDef)[source]
Bases:
objectResource manager for an actor
- class riaps.deplo.resm.AppResourceManager(parent, appName, appFolder, userName)[source]
Bases:
objectResource manager for an app
riaps.deplo.spcmon module
Resource monitors
Created on Nov 23, 2017
@author: riaps
- class riaps.deplo.spcmon.SpcMonitorThread(parent)[source]
Bases:
Thread- run()[source]
Method representing the thread’s activity.
You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.
Module contents
riaps.discd package
Submodules
riaps.discd.dbase module
Discovery server database interface Created on Oct 19, 2016
@author: riaps
- class riaps.discd.dbase.DiscoDbase(context_, dbaseLoc)[source]
Bases:
objectDiscovery service database base class
- fetch(key: str, client: str) [<class 'str'>][source]
Fetch value(s) under key. Add client to list of clients interested in the value
- fetchUpdates() [<class 'str'>][source]
Check and fetch the updated values of the subscribed keys if any
riaps.discd.dbase_dht module
riaps.discd.dbase_redis module
Discovery server database interface Created on Oct 19, 2016
@author: riaps
- class riaps.discd.dbase_redis.RedisDbase(context_, dbaseLoc)[source]
Bases:
DiscoDbaseDiscovery service database implemented using redis
- fetch(key: str, client: str) [<class 'str'>][source]
Fetch value(s) under key. Add client to list of clients interested in the value
riaps.discd.discs module
riaps.discd.main module
Module contents
riaps.fabfile package
Submodules
Module contents
riaps.gen package
Subpackages
riaps.gen.target package
Subpackages
riaps.gen.target.capnp package
Submodules
riaps.gen.target.capnp.capnpfilters module
riaps.gen.target.capnp.capnpgen module
- class riaps.gen.target.capnp.capnpgen.CapnpGenerator(cppmodel, output_dir)[source]
Bases:
JinjaGenerator- create_environment(**kwargs)[source]
Return a new Jinja environment.
Derived classes may override method to pass additional parameters or to change the template loader type.
- tasks = [<riaps.gen.target.capnp.capnpgen.CapnpTask object>]
- templates_path = '/home/docs/checkouts/readthedocs.org/user_builds/riaps-pycom/checkouts/latest/src/riaps/gen/target/capnp/tpl'
riaps.gen.target.capnp.sync_capnp module
Module contents
riaps.gen.target.cpp package
Submodules
riaps.gen.target.cpp.ccfilters module
riaps.gen.target.cpp.cppgen module
- class riaps.gen.target.cpp.cppgen.CmakeTask(formatter=None, **kwargs)[source]
Bases:
JinjaTask- relative_path_for_element(element)[source]
Returns relative file path receiving the generator output for given element.
- template_name = 'cmake.tpl'
- class riaps.gen.target.cpp.cppgen.CompCppBaseTask(part)[source]
Bases:
JinjaTask- relative_path_for_element(element)[source]
Returns relative file path receiving the generator output for given element.
- template_name = 'comp.base.cc.tpl'
- class riaps.gen.target.cpp.cppgen.CompCppTask(part)[source]
Bases:
JinjaTask- relative_path_for_element(element)[source]
Returns relative file path receiving the generator output for given element.
- template_name = 'comp.cc.tpl'
- class riaps.gen.target.cpp.cppgen.CompGenerator(environment=None, **kwargs)[source]
Bases:
JinjaGenerator- create_environment(**kwargs)[source]
Return a new Jinja environment.
Derived classes may override method to pass additional parameters or to change the template loader type.
- tasks = [<riaps.gen.target.cpp.cppgen.CompHppBaseTask object>, <riaps.gen.target.cpp.cppgen.CompCppBaseTask object>, <riaps.gen.target.cpp.cppgen.CompHppTask object>, <riaps.gen.target.cpp.cppgen.CompCppTask object>, <riaps.gen.target.cpp.cppgen.CompHppBaseTask object>, <riaps.gen.target.cpp.cppgen.CompCppBaseTask object>, <riaps.gen.target.cpp.cppgen.CompHppTask object>, <riaps.gen.target.cpp.cppgen.CompCppTask object>, <riaps.gen.target.cpp.cppgen.CmakeTask object>]
- templates_path = '/home/docs/checkouts/readthedocs.org/user_builds/riaps-pycom/checkouts/latest/src/riaps/gen/target/cpp/tpl'
- class riaps.gen.target.cpp.cppgen.CompHppBaseTask(part)[source]
Bases:
JinjaTask- relative_path_for_element(element)[source]
Returns relative file path receiving the generator output for given element.
- template_name = 'comp.base.h.tpl'
riaps.gen.target.cpp.sync_cpp module
Module contents
riaps.gen.target.python package
Submodules
riaps.gen.target.python.pygen module
riaps.gen.target.python.sync_python module
Module contents
Module contents
Submodules
Module contents
riaps.lang package
Submodules
riaps.lang.depl module
Deployment language processor Created on Nov 7, 2016
@author: riaps
riaps.lang.depll module
Top-level script to start the deployment language processor (‘depl’) Created on Oct 15, 2016
- Arguments:
model : Name of deployment model file to be processed
@author: riaps
riaps.lang.gviz module
Created on Mar 17, 2018
@author: riaps
- riaps.lang.gviz.findMsgNode(msgType, actorLocals, actorLocalMessageNodes, actorInternals, actorInternalMessageNodes, msgMap, msgMapUsed, localMsgGraph, internalMsgGraph)[source]
- riaps.lang.gviz.findMsgNodePair(msgType, actorLocals, actorLocalMessageNodes, actorInternals, actorInternalMessageNodes, msgMap, localMsgGraph, internalMsgGraph, globalMsgGraph)[source]
riaps.lang.lang module
DSL for RIAPS software models Created on Oct 9, 2016 Uses the textX parser @author: riaps
Module contents
riaps.logger package
Subpackages
Submodules
Module contents
riaps.proto package
Module contents
riaps.run package
Submodules
riaps.run.actor module
riaps.run.ansPort module
Created on Oct 10, 2016
@author: riaps
- class riaps.run.ansPort.AnsPort(parentComponent, portName, portSpec)[source]
Bases:
DuplexBindPortclassdocs
- getInfo()[source]
Retrieve configuration information about the port. Abstract, subclasses must implement this method.
- Returns:
a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.
- Return type:
- getSocket()[source]
Return the socket(s) used by the port object. Abstract, subclasses must implement this method.
- Returns:
a low-level socket
- Return type:
zmq.Socket
- inSocket()[source]
Return True if the socket can be used for input. Abstract, subclasses must implement this method.
- Returns:
logical value indicating whether the socket is for input.
- Type:
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
- setup()[source]
Initialize the port object (after construction but before socket creation). Abstract, subclasses must implement this method.
- setupSocket(owner)[source]
Setup the socket. Abstract, subclasses must implement this method.
- Parameters:
owner (Component) – The Component the port belongs to. This operation must be called from the component thread only.
- update(host, port)[source]
Update the socket with information from the discovery service. Abstract, subclasses must implement this method.
Called when the discovery service notifies the actor about a new service provide (e.g. server, publisher, etc.) the port needs to connect to. The operation will perform the connection.
riaps.run.cltPort module
Client port class Created on Oct 10, 2016
@author: riaps
- class riaps.run.cltPort.CltPort(parentComponent, portName, portSpec)[source]
Bases:
DuplexConnPortClient port is to access a server. Has a request and a response message type, and uses a REQ socket.
- inSocket()[source]
Return False because the socket is not used as direct input (client has to recv explicitly)
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
riaps.run.comp module
Component class Created on Oct 15, 2016
@author: riaps
- class riaps.run.comp.Component[source]
Bases:
objectBase class for RIAPS application components
- GROUP_PRIORITY_MAX = 0
- GROUP_PRIORITY_MIN = 256
- getLocalID()[source]
Return a locally unique ID (int) of the component. The ID is unique within the actor.
- handleActionVoteRequest(group, rfvId, when)[source]
Default handler for request to vote an action in the future (in member) Implementation must recv/recv_pyobj to obtain the action topic.
- handleGroupMessage(_group)[source]
Default handler for group messages. Implementation must immediately call recv/recv_pyobj on the group to obtain message.
- handleMessageFromLeader(group)[source]
Default handler for messages received from the leader (in member) Member implementation must immediately call recv/recv_pyobj on the group to obtain message.
- handleMessageToLeader(group)[source]
Default handler for messages sent to the leader (in leader) Leader implementation must immediately call recv/recv_pyobj on the group to obtain message.
- class riaps.run.comp.ComponentThread(parent)[source]
Bases:
ThreadComponent execution thread. Runs the component’s code, and communicates with the parent actor.
- batchScheduler(sockets)[source]
Batch scheduler for the component message processing.
The dictionary containing the active sockets is scanned and the associated handler is invoked.
- executeHandlerFor(socket)[source]
Execute the handler for the socket
The handler is always allowed to run to completion, the operation is never preempted.
- priorityScheduler(sockets)[source]
priority scheduler for the component message processing.
The priority order is determined by the order of component ports. The dictionary of active sockets is scanned, and the they are inserted into a priority queue (according to their priority value). The queue is processed (in order of priority). After each invocation, the inputs are polled (in a no-wait operation) and the priority queue is updated.
- rrScheduler(sockets)[source]
Round-robin scheduler for the component message processing.
The round-robin order is determined by the order of component ports. The dictionary of active sockets is scanned, and the associated handlers are invoked in round-robin order. After each invocation, the inputs are polled (in a no-wait operation) and the round-robin queue is updated.
- run()[source]
Method representing the thread’s activity.
You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.
riaps.run.dc module
Distributed coordination
Python implementation of group formation, communications, leader election, consensus and action coordination.
Created on Feb 23, 2019 Author: riaps
- class riaps.run.dc.Coordinator(parent)[source]
Bases:
objectCoordinator object. Each component has a coordinator object that creates the group objects for a component. A group instance can be created only once in a component, subsequent creations return the same group object
- class riaps.run.dc.Group(parent, thread, groupType, groupInstance, componentId, groupSpec, groupMinSize)[source]
Bases:
objectGroup object, represents one group instance that belongs to a component. Acts as the front-end for the GroupThread, channels messages to/from. Some of its methods are run in the GroupThread
- GROUP_ACK = b'ack'
- GROUP_ANN = b'ann'
- GROUP_ERR = b'err'
- GROUP_LEL = b'lel'
- GROUP_LEX = b'lex'
- GROUP_MFL = b'mfl'
- GROUP_MJD = b'mjd'
- GROUP_MLT = b'mlt'
- GROUP_MSG = b'msg'
- GROUP_MTL = b'mtl'
- GROUP_NLD = b'nld'
- GROUP_PARAMETERS = {'consensusTimeout': 1500, 'electionMax': 2000, 'electionMin': 1500, 'heartbeat': 1000, 'peerTimeout': 3000}
- GROUP_RCM = b'rcm'
- GROUP_RFV = b'rfv'
- GROUP_RTC = b'rtc'
- GROUP_UPD = b'upd'
- groupSocketName(groupType, groupName, componentId)[source]
Forms the unique name for the inproc socket.
- handleMessage(msgFrames=None)[source]
Receives message from the worker thread and handles it Runs in component thread (called from component polling loop, or from send_port)
- recv()[source]
Receive a bytes object message from the worker thread Runs in component thread, called from a component
- recv_msg(is_pyobj)[source]
Receive a message from the worker thread. Message are coming through a message queue. Runs in component thread, called from a component
- recv_pyobj()[source]
Receive a Python object message from the worker thread Runs in component thread, called from a component
- requestVote(topic, kind='majority', timeout=None)[source]
Request a vote on a topic (with timeout). Topic is a bytes. A message is sent to the leader (if any) that starts a voting process. Returns None if there is no leader, otherwise a generated id string for the request.
- requestVote_pyobj(topic, kind='majority', timeout=None)[source]
Request a vote on a topic (with timeout). Topic is a Python object. A message is sent to the leader (if any) that starts a voting process. Returns None if there is no leader, otherwise a generated id string for the request.
- send(msg)[source]
Sends a bytes object as a message to all members of the group Runs in component thread
- sendToLeader(msg)[source]
Send message to group leader from a member Raise an exception if the group is not coordinated Return False (indicating operation failure) if no leader Runs in component thread.
- sendToLeader_pyobj(msg)[source]
Send PyObject message to group leader from a member Raise an exception if the group is not coordinated Return False (indicating operation failure) if no leader Runs in component thread.
- sendToMember(msg, identity=None)[source]
Send message to group member (with identity) from the leader If identity is not supplied, last value of identity is used. Raise an exception if the group is not coordinated Return False (indicating operation failure) if no leader Runs in component thread.
- sendToMember_pyobj(msg, identity=None)[source]
Send PyObject message to group member (with identity) from the leader If identity is not supplied, last value of identity is used. Raise an exception if the group is not coordinated Return False (indicating operation failure) if no leader Runs in component thread.
- sendVote(rfvId, vote)[source]
Send a vote (True/False) to the leader on a requested topic identified by the id of the request for vote.
- send_port(msgType, msg, has_identity=False)[source]
Send a message to the worker thread. Used by all messages - the messages have multiple frames Runs in component thread
- class riaps.run.dc.GroupThread(group)[source]
Bases:
ThreadWorker thread for DC behavior
- AUTHORITY = b'ldr'
- CANDIDATE = 2
- FOLLOWER = 1
- HEARTBEAT = b'tic'
- LEADER = 3
- NO_LEADER = 0
- REQVOTE = b'req'
- RSPVOTE = b'vot'
- handleNetMessage(now=None)[source]
Handle (broadcast) messages coming from the group. Messages could be data messages (to be handed over to the component), peer heartbeat messages, or election-related messages
- heartbeat(now)[source]
Send out a group heartbeat (so that group members can maintain an accurate membership list)
riaps.run.dcPorts module
Distributed coordination - Communication ports for the groups.
Created on Feb 23, 2019 Author: riaps
- class riaps.run.dcPorts.GroupAnsPort(parentPart, portName, groupSpec)[source]
Bases:
BindPort,GroupDuplexPortGroup answer port is for the leader to receive messages from members. Based on a DEALER socket. Group-internal communication port for messaging with the leader, no message type, but can be timed.
- getInfo()[source]
Retrieve configuration information about the port. Abstract, subclasses must implement this method.
- Returns:
a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.
- Return type:
- getSocket()[source]
Return the socket(s) used by the port object. Abstract, subclasses must implement this method.
- Returns:
a low-level socket
- Return type:
zmq.Socket
- inSocket()[source]
Return True if the socket can be used for input. Abstract, subclasses must implement this method.
- Returns:
logical value indicating whether the socket is for input.
- Type:
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(_msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
- setup()[source]
Initialize the port object (after construction but before socket creation). Abstract, subclasses must implement this method.
- setupSocket(owner)[source]
Setup the socket. Abstract, subclasses must implement this method.
- Parameters:
owner (Component) – The Component the port belongs to. This operation must be called from the component thread only.
- update()[source]
Update the socket with information from the discovery service. Abstract, subclasses must implement this method.
Called when the discovery service notifies the actor about a new service provide (e.g. server, publisher, etc.) the port needs to connect to. The operation will perform the connection.
- class riaps.run.dcPorts.GroupPubPort(parentPart, portName, groupSpec)[source]
Bases:
BindPort,GroupSimplexPortGroup Publisher port is for publishing application and housekeeping messages for all group members.
- getInfo()[source]
Retrieve configuration information about the port. Abstract, subclasses must implement this method.
- Returns:
a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.
- Return type:
- getSocket()[source]
Return the socket(s) used by the port object. Abstract, subclasses must implement this method.
- Returns:
a low-level socket
- Return type:
zmq.Socket
- inSocket()[source]
Return True if the socket can be used for input. Abstract, subclasses must implement this method.
- Returns:
logical value indicating whether the socket is for input.
- Type:
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
- setup()[source]
Initialize the port object (after construction but before socket creation). Abstract, subclasses must implement this method.
- setupSocket(owner)[source]
Setup the socket. Abstract, subclasses must implement this method.
- Parameters:
owner (Component) – The Component the port belongs to. This operation must be called from the component thread only.
- update(host, port)[source]
Update the socket with information from the discovery service. Abstract, subclasses must implement this method.
Called when the discovery service notifies the actor about a new service provide (e.g. server, publisher, etc.) the port needs to connect to. The operation will perform the connection.
- class riaps.run.dcPorts.GroupQryPort(parentPart, portName, groupSpec)[source]
Bases:
ConnPort,GroupDuplexPortGroup query port is for accessing the leader from members. Based on a DEALER socket. Group-internal communication port for messaging with the leader, no message type, but can be timed.
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(_msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
- class riaps.run.dcPorts.GroupSubPort(parentPart, portName, groupSpec)[source]
Bases:
ConnPort,GroupSimplexPortGroup subscriber port is for receiving application and housekeeping messages from all group members.
- getInfo()[source]
Retrieve configuration information about the port. Abstract, subclasses must implement this method.
- Returns:
a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.
- Return type:
- getSocket()[source]
Return the socket(s) used by the port object. Abstract, subclasses must implement this method.
- Returns:
a low-level socket
- Return type:
zmq.Socket
- inSocket()[source]
Return True if the socket can be used for input. Abstract, subclasses must implement this method.
- Returns:
logical value indicating whether the socket is for input.
- Type:
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(_msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
riaps.run.deplc module
Deployment manager client Created on Jan 3, 2017
@author: riaps
riaps.run.device module
riaps.run.disco module
Created on Oct 19, 2016
@author: riaps
riaps.run.dmain module
riaps.run.exc module
Created on Oct 10, 2016
@author: riaps
- exception riaps.run.exc.BuildError(message)[source]
Bases:
RIAPSError
- exception riaps.run.exc.ControlError(message)[source]
Bases:
RIAPSError
- exception riaps.run.exc.DatabaseError(message)[source]
Bases:
RIAPSError
- exception riaps.run.exc.OperationError(message)[source]
Bases:
RIAPSError
- exception riaps.run.exc.PortError(message, errno)[source]
Bases:
RIAPSError- EAGAIN = 11
- EFAULT = 14
- EPROTO = 156384763
- EROUTE = 113
- ETERM = 156384765
- exception riaps.run.exc.SetupError(message)[source]
Bases:
RIAPSError
- exception riaps.run.exc.StateError(message)[source]
Bases:
RIAPSError
riaps.run.fsm module
Created on Apr 23, 2020
@author: riaps
riaps.run.insPort module
Created on Jan 9, 2017
@author: riaps
- class riaps.run.insPort.InsPort(parentPart, portName, portSpec)[source]
Bases:
Portclassdocs
- getInfo()[source]
Retrieve configuration information about the port. Abstract, subclasses must implement this method.
- Returns:
a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.
- Return type:
- getSocket()[source]
Return the socket(s) used by the port object. Abstract, subclasses must implement this method.
- Returns:
a low-level socket
- Return type:
zmq.Socket
- inSocket()[source]
Return True if the socket can be used for input. Abstract, subclasses must implement this method.
- Returns:
logical value indicating whether the socket is for input.
- Type:
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
- setup()[source]
Initialize the port object (after construction but before socket creation). Abstract, subclasses must implement this method.
riaps.run.main module
riaps.run.part module
Part class Created on Oct 9, 2016
@author: run
- class riaps.run.part.Part(parentActor, iTypeDef, iName, iTypeName, iArgs)[source]
Bases:
objectPart class to encapsulate and manage component (and its thread)
- class State(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
Enum- Active = 3
- Checkpointing = 4
- Destroyed = 7
- Inactive = 5
- Initial = 1
- Passive = 6
- Ready = 2
- Starting = 0
- handlePortUpdate(portName, host, port)[source]
Handle a port update message coming from the discovery service
- property mods
riaps.run.peripheral module
Peripheral class - encapsulates a device, used in an app actor Created on Jan 6, 2017
@author: riaps
- class riaps.run.peripheral.Peripheral(parentActor, iTypeDef, iName, iTypeName, iArgs)[source]
Bases:
objectPeripheral class to encapsulate access to a device component Note: implements a public interface compatible with a part
- class State(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
Enum- Active = 3
- Checkpointing = 4
- Destroyed = 7
- Inactive = 5
- Initial = 1
- Passive = 6
- Ready = 2
- Starting = 0
- handlePortUpdate(_portName, _host, _port)[source]
Handle an update message coming from the devm service
- property mods
riaps.run.port module
Base class for all Port objects
- class riaps.run.port.DuplexBindPort(parentComponent, portName, portSpec)[source]
Bases:
BindPort,DuplexPort
- class riaps.run.port.DuplexConnPort(parentComponent, portName, portSpec)[source]
Bases:
ConnPort,DuplexPort
- class riaps.run.port.Port(parentPart, portName, portSpec=None)[source]
Bases:
objectBase class for all Port objects.
Port objects are used by a component to communicate with other components, in the same process, on the same host, or on the same network. Ports encapsulate low-level communication objects (zeromq sockets).
- Parameters:
- getDeadline()[source]
Return the deadline parameter associated with the port’s operation
- Returns:
Deadline for the operation associated with the port, in seconds.
- Return type:
- getGlobalIface()[source]
Return the IP address of the global network interface
The operation retrieves the result from the parent actor and caches it.
- Returns:
Global IP address of the form xxx.xxx.xxx.xxx
- Return type:
- getIndex()[source]
Return the index of the port.
For input ports the index is a small integer indicating its position in the port list of the component, for non-input ports it is None. The index is used to determine the priority order for the port among all the ports, the concrete value is irrelevant.
- Returns:
Index value for the port among all input ports.
- Return type:
- getInfo()[source]
Retrieve configuration information about the port. Abstract, subclasses must implement this method.
- Returns:
a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.
- Return type:
- getLocalIface()[source]
Return the IP address of the local network interface (typically 127.0.0.1)
The operation retrieves the result from the parent actor and caches it.
- Returns:
Local IP address of the form xxx.xxx.xxx.xxx
- Return type:
- getSocket()[source]
Return the socket(s) used by the port object. Abstract, subclasses must implement this method.
- Returns:
a low-level socket
- Return type:
zmq.Socket
- get_recvTime()[source]
Return the timestamp taken at the last receive operation.
- Returns:
time of the last message receive operation
- Return type:
- get_recv_timeout()[source]
Retrieve the receive timeout parameter for the port.
Receive timeout determines how long a receive operation will block before throwing a PortError.EAGAIN exception. None means infinite timeout.
- Returns:
None (if no timeout is set) or the timeout value in seconds.
- Return type:
None or float
- get_sendTime()[source]
Return the timestamp of the sending time of the last message receive.
- Returns:
time when the last message received was sent
- Return type:
- get_send_timeout()[source]
Retrieve the send timeout parameter for the port.
Send timeout determines how long a send operation will block before throwing a PortError.EAGAIN exception. None means infinite timeout.
- Returns:
None (if no timeout is set) or the timeout value in seconds.
- Return type:
None or float
- inSocket()[source]
Return True if the socket can be used for input. Abstract, subclasses must implement this method.
- Returns:
logical value indicating whether the socket is for input.
- Type:
- port_recv(is_pyobj)[source]
Lowest level message receiving operation. Subclasses can override this operation.
The message is received as a multi-part message.If the receiving port is timed, the current timestamp is saved as the time of message reception. If the message is to be received as a Python object, it is unpickled, otherwise the message is returned as is (as a bytes). If the message included a timestamp, it is retrieved and saved as the time of message sending.
- Parameters:
is_pyobj (bool) – flag to indicate if the expected message is a Python data object.
- Returns:
the message received
- Except:
Throws a
PortErrorexception when the underlying network operation fails.
- port_send(msg, is_pyobj)[source]
Lowest level message sending operation. Subclasses can override this operation.
If the message is to be sent as a Python object, it is pickled; otherwise it is assumed to be a bytes. The message is packed into a frame, and, if the port is ‘timed’ a current timestamp is appended as another frame. The message is sent as a multi-part message.
- Parameters:
msg (either a bytes or any Python data object) – message to be sent
is_pyobj (bool) – flag to indicate if the message is a Python object.
- Returns:
True
- Except:
Throws a
PortErrorexception when the underlying network operation fails.
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
- setOwner(owner)[source]
Save owner thread into a data member.
- Parameters:
owner (ComponentThread) – The ComponentThread the port is handled in.
- set_recv_timeout(rto)[source]
Set the receive timeout for the port.
Receive timeout determines how long a receive operation will block before throwing a PortError.EAGAIN exception. None means infinite timeout.
- Parameters:
rto (None or float) – None (if no timeout is set) or the timeout value in seconds.
- set_send_timeout(sto)[source]
Set the send timeout for the port.
Send timeout determines how long a send operation will block before throwing a PortError.EAGAIN exception. None means infinite timeout.
- Parameters:
sto (None or float) – None (if no timeout is set) or the timeout value in seconds.
- setup()[source]
Initialize the port object (after construction but before socket creation). Abstract, subclasses must implement this method.
- setupSocket(owner)[source]
Setup the socket. Abstract, subclasses must implement this method.
- Parameters:
owner (Component) – The Component the port belongs to. This operation must be called from the component thread only.
- update(host, port)[source]
Update the socket with information from the discovery service. Abstract, subclasses must implement this method.
Called when the discovery service notifies the actor about a new service provide (e.g. server, publisher, etc.) the port needs to connect to. The operation will perform the connection.
- class riaps.run.port.PortInfo(portKind, portScope, portName, msgType, portHost, portNum)
Bases:
tuple- msgType
Alias for field number 3
- portHost
Alias for field number 4
- portKind
Alias for field number 0
- portName
Alias for field number 2
- portNum
Alias for field number 5
- portScope
Alias for field number 1
- class riaps.run.port.PortScope(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
IntEnum- GLOBAL = 1
- INTERNAL = 3
- LOCAL = 2
- class riaps.run.port.SimplexBindPort(parentComponent, portName, portSpec)[source]
Bases:
BindPort,SimplexPort
- class riaps.run.port.SimplexConnPort(parentComponent, portName, portSpec)[source]
Bases:
ConnPort,SimplexPort
riaps.run.pubPort module
Created on Oct 10, 2016
@author: riaps
- class riaps.run.pubPort.PubPort(parentComponent, portName, portSpec)[source]
Bases:
SimplexBindPortPublisher port
- getInfo()[source]
Retrieve configuration information about the port. Abstract, subclasses must implement this method.
- Returns:
a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.
- Return type:
- getSocket()[source]
Return the socket(s) used by the port object. Abstract, subclasses must implement this method.
- Returns:
a low-level socket
- Return type:
zmq.Socket
- inSocket()[source]
Return True if the socket can be used for input. Abstract, subclasses must implement this method.
- Returns:
logical value indicating whether the socket is for input.
- Type:
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
- setup()[source]
Initialize the port object (after construction but before socket creation). Abstract, subclasses must implement this method.
- setupSocket(owner)[source]
Setup the socket. Abstract, subclasses must implement this method.
- Parameters:
owner (Component) – The Component the port belongs to. This operation must be called from the component thread only.
- update(host, port)[source]
Update the socket with information from the discovery service. Abstract, subclasses must implement this method.
Called when the discovery service notifies the actor about a new service provide (e.g. server, publisher, etc.) the port needs to connect to. The operation will perform the connection.
riaps.run.qryPort module
Query port class Created on Oct 10, 2016
@author: riaps
- class riaps.run.qryPort.QryPort(parentComponent, portName, portSpec)[source]
Bases:
DuplexConnPortQuery port is to access a server. Has a request and a response message type, and uses a DEALER socket.
riaps.run.repPort module
Created on Oct 10, 2016
@author: riaps
- class riaps.run.repPort.RepPort(parentComponent, portName, portSpec)[source]
Bases:
DuplexBindPortSimilar to a server port.
- getInfo()[source]
Retrieve configuration information about the port. Abstract, subclasses must implement this method.
- Returns:
a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.
- Return type:
- getSocket()[source]
Return the socket(s) used by the port object. Abstract, subclasses must implement this method.
- Returns:
a low-level socket
- Return type:
zmq.Socket
- inSocket()[source]
Return True if the socket can be used for input. Abstract, subclasses must implement this method.
- Returns:
logical value indicating whether the socket is for input.
- Type:
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
- setup()[source]
Initialize the port object (after construction but before socket creation). Abstract, subclasses must implement this method.
- setupSocket(owner)[source]
Setup the socket. Abstract, subclasses must implement this method.
- Parameters:
owner (Component) – The Component the port belongs to. This operation must be called from the component thread only.
- update(host, port)[source]
Update the socket with information from the discovery service. Abstract, subclasses must implement this method.
Called when the discovery service notifies the actor about a new service provide (e.g. server, publisher, etc.) the port needs to connect to. The operation will perform the connection.
riaps.run.reqPort module
Created on Oct 10, 2016
@author: riaps
- class riaps.run.reqPort.ReqPort(parentComponent, portName, portSpec)[source]
Bases:
DuplexConnPortSimilar to a client port
- getInfo()[source]
Retrieve configuration information about the port. Abstract, subclasses must implement this method.
- Returns:
a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.
- Return type:
- getSocket()[source]
Return the socket(s) used by the port object. Abstract, subclasses must implement this method.
- Returns:
a low-level socket
- Return type:
zmq.Socket
- inSocket()[source]
Return True if the socket can be used for input. Abstract, subclasses must implement this method.
- Returns:
logical value indicating whether the socket is for input.
- Type:
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
riaps.run.srvPort module
Created on Oct 10, 2016
@author: riaps
- class riaps.run.srvPort.SrvPort(parentComponent, portName, portSpec)[source]
Bases:
DuplexBindPortclassdocs
- getInfo()[source]
Retrieve configuration information about the port. Abstract, subclasses must implement this method.
- Returns:
a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.
- Return type:
- getSocket()[source]
Return the socket(s) used by the port object. Abstract, subclasses must implement this method.
- Returns:
a low-level socket
- Return type:
zmq.Socket
- inSocket()[source]
Return True if the socket can be used for input. Abstract, subclasses must implement this method.
- Returns:
logical value indicating whether the socket is for input.
- Type:
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
- setup()[source]
Initialize the port object (after construction but before socket creation). Abstract, subclasses must implement this method.
- setupSocket(owner)[source]
Setup the socket. Abstract, subclasses must implement this method.
- Parameters:
owner (Component) – The Component the port belongs to. This operation must be called from the component thread only.
- update(host, port)[source]
Update the socket with information from the discovery service. Abstract, subclasses must implement this method.
Called when the discovery service notifies the actor about a new service provide (e.g. server, publisher, etc.) the port needs to connect to. The operation will perform the connection.
riaps.run.subPort module
Created on Oct 10, 2016
@author: riaps
- class riaps.run.subPort.SubPort(parentComponent, portName, portSpec)[source]
Bases:
SimplexConnPortSubscriber port
- getInfo()[source]
Retrieve configuration information about the port. Abstract, subclasses must implement this method.
- Returns:
a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.
- Return type:
- getSocket()[source]
Return the socket(s) used by the port object. Abstract, subclasses must implement this method.
- Returns:
a low-level socket
- Return type:
zmq.Socket
- inSocket()[source]
Return True if the socket can be used for input. Abstract, subclasses must implement this method.
- Returns:
logical value indicating whether the socket is for input.
- Type:
- recv()[source]
Receive a byte array (if possible) through the port
Used for receiving a message that is subsequently deserialized.
- Returns:
a message packed into a bytes.
- Return type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send(_msg)[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
riaps.run.timPort module
Created on Oct 10, 2016
@author: riaps
- class riaps.run.timPort.TimPort(parentPart, portName, portSpec)[source]
Bases:
PortTimer port
- getInfo()[source]
Retrieve configuration information about the port. Abstract, subclasses must implement this method.
- Returns:
a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.
- Return type:
- getSocket()[source]
Return the socket(s) used by the port object. Abstract, subclasses must implement this method.
- Returns:
a low-level socket
- Return type:
zmq.Socket
- inSocket()[source]
Return True if the socket can be used for input. Abstract, subclasses must implement this method.
- Returns:
logical value indicating whether the socket is for input.
- Type:
- recv_pyobj()[source]
Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.
The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the
send_pyobjmethod.- Returns:
a Python data object
- Type:
any Python data type
- reset()[source]
Reset the port object. Subclasses can override this method.
Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.
- send()[source]
Send a byte array (if possible) out through the port.
Used for sending a message that has been serialized into bytes previously.
- Parameters:
msg – the message packed into a bytes
- Return type:
- send_pyobj(msg)[source]
Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.
The object is serialized using pickle and sent. Messages sent using this method are received using the
recv_pyobjmethod.- Parameters:
msg (any Python data type) – the message to be sent.
- setPeriod(_period)[source]
Set the period - will be changed after the next firing. Period must be positive
- setup()[source]
Initialize the port object (after construction but before socket creation). Abstract, subclasses must implement this method.
- class riaps.run.timPort.TimerThread(parent)[source]
Bases:
Thread- class Command(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
Enum- ACTIVATE = 2
- CANCEL = 5
- DEACTIVATE = 3
- HALT = 6
- START = 4
- TERMINATE = 1
- run()[source]
Method representing the thread’s activity.
You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.
Module contents
riaps.utils package
Submodules
riaps.utils.appdesc module
Application descriptor (used as a yaml object)
Created on Oct 29, 2018
@author: riaps
- class riaps.utils.appdesc.AppDescriptor(url, host, mac, sha, home, hosts, network)[source]
Bases:
YAMLObjectRIAPS app origin - ‘signature file url = URL of the repo (or local folder) the app is coming from host = host IP addares mac = MAC address of host sha = SHA of package home = local source folder (used in remote debugging) hosts = hosts participating in the app network = network access control for nodes, (ip|’[]’) => [] | [ (‘dns’ | ip) ]+
- yaml_loader
alias of
SafeLoader
riaps.utils.config module
Created on Nov 23, 2016
@author: riaps
- class riaps.utils.config.Config[source]
Bases:
objectConfiguration database for RIAPS tools Including logging configuration
- ACTOR_DEBUG_SERVER = ''
- APP_LOGS = ''
- CTRL_DEBUG_SERVER = ''
- CTRL_HEARTBEAT = True
- DEPLO_DEBUG_SERVER = ''
- DEVICE_DEBUG_SERVER = ''
- DISCO_DEBUG_SERVER = ''
- DISCO_TYPE = 'redis'
- NETMON = True
- NIC_CEIL = '131kbps'
- NIC_NAME = None
- NIC_RATE = '118kbps'
- NODE_HEARTBEAT = True
- RECV_HWM = 100
- RECV_TIMEOUT = -1
- SECURITY = True
- SEND_HWM = 100
- SEND_TIMEOUT = -1
- TARGET_USER = 'riaps'
riaps.utils.ctrlhost module
riaps.utils.gencert module
Script to generate a public/private key pair and a self-signed certificate for securing riaps communications. THE KEY ANND CERTIFICATE MUST NEVER BE USED IN FIELDED SYSTEMS. Keys and the certificate must be installed in the $RIAPSHOME/keys directory. Private key is NOT ENCRYPTED.
@author: riaps
riaps.utils.ifaces module
Various network interface utility functions Created on Nov 4, 2016
@author: riaps
- riaps.utils.ifaces.getNetworkInterfaces(nicName=None)[source]
Determine the IP address of the network interfaces Return a tuple of list of global IP addresses, list of MAC addresses, and local IP address If the requested interface is found the list will contain the information for that interface only.
riaps.utils.names module
name operations Created on Jan 19, 2018
@author: riaps
riaps.utils.singleton module
Created on Jul 23, 2018
@author: riaps
riaps.utils.spdlog_setup module
Created on Jan 3, 2019
@author: riaps
riaps.utils.sudo module
sudo operations Created on Jan 19, 2018
@author: riaps
riaps.utils.ticker module
Created on Jun 21, 2022
@author: riaps
- class riaps.utils.ticker.Ticker(period, callback)[source]
Bases:
ThreadSimple periodic ticker
- run()[source]
Method representing the thread’s activity.
You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.
riaps.utils.trace module
Created on Dec 16, 2017
@author: riaps
- riaps.utils.trace.riaps_trace(debug=None, prog=None)[source]
Setup trace mode and wait for the debug server.
- @debug: Debug server control string of the form ‘hostname:portname’,
both of which are optional, ‘:’ defaulting to localhost:5678
@prog: Label for the program, looked up in the riaps configuration file.
First, it attempts to connect to the debug server using the debug argument (if present). Second, it tries to connect to the debug server using the information from the configuration file. If the config file argument is empty, it silently returns. Returns: True of False depending on whether the program is running in trace mode.
Module contents
Submodules
riaps.riaps_actor module
riaps.riaps_ctrl module
riaps.riaps_depll module
Top-level script of the deployment language processor
- Example:
riaps_depll model [-v | --verbose] [-g|--generate]- Arguments:
model: name of model file to be processed-v|--verbose: print the resulting JSON file on the console-g: generate a JSON file
riaps.riaps_deplo module
riaps.riaps_device module
riaps.riaps_disco module
riaps.riaps_fab module
Top level script to start fabric file for handling multiple RIAPS nodes setup
Created on March 6, 2019
- Arguments:
fabcmd: fabric command desired
optional arguments: -
-H | --hosts hostnames: list of hostnames (comma separated) --R | --roles rolenames: list of roles (comma separated) --f hostfilename: absolute path to local host file --i ssh private key: relative or absolute path to specific private key
If specific hostnames are not given, the command will be called for all hosts listed in /usr/local/riaps/etc/riaps_hosts.conf
@author: riaps
riaps.riaps_gen module
Top-level script to start the language processor (‘lang’) for app models Created on Nov 15, 2018
- Arguments:
-m, –model : Full path of the model.json. -o, –output : Output directory. Default is the directory of the model file. -cpp, –cpp : List of components to be generated in C++. -py, –python : List of components to be generated in Python. -s, –ser : Message serializer (‘capnp’ or ‘pickle’). -w, –overwrite : Overwrite existing code (no sync).
@author: riaps
riaps.riaps_gviz module
Top-level script to start the graphic visualization processor (‘gviz’)
Example:
riaps_gviz model deplo [-v|--verbose]
The script generates a .dot file shown the allocation of components and actors to target nodes based on the model and deployment files.
- Arguments:
-
model: name of application model file to be processed -deplo: name of deployment model file to be processed --v|--verbose: prints the JSON produced from the deployment model- Output:
appname.dot: graphviz-style dot file for the name application (based on the model)
riaps.riaps_lang module
Top-level script to start the language processor (‘lang’) for app models
- Example:
riaps_lang model [-v|--verbose]
The program analyzes the model file and generates a JSON file.
- Arguments:
model: Name of model file to be processed-v|--verbose: print the resulting JSON file on the console