rixaplugin.data_structures package

Submodules

rixaplugin.data_structures.enums module

class rixaplugin.data_structures.enums.AutoNumber(value)

Bases: IntFlag

An enumeration.

class rixaplugin.data_structures.enums.CallstackType(value)

Bases: AutoNumber

An enumeration.

ASYNCIO = 8
LOCAL = 2
NETWORK = 4
PROCESS = 32
THREAD = 16
WITHOUT_PLUGIN = 0
class rixaplugin.data_structures.enums.FunctionPointerType(value)

Bases: AutoNumber

An enumeration.

ASYNC = 128
CLIENT = 32
INDIRECT = 8
LOCAL = 2
LOCAL_ONLY = 256
NONE = 0
REMOTE = 4
SERVER = 16
SYNC = 64
class rixaplugin.data_structures.enums.HeaderFlags(value)

Bases: AutoNumber

An enumeration.

ACKNOWLEDGE = 2
API_CALL = 1024
CLIENT = 8
EXCEPTION_RETURN = 64
FUNCTION_CALL = 16
FUNCTION_NOT_FOUND = 512
FUNCTION_RETURN = 32
LOG = 256
NONE = 0
SERVER = 4
TIME_ESTIMATE_AND_ACKNOWLEDGEMENT = 128
UPDATE_REMOTE_PLUGINS = 2048
class rixaplugin.data_structures.enums.PluginModeFlags(value)

Bases: Flag

An enumeration.

CLIENT = 32
IPC_SOCKET = 8
JUPYTER = 128
LOCAL = 1
NETWORK = 16
PROCESS = 4
SERVER = 64
THREAD = 2
class rixaplugin.data_structures.enums.Scope(value)

Bases: AutoNumber

An enumeration.

LOCAL = 2
SERVER = 4
USER = 1

rixaplugin.data_structures.rixa_exceptions module

exception rixaplugin.data_structures.rixa_exceptions.FunctionNotFoundException(message='Function not found')

Bases: Exception

exception rixaplugin.data_structures.rixa_exceptions.NoEffectException(message='Valid statement but no effect')

Bases: Exception

exception rixaplugin.data_structures.rixa_exceptions.PluginNotFoundException(plugin_name, message='Plugin not found')

Bases: Exception

exception rixaplugin.data_structures.rixa_exceptions.QueueOverflowException(message='Queue overflow')

Bases: Exception

exception rixaplugin.data_structures.rixa_exceptions.RemoteException(type, message, traceback)

Bases: Exception

exception rixaplugin.data_structures.rixa_exceptions.RemoteOfflineException(message='Remote is currently marked as offline', plugin_name=None)

Bases: RemoteUnavailableException

Exception for the remote being marked as offline/is_alive being false.

Usually this happens when a previous call

exception rixaplugin.data_structures.rixa_exceptions.RemoteTimeoutException(message='Remote time out', plugin_name=None)

Bases: RemoteUnavailableException

exception rixaplugin.data_structures.rixa_exceptions.RemoteUnavailableException(message='Remote unavailable', plugin_name=None)

Bases: Exception

Base exception for the remote being unavailable for various reasons

exception rixaplugin.data_structures.rixa_exceptions.SignatureMismatchException(message='Signature mismatch')

Bases: Exception

rixaplugin.data_structures.variables module

class rixaplugin.data_structures.variables.PluginVariable(name: str, var_type=<class 'str'>, default=None, readable=Scope.LOCAL, writable=Scope.LOCAL)

Bases: object

get()
set(value)

Module contents