dragon.infrastructure.messages

Dragon infrastructure messages are the internal API used for service communication.

Functions

`camel_case_msg_name`(msg_id)
`mk_all_message_classes_set`()
`parse`(serialized[, restrict])
`type_filter`(the_msg_types)

Classes

`AbnormalTermination`	Refer to definition and Common Fields for a description of the message structure.
`BEHaltOverlay`	Refer to definition and Common Fields for a description of the message structure.
`BEHalted`	Refer to definition and Common Fields for a description of the message structure.
`BEIsUp`	Refer to definition and Common Fields for a description of the message structure.
`BENodeIdxSH`	Refer to definition and Common Fields for a description of the message structure.
`BEPingSH`	Refer to definition and Common Fields for a description of the message structure.
`Breakpoint`
`CapNProtoMsg`	Common base for all capnproto messages.
`CapNProtoResponseMsg`	Common base for all capnproto response messages.
`DDClear`
`DDClearResponse`
`DDConnectToManager`
`DDConnectToManagerResponse`
`DDContains`
`DDContainsResponse`
`DDCreate`
`DDCreateResponse`
`DDDeregisterClient`
`DDDeregisterClientResponse`
`DDDestroy`
`DDDestroyManager`
`DDDestroyManagerResponse`
`DDDestroyResponse`
`DDGet`
`DDGetIterator`
`DDGetIteratorResponse`
`DDGetLength`
`DDGetLengthResponse`
`DDGetRandomManager`
`DDGetRandomManagerResponse`
`DDGetResponse`
`DDIteratorNext`
`DDIteratorNextResponse`
`DDKeys`
`DDKeysResponse`
`DDManagerGetNewestChkptID`
`DDManagerGetNewestChkptIDResponse`
`DDManagerStats`
`DDManagerStatsResponse`
`DDPop`
`DDPopResponse`
`DDPut`
`DDPutResponse`
`DDRegisterClient`
`DDRegisterClientID`
`DDRegisterClientIDResponse`
`DDRegisterClientResponse`
`DDRegisterManager`
`DDRegisterManagerResponse`
`ExceptionlessAbort`	Refer to definition and Common Fields for a description of the message structure.
`FENodeIdxBE`	Refer to definition and Common Fields for a description of the message structure.
`FileDescriptor`	An enumeration.
`GSChannelCreate`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelCreateResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelDestroy`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelDestroyResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelDetach`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelDetachResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelGetRecvH`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelGetRecvHResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelGetSendH`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelGetSendHResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelJoin`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelJoinResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelList`	Refer to definition and to Common Fields for a description of the message structure.
`GSChannelListResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelQuery`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelQueryResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSChannelRelease`	Refer to definition and Common Fields for a description of the message structure.
`GSDumpState`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupAddTo`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupAddToResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupCreate`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupCreateAddTo`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupCreateAddToResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupCreateResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupDestroy`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupDestroyRemoveFrom`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupDestroyRemoveFromResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupDestroyResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupKill`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupKillResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupList`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupListResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupQuery`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupQueryResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupRebootRuntime`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupRebootRuntimeResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupRemoveFrom`	Refer to definition and Common Fields for a description of the message structure.
`GSGroupRemoveFromResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSHalted`	Refer to definition and Common Fields for a description of the message structure.
`GSHeadExit`	Refer to definition and Common Fields for a description of the message structure.
`GSIsUp`	Refer to definition and Common Fields for a description of the message structure.
`GSNodeList`	type enum
`GSNodeListResponse`	type enum
`GSNodeQuery`	Refer to definition and Common Fields for a description of the message structure.
`GSNodeQueryAll`	Refer to definition and Common Fields for a description of the message structure.
`GSNodeQueryAllResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSNodeQueryResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSNodeQueryTotalCPUCount`	type enum
`GSNodeQueryTotalCPUCountResponse`	type enum
`GSPingProc`	Refer to definition and Common Fields for a description of the message structure.
`GSPingSH`	Refer to definition and Common Fields for a description of the message structure.
`GSPoolCreate`	Refer to definition and Common Fields for a description of the message structure.
`GSPoolCreateResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSPoolDestroy`	Refer to definition and Common Fields for a description of the message structure.
`GSPoolDestroyResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSPoolList`	Refer to definition and Common Fields for a description of the message structure.
`GSPoolListResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSPoolQuery`	Refer to definition and Common Fields for a description of the message structure.
`GSPoolQueryResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSProcessCreate`	Refer to definition and Common Fields for a description of the message structure.
`GSProcessCreateResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSProcessJoin`	Refer to definition and Common Fields for a description of the message structure.
`GSProcessJoinList`	Refer to definition and Common Fields for a description of the message structure.
`GSProcessJoinListResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSProcessJoinResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSProcessKill`	Refer to definition and Common Fields for a description of the message structure.
`GSProcessKillResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSProcessList`	Refer to definition and Common Fields for a description of the message structure.
`GSProcessListResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSProcessQuery`	Refer to definition and Common Fields for a description of the message structure.
`GSProcessQueryResponse`	Refer to definition and Common Fields for a description of the message structure.
`GSStarted`	Refer to definition and Common Fields for a description of the message structure.
`GSTeardown`	Refer to definition and Common Fields for a description of the message structure.
`GSUnexpected`	Refer to definition and Common Fields for a description of the message structure.
`HaltLoggingInfra`	Refer to definition and Common Fields for a description of the message structure.
`HaltOverlay`	Refer to definition and Common Fields for a description of the message structure.
`InfraMsg`	Common base for all messages.
`LABroadcast`	Refer to definition and Common Fields for a description of the message structure.
`LAChannelsInfo`	Refer to definition and Common Fields for a description of the message structure.
`LADumpState`	Refer to definition and Common Fields for a description of the message structure.
`LAExit`	Refer to definition and Common Fields for a description of the message structure.
`LAHaltOverlay`	Refer to definition and Common Fields for a description of the message structure.
`LAPassThruBF`	Refer to definition and Common Fields for a description of the message structure.
`LAPassThruFB`	Refer to definition and Common Fields for a description of the message structure.
`LAProcessDict`	Refer to definition and Common Fields for a description of the message structure.
`LAProcessDictResponse`	Refer to definition and Common Fields for a description of the message structure.
`LAServerMode`	Refer to definition and Common Fields for a description of the message structure.
`LAServerModeExit`	Refer to definition and Common Fields for a description of the message structure.
`LogFlushed`	Refer to definition and Common Fields for a description of the message structure.
`LoggingMsg`	Refer to definition and Common Fields for a description of the message structure.
`LoggingMsgList`	Refer to definition and Common Fields for a description of the message structure.
`MessageTypes`	These are the enumerated values of message type identifiers within the Dragon infrastructure messages.
`OverlayHalted`	Refer to definition and Common Fields for a description of the message structure.
`OverlayPingBE`	Refer to definition and Common Fields for a description of the message structure.
`OverlayPingLA`	Refer to definition and Common Fields for a description of the message structure.
`PGAddProcessTemplates`
`PGClientResponse`	Refer to definition and Common Fields for a description of the message structure.
`PGClose`
`PGJoin`
`PGPuids`
`PGRegisterClient`	Refer to definition and Common Fields for a description of the message structure.
`PGSetProperties`
`PGSignal`
`PGStart`
`PGState`
`PGStop`
`PGStopRestart`
`PGUnregisterClient`	Refer to definition and Common Fields for a description of the message structure.
`PMIGroupInfo`	Required information to enable the launching of pmi based applications.
`PMIProcessInfo`	Required information to enable the launching of pmi based applications.
`RuntimeDesc`	Refer to definition and Common Fields for a description of the message structure.
`SHAllocBlock`	Refer to definition and Common Fields for a description of the message structure.
`SHAllocBlockResponse`	Refer to definition and Common Fields for a description of the message structure.
`SHAllocMsg`	Refer to definition and Common Fields for a description of the message structure.
`SHAllocMsgResponse`	Refer to definition and Common Fields for a description of the message structure.
`SHChannelCreate`	Refer to definition and Common Fields for a description of the message structure.
`SHChannelCreateResponse`	Refer to definition and Common Fields for a description of the message structure.
`SHChannelDestroy`	Refer to definition and Common Fields for a description of the message structure.
`SHChannelDestroyResponse`	Refer to definition and Common Fields for a description of the message structure.
`SHChannelsUp`	Refer to definition and Common Fields for a description of the message structure.
`SHCreateProcessLocalChannel`
`SHCreateProcessLocalChannelResponse`
`SHDumpState`	Refer to definition and Common Fields for a description of the message structure.
`SHExecMemRequest`	Refer to definition and Common Fields for a description of the message structure.
`SHExecMemResponse`	Refer to definition and Common Fields for a description of the message structure.
`SHFwdInput`	Refer to definition and Common Fields for a description of the message structure.
`SHFwdInputErr`	Refer to definition and Common Fields for a description of the message structure.
`SHFwdOutput`	Refer to definition and Common Fields for a description of the message structure.
`SHGetKV`
`SHGetKVL`
`SHGetKVLResponse`
`SHGetKVResponse`
`SHHaltBE`	Refer to definition and Common Fields for a description of the message structure.
`SHHaltTA`	Refer to definition and Common Fields for a description of the message structure.
`SHHalted`	Refer to definition and Common Fields for a description of the message structure.
`SHLockChannel`	Refer to definition and Common Fields for a description of the message structure.
`SHLockChannelResponse`	Refer to definition and Common Fields for a description of the message structure.
`SHMultiProcessCreate`
`SHMultiProcessCreateResponse`
`SHMultiProcessKill`
`SHMultiProcessKillResponse`
`SHPingBE`	Refer to definition and Common Fields for a description of the message structure.
`SHPingGS`	Refer to definition and Common Fields for a description of the message structure.
`SHPoolCreate`	Refer to definition and Common Fields for a description of the message structure.
`SHPoolCreateResponse`	Refer to definition and Common Fields for a description of the message structure.
`SHPoolDestroy`	Refer to definition and to the Common Fields for a description of the message structure.
`SHPoolDestroyResponse`	Refer to definition and Common Fields for a description of the message structure.
`SHPopKVL`
`SHPopKVLResponse`
`SHProcessCreate`	Refer to definition and Common Fields for a description of the message structure.
`SHProcessCreateResponse`	Refer to definition and Common Fields for a description of the message structure.
`SHProcessExit`	Refer to definition and to Common Fields for a description of the message structure.
`SHProcessKill`	Refer to definition and Common Fields for a description of the message structure.
`SHProcessKillResponse`
`SHPushKVL`
`SHPushKVLResponse`
`SHSetKV`
`SHSetKVResponse`
`SHTeardown`	Refer to definition and Common Fields for a description of the message structure.
`TAHalted`	Refer to definition and Common Fields for a description of the message structure.
`TAPingSH`	Refer to definition and Common Fields for a description of the message structure.
`TAUp`	Refer to definition and Common Fields for a description of the message structure.
`TAUpdateNodes`	Refer to definition and Common Fields for a description of the message structure.
`UserHaltOOB`	Refer to definition and Common Fields for a description of the message structure.

Exceptions

AbnormalTerminationError

class MessageTypes

Bases: Enum

These are the enumerated values of message type identifiers within the Dragon infrastructure messages.

DRAGON_MSG = 0: Deliberately invalid

GS_PROCESS_CREATE = 1

GS_PROCESS_CREATE_RESPONSE = 2

GS_PROCESS_LIST = 3

GS_PROCESS_LIST_RESPONSE = 4

GS_PROCESS_QUERY = 5

GS_PROCESS_QUERY_RESPONSE = 6

GS_PROCESS_KILL = 7

GS_PROCESS_KILL_RESPONSE = 8

GS_PROCESS_JOIN = 9

GS_PROCESS_JOIN_RESPONSE = 10

GS_CHANNEL_CREATE = 11

GS_CHANNEL_CREATE_RESPONSE = 12

GS_CHANNEL_LIST = 13

GS_CHANNEL_LIST_RESPONSE = 14

GS_CHANNEL_QUERY = 15

GS_CHANNEL_QUERY_RESPONSE = 16

GS_CHANNEL_DESTROY = 17

GS_CHANNEL_DESTROY_RESPONSE = 18

GS_CHANNEL_JOIN = 19

GS_CHANNEL_JOIN_RESPONSE = 20

GS_CHANNEL_DETACH = 21

GS_CHANNEL_DETACH_RESPONSE = 22

GS_CHANNEL_GET_SENDH = 23

GS_CHANNEL_GET_SENDH_RESPONSE = 24

GS_CHANNEL_GET_RECVH = 25

GS_CHANNEL_GET_RECVH_RESPONSE = 26

ABNORMAL_TERMINATION = 27

GS_STARTED = 28

GS_PING_SH = 29

GS_IS_UP = 30

GS_HEAD_EXIT = 31

GS_CHANNEL_RELEASE = 32

GS_HALTED = 33

SH_PROCESS_CREATE = 34

SH_PROCESS_CREATE_RESPONSE = 35

SH_MULTI_PROCESS_CREATE = 36

SH_MULTI_PROCESS_CREATE_RESPONSE = 37

SH_MULTI_PROCESS_KILL = 38

SH_PROCESS_KILL = 39

SH_PROCESS_EXIT = 40

SH_CHANNEL_CREATE = 41

SH_CHANNEL_CREATE_RESPONSE = 42

SH_CHANNEL_DESTROY = 43

SH_CHANNEL_DESTROY_RESPONSE = 44

SH_LOCK_CHANNEL = 45

SH_LOCK_CHANNEL_RESPONSE = 46

SH_ALLOC_MSG = 47

SH_ALLOC_MSG_RESPONSE = 48

SH_ALLOC_BLOCK = 49

SH_ALLOC_BLOCK_RESPONSE = 50

SH_CHANNELS_UP = 51

SH_PING_GS = 52

SH_HALTED = 53

SH_FWD_INPUT = 54

SH_FWD_INPUT_ERR = 55

SH_FWD_OUTPUT = 56

GS_TEARDOWN = 57

SH_TEARDOWN = 58

SH_PING_BE = 59

BE_PING_SH = 60

TA_PING_SH = 61

SH_HALT_TA = 62

TA_HALTED = 63

SH_HALT_BE = 64

BE_HALTED = 65

TA_UP = 66

GS_PING_PROC = 67

GS_DUMP_STATE = 68

SH_DUMP_STATE = 69

LA_BROADCAST = 70

LA_PASS_THRU_FB = 71

LA_PASS_THRU_BF = 72

GS_POOL_CREATE = 73

GS_POOL_CREATE_RESPONSE = 74

GS_POOL_DESTROY = 75

GS_POOL_DESTROY_RESPONSE = 76

GS_POOL_LIST = 77

GS_POOL_LIST_RESPONSE = 78

GS_POOL_QUERY = 79

GS_POOL_QUERY_RESPONSE = 80

SH_POOL_CREATE = 81

SH_POOL_CREATE_RESPONSE = 82

SH_POOL_DESTROY = 83

SH_POOL_DESTROY_RESPONSE = 84

SH_CREATE_PROCESS_LOCAL_CHANNEL = 85

SH_CREATE_PROCESS_LOCAL_CHANNEL_RESPONSE = 86

SH_PUSH_KVL = 87

SH_PUSH_KVL_RESPONSE = 88

SH_POP_KVL = 89

SH_POP_KVL_RESPONSE = 90

SH_GET_KVL = 91

SH_GET_KVL_RESPONSE = 92

SH_SET_KV = 93

SH_SET_KV_RESPONSE = 94

SH_GET_KV = 95

SH_GET_KV_RESPONSE = 96

SH_EXEC_MEM_REQUEST = 97

SH_EXEC_MEM_RESPONSE = 98

GS_UNEXPECTED = 99

LA_SERVER_MODE = 100

LA_SERVER_MODE_EXIT = 101

LA_PROCESS_DICT = 102

LA_PROCESS_DICT_RESPONSE = 103

LA_DUMP_STATE = 104

BE_NODE_IDX_SH = 105

LA_CHANNELS_INFO = 106

SH_MULTI_PROCESS_KILL_RESPONSE = 107

SH_PROCESS_KILL_RESPONSE = 108

BREAKPOINT = 109

GS_PROCESS_JOIN_LIST = 110

GS_PROCESS_JOIN_LIST_RESPONSE = 111

GS_NODE_QUERY = 112

GS_NODE_QUERY_RESPONSE = 113

GS_NODE_QUERY_ALL = 114

GS_NODE_QUERY_ALL_RESPONSE = 115

LOGGING_MSG = 116

LOGGING_MSG_LIST = 117

LOG_FLUSHED = 118

GS_NODE_LIST = 119

GS_NODE_LIST_RESPONSE = 120

GS_NODE_QUERY_TOTAL_CPU_COUNT = 121

GS_NODE_QUERY_TOTAL_CPU_COUNT_RESPONSE = 122

BE_IS_UP = 123

FE_NODE_IDX_BE = 124

HALT_OVERLAY = 125

HALT_LOGGING_INFRA = 126

OVERLAY_PING_BE = 127

OVERLAY_PING_LA = 128

LA_HALT_OVERLAY = 129

BE_HALT_OVERLAY = 130

OVERLAY_HALTED = 131

EXCEPTIONLESS_ABORT = 132: Communicate abnormal termination without raising exception

LA_EXIT = 133

GS_GROUP_LIST = 134

GS_GROUP_LIST_RESPONSE = 135

GS_GROUP_QUERY = 136

GS_GROUP_QUERY_RESPONSE = 137

GS_GROUP_DESTROY = 138

GS_GROUP_DESTROY_RESPONSE = 139

GS_GROUP_ADD_TO = 140

GS_GROUP_ADD_TO_RESPONSE = 141

GS_GROUP_REMOVE_FROM = 142

GS_GROUP_REMOVE_FROM_RESPONSE = 143

GS_GROUP_CREATE = 144

GS_GROUP_CREATE_RESPONSE = 145

GS_GROUP_KILL = 146

GS_GROUP_KILL_RESPONSE = 147

GS_GROUP_CREATE_ADD_TO = 148

GS_GROUP_CREATE_ADD_TO_RESPONSE = 149

GS_GROUP_DESTROY_REMOVE_FROM = 150

GS_GROUP_DESTROY_REMOVE_FROM_RESPONSE = 151

GS_GROUP_REBOOT_RUNTIME = 152

GS_GROUP_REBOOT_RUNTIME_RESPONSE = 153

TA_UPDATE_NODES = 154

RUNTIME_DESC = 155

USER_HALT_OOB = 156

DD_REGISTER_CLIENT = 157

DD_REGISTER_CLIENT_RESPONSE = 158

DD_DESTROY = 159

DD_DESTROY_RESPONSE = 160

DD_REGISTER_MANAGER = 161

DD_REGISTER_MANAGER_RESPONSE = 162

DD_REGISTER_CLIENT_ID = 163

DD_REGISTER_CLIENT_ID_RESPONSE = 164

DD_DESTROY_MANAGER = 165

DD_DESTROY_MANAGER_RESPONSE = 166

DD_PUT = 167

DD_PUT_RESPONSE = 168

DD_GET = 169

DD_GET_RESPONSE = 170

DD_POP = 171

DD_POP_RESPONSE = 172

DD_CONTAINS = 173

DD_CONTAINS_RESPONSE = 174

DD_GET_LENGTH = 175

DD_GET_LENGTH_RESPONSE = 176

DD_CLEAR = 177

DD_CLEAR_RESPONSE = 178

DD_GET_ITERATOR = 179

DD_GET_ITERATOR_RESPONSE = 180

DD_ITERATOR_NEXT = 181

DD_ITERATOR_NEXT_RESPONSE = 182

DD_KEYS = 183

DD_KEYS_RESPONSE = 184

DD_DEREGISTER_CLIENT = 185

DD_DEREGISTER_CLIENT_RESPONSE = 186

DD_CREATE = 187

DD_CREATE_RESPONSE = 188

DD_CONNECT_TO_MANAGER = 189

DD_CONNECT_TO_MANAGER_RESPONSE = 190

DD_GET_RANDOM_MANAGER = 191

DD_GET_RANDOM_MANAGER_RESPONSE = 192

DD_MANAGER_STATS = 193

DD_MANAGER_STATS_RESPONSE = 194

DD_MANAGER_GET_NEWEST_CHKPT_ID = 195

DD_MANAGER_GET_NEWEST_CHKPT_ID_RESPONSE = 196

PG_REGISTER_CLIENT = 197

PG_UNREGISTER_CLIENT = 198

PG_CLIENT_RESPONSE = 199

PG_SET_PROPERTIES = 200

PG_STOP_RESTART = 201

PG_ADD_PROCESS_TEMPLATES = 202

PG_START = 203

PG_JOIN = 204

PG_SIGNAL = 205

PG_STATE = 206

PG_PUIDS = 207

PG_STOP = 208

PG_CLOSE = 209

class FileDescriptor

Bases: Enum

An enumeration.

stdin = 0

stdout = 1

stderr = 2

exception AbnormalTerminationError

Bases: Exception

__init__(msg='')

class PMIGroupInfo

Bases: object

Required information to enable the launching of pmi based applications.

job_id: int

nnodes: int

nranks: int

nidlist: list[int]

hostlist: list[str]

control_port: int

classmethod fromdict(d)

__init__(job_id: int, nnodes: int, nranks: int, nidlist: list[int], hostlist: list[str], control_port: int) → None

class PMIProcessInfo

Bases: object

Required information to enable the launching of pmi based applications.

lrank: int

ppn: int

nid: int

pid_base: int

classmethod fromdict(d)

__init__(lrank: int, ppn: int, nid: int, pid_base: int) → None

class InfraMsg

Bases: object

Common base for all messages.

This common base type for all messages sets up the default fields and the serialization strategy for now.

class Errors

Bases: Enum

An enumeration.

INVALID = -1

__init__(tag, ref=None, err=None)

get_sdict()

property tc

classmethod tcv()

property tag

property ref

property err

classmethod from_sdict(sdict)

classmethod deserialize(msg)

uncompressed_serialize()

serialize()

class CapNProtoMsg

Bases: object

Common base for all capnproto messages.

This common base type for all messages sets up the default fields and the serialization strategy for messages to be exchanged between C and Python.

Errors: alias of DragonError

__init__(tag)

classmethod from_sdict(sdict)

classmethod deserialize(msg_str)

serialize()

get_sdict()

builder()

property capnp_name

property tc

property tag

class CapNProtoResponseMsg

Bases: CapNProtoMsg

Common base for all capnproto response messages.

This provides some support for code common to all response messages.

__init__(tag, ref, err, errInfo)

get_sdict()

builder()

property ref

property err

property errInfo

class SHCreateProcessLocalChannel

Bases: CapNProtoMsg

__init__(tag, puid, respFLI)

get_sdict()

builder()

property respFLI

property puid

class SHCreateProcessLocalChannelResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='', serChannel='')

get_sdict()

builder()

property serialized_channel

class SHPushKVL

Bases: CapNProtoMsg

__init__(tag, key, value, respFLI)

get_sdict()

builder()

property key

property value

property respFLI

class SHPushKVLResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class SHPopKVL

Bases: CapNProtoMsg

__init__(tag, key, value, respFLI)

get_sdict()

builder()

property key

property value

property respFLI

class SHPopKVLResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class SHGetKVL

Bases: CapNProtoMsg

__init__(tag, key, respFLI)

get_sdict()

builder()

property key

property respFLI

class SHGetKVLResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='', values=[])

get_sdict()

builder()

property values

class SHSetKV

Bases: CapNProtoMsg

__init__(tag, key, value, respFLI)

get_sdict()

builder()

property key

property value

property respFLI

class SHSetKVResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class SHGetKV

Bases: CapNProtoMsg

__init__(tag, key, respFLI)

get_sdict()

builder()

property key

property respFLI

class SHGetKVResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='', value=None)

get_sdict()

builder()

property value

class DDCreate

Bases: CapNProtoMsg

__init__(tag, respFLI, args)

get_sdict()

builder()

property respFLI

property args

class DDCreateResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class DDGetRandomManager

Bases: CapNProtoMsg

__init__(tag, respFLI)

get_sdict()

builder()

property respFLI

class DDGetRandomManagerResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, manager, errInfo='')

get_sdict()

builder()

property manager

class DDRegisterClient

Bases: CapNProtoMsg

__init__(tag, respFLI, bufferedRespFLI)

get_sdict()

builder()

property respFLI

property bufferedRespFLI

class DDRegisterClientResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, clientID, numManagers, managerID, managerNodes, timeout, errInfo='')

get_sdict()

builder()

property clientID

property numManagers

property managerID

property managerNodes

property timeout

class DDConnectToManager

Bases: CapNProtoMsg

__init__(tag, clientID, managerID)

get_sdict()

builder()

property clientID

property managerID

class DDConnectToManagerResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, manager, errInfo='')

get_sdict()

builder()

property manager

class DDDestroy

Bases: CapNProtoMsg

__init__(tag, clientID, respFLI)

get_sdict()

builder()

property respFLI

property clientID

class DDDestroyResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class DDRegisterManager

Bases: CapNProtoMsg

__init__(tag, mainFLI, respFLI, hostID)

get_sdict()

builder()

property mainFLI

property respFLI

property hostID

class DDRegisterManagerResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, managerID, errInfo='', managers=[], managerNodes=[])

get_sdict()

builder()

property managerID

property managers

property managerNodes

class DDRegisterClientID

Bases: CapNProtoMsg

__init__(tag, clientID, respFLI, bufferedRespFLI)

get_sdict()

builder()

property clientID

property respFLI

property bufferedRespFLI

class DDRegisterClientIDResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class DDDestroyManager

Bases: CapNProtoMsg

__init__(tag, respFLI)

get_sdict()

builder()

property respFLI

class DDDestroyManagerResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class DDPut

Bases: CapNProtoMsg

__init__(tag, clientID, chkptID=0, persist=True)

get_sdict()

builder()

property clientID

property chkptID

property persist

class DDPutResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class DDGet

Bases: CapNProtoMsg

__init__(tag, clientID, chkptID=0)

get_sdict()

builder()

property clientID

property chkptID

class DDGetResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class DDPop

Bases: CapNProtoMsg

__init__(tag, clientID, chkptID=0)

get_sdict()

builder()

property clientID

property chkptID

class DDPopResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class DDContains

Bases: CapNProtoMsg

__init__(tag, clientID, chkptID=0)

get_sdict()

builder()

property clientID

property chkptID

class DDContainsResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class DDGetLength

Bases: CapNProtoMsg

__init__(tag, clientID, respFLI, chkptID=0)

get_sdict()

builder()

property clientID

property respFLI

property chkptID

class DDGetLengthResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='', length=0)

get_sdict()

builder()

property length

class DDClear

Bases: CapNProtoMsg

__init__(tag, clientID, chkptID, respFLI)

get_sdict()

builder()

property clientID

property chkptID

property respFLI

class DDClearResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class DDManagerStats

Bases: CapNProtoMsg

__init__(tag, respFLI)

get_sdict()

builder()

property respFLI

class DDManagerStatsResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='', data='')

get_sdict()

builder()

property data

class DDManagerGetNewestChkptID

Bases: CapNProtoMsg

__init__(tag, respFLI)

get_sdict()

builder()

property respFLI

class DDManagerGetNewestChkptIDResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='', managerID=0, chkptID=0)

get_sdict()

builder()

property chkptID

property managerID

class DDGetIterator

Bases: CapNProtoMsg

__init__(tag, clientID, chkptID=0)

get_sdict()

builder()

property clientID

property chkptID

class DDGetIteratorResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='', iterID=0)

get_sdict()

builder()

property iterID

class DDIteratorNext

Bases: CapNProtoMsg

__init__(tag, clientID, iterID)

get_sdict()

builder()

property clientID

property iterID

class DDIteratorNextResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class DDKeys

Bases: CapNProtoMsg

__init__(tag, clientID, chkptID=0)

get_sdict()

builder()

property clientID

property chkptID

class DDKeysResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class DDDeregisterClient

Bases: CapNProtoMsg

__init__(tag, clientID, respFLI)

get_sdict()

builder()

property clientID

property respFLI

class DDDeregisterClientResponse

Bases: CapNProtoResponseMsg

__init__(tag, ref, err, errInfo='')

class GSProcessCreate

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, exe, args, env=None, rundir='', user_name='', options=None, stdin=None, stdout=None, stderr=None, group=None, user=None, umask=-1, pipesize=None, pmi_required=False, _pmi_info=None, layout=None, policy=None, restart=False, resilient=False, head_proc=False, _tc=None)

property options

get_sdict()

class GSProcessCreateResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0: Process was created

FAIL = 1: Process was not created

ALREADY = 2: Process exists already

__init__(tag, ref, err, desc=None, err_info='', _tc=None)

property desc

get_sdict()

class GSProcessList

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, _tc=None)

get_sdict()

class GSProcessListResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0: Always succeeds

__init__(tag, ref, err, plist=None, _tc=None)

get_sdict()

class GSProcessQuery

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, t_p_uid=None, user_name='', _tc=None)

get_sdict()

class GSProcessQueryResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

__init__(tag, ref, err, desc=None, err_info='', _tc=None)

property desc

get_sdict()

class GSProcessKill

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, sig, t_p_uid=None, hide_stderr=False, user_name='', _tc=None)

get_sdict()

class GSProcessKillResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

FAIL_KILL = 2

DEAD = 3

PENDING = 4

__init__(tag, ref, err, exit_code=0, err_info='', _tc=None)

get_sdict()

class GSProcessJoin

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, timeout=-1, t_p_uid=None, user_name='', _tc=None)

get_sdict()

class GSProcessJoinResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

TIMEOUT = 2

SELF = 3

__init__(tag, ref, err, exit_code=0, err_info='', _tc=None)

get_sdict()

class GSProcessJoinList

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, timeout=-1, t_p_uid_list=None, user_name_list=None, join_all=False, return_on_bad_exit=False, _tc=None)

get_sdict()

class GSProcessJoinListResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

TIMEOUT = 2

SELF = 3

PENDING = 4

__init__(tag, ref, puid_status, _tc=None)

get_sdict()

class GSPoolCreate

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, size, user_name='', options=None, _tc=None)

property options

get_sdict()

class GSPoolCreateResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0: Pool was created

FAIL = 1: Pool was not created

ALREADY = 2: Pool exists already

__init__(tag, ref, err, err_code=0, desc=None, err_info='', _tc=None)

property desc

get_sdict()

class GSPoolList

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, _tc=None)

get_sdict()

class GSPoolListResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0: Always succeeds

__init__(tag, ref, err, mlist=None, _tc=None)

get_sdict()

class GSPoolQuery

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, m_uid=None, user_name='', _tc=None)

get_sdict()

class GSPoolQueryResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

__init__(tag, ref, err, desc=None, err_info='', _tc=None)

property desc

get_sdict()

class GSPoolDestroy

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, m_uid=0, user_name='', _tc=None)

get_sdict()

class GSPoolDestroyResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

FAIL = 2

GONE = 3

PENDING = 4

__init__(tag, ref, err, err_code=0, err_info='', _tc=None)

get_sdict()

class GSGroupCreate

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, items=None, policy=None, user_name='', _tc=None)

get_sdict()

class GSGroupCreateResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, ref, desc=None, _tc=None)

property desc

get_sdict()

class GSGroupList

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, _tc=None)

get_sdict()

class GSGroupListResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0: Always succeeds

__init__(tag, ref, err, glist=None, _tc=None)

get_sdict()

class GSGroupQuery

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, g_uid=None, user_name='', _tc=None)

get_sdict()

class GSGroupQueryResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

__init__(tag, ref, err, desc=None, err_info='', _tc=None)

property desc

get_sdict()

class GSGroupKill

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, sig, g_uid=None, user_name='', hide_stderr=False, _tc=None)

get_sdict()

class GSGroupKillResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: IntEnum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

DEAD = 2

PENDING = 3

ALREADY = 4

__init__(tag, ref, err, err_info='', desc=None, _tc=None)

property desc

get_sdict()

class GSGroupDestroy

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, g_uid=None, user_name='', _tc=None)

get_sdict()

class GSGroupDestroyResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: IntEnum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

DEAD = 3

PENDING = 4

__init__(tag, ref, err, err_info='', desc=None, _tc=None)

property desc

get_sdict()

class GSGroupRebootRuntime

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, h_uid, r_c_uid, _tc=None)

get_sdict()

class GSGroupRebootRuntimeResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: IntEnum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

PENDING = 2

__init__(tag, ref, err, err_info='', desc=None, _tc=None)

get_sdict()

class GSGroupAddTo

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, g_uid=None, user_name='', items=None, _tc=None)

get_sdict()

class GSGroupAddToResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

FAIL = 2

DEAD = 3

PENDING = 4

__init__(tag, ref, err, err_info='', desc=None, _tc=None)

property desc

get_sdict()

class GSGroupCreateAddTo

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, g_uid=None, user_name='', items=None, policy=None, _tc=None)

get_sdict()

class GSGroupCreateAddToResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

DEAD = 2

PENDING = 3

__init__(tag, ref, err, err_info='', desc=None, _tc=None)

property desc

get_sdict()

class GSGroupRemoveFrom

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, g_uid=None, user_name='', items=None, _tc=None)

get_sdict()

class GSGroupRemoveFromResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

FAIL = 2

DEAD = 3

PENDING = 4

__init__(tag, ref, err, err_info='', desc=None, _tc=None)

property desc

get_sdict()

class GSGroupDestroyRemoveFrom

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, g_uid=None, user_name='', items=None, _tc=None)

get_sdict()

class GSGroupDestroyRemoveFromResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

FAIL = 2

DEAD = 3

PENDING = 4

__init__(tag, ref, err, err_info='', desc=None, _tc=None)

property desc

get_sdict()

class GSChannelCreate

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, m_uid, options=None, user_name='', _tc=None)

get_sdict()

property options

class GSChannelCreateResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

FAIL = 1

ALREADY = 2

__init__(tag, ref, err, desc=None, err_info='', _tc=None)

property desc

get_sdict()

class GSChannelList

Bases: InfraMsg

Refer to definition and to Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, _tc=None)

get_sdict()

class GSChannelListResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0: Always succeeds

__init__(tag, ref, err, clist=None, _tc=None)

get_sdict()

class GSChannelQuery

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, c_uid=None, user_name='', inc_refcnt=False, _tc=None)

get_sdict()

class GSChannelQueryResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

__init__(tag, ref, err, desc=None, err_info='', _tc=None)

property desc

get_sdict()

class GSChannelDestroy

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, c_uid=None, user_name='', reply_req=True, dec_ref=False, _tc=None)

get_sdict()

class GSChannelDestroyResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

UNKNOWN_CHANNEL = 2

BUSY = 3

__init__(tag, ref, err, err_info='', _tc=None)

get_sdict()

class GSChannelJoin

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, name, timeout=-1, _tc=None)

get_sdict()

class GSChannelJoinResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

TIMEOUT = 1

DEAD = 2

__init__(tag, ref, err, desc=None, _tc=None)

property desc

get_sdict()

class GSChannelDetach

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, c_uid, _tc=None)

get_sdict()

class GSChannelDetachResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

UNKNOWN_CHANNEL = 2

NOT_ATTACHED = 3

__init__(tag, ref, err, _tc=None)

get_sdict()

class GSChannelGetSendH

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, c_uid, _tc=None)

get_sdict()

class GSChannelGetSendHResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

UNKNOWN_CHANNEL = 2

NOT_ATTACHED = 3

CANT = 4

__init__(tag, ref, err, sendh=None, err_info='', _tc=None)

property sendh

get_sdict()

class GSChannelGetRecvH

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, c_uid, _tc=None)

get_sdict()

class GSChannelGetRecvHResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

UNKNOWN_CHANNEL = 2

NOT_ATTACHED = 3

CANT = 4

__init__(tag, ref, err, recvh=None, err_info='', _tc=None)

property recvh

get_sdict()

class GSNodeList

Bases: InfraMsg

type enum: GS_NODE_LIST (= 102)
purpose: Return a list of tuples of h_uid for all nodes currently registered.
fields: None additional
response: GSNodeListResponse
see also: GSNodeQuery
see also: refer to the Common Fields section for additional request message fields

__init__(tag, p_uid, r_c_uid, _tc=None)

get_sdict()

class GSNodeListResponse

Bases: InfraMsg

type enum

GS_NODE_LIST_RESPONSE (= 103)

purpose

Responds with a list of h_uid for all the nodes currently registered.

fields

hlist

list of nonnegative integers

request

GSNodeList

see also

GSNodeQuery

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0: Always succeeds

__init__(tag, ref, err, hlist=None, _tc=None)

get_sdict()

class GSNodeQuery

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid: int, r_c_uid: int, name: str = '', h_uid=None, _tc=None)

get_sdict()

class GSNodeQueryResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

__init__(tag, ref, err, desc=None, err_info='', _tc=None)

property desc

get_sdict()

class GSNodeQueryAll

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid: int, r_c_uid: int, _tc=None)

get_sdict()

class GSNodeQueryAllResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

__init__(tag, ref, err, descriptors: List[dict | NodeDescriptor] | None = None, err_info='', _tc=None)

get_sdict()

class GSNodeQueryTotalCPUCount

Bases: InfraMsg

type enum: GS_NODE_QUERY_TOTAL_CPU_COUNT (= 104)
purpose: Asks GS to return the total number of CPUS beloging to all of the registered nodes.
see also: refer to the Common Fields section for additional request message fields
response: GSNodeQueryTotalCPUCountResponse

__init__(tag, p_uid: int, r_c_uid: int, _tc=None)

get_sdict()

class GSNodeQueryTotalCPUCountResponse

Bases: InfraMsg

type enum

GS_NODE_QUERY_TOTAL_CPU_COUNT_RESPONSE (= 105)

purpose

Return the total number of CPUS beloging to all of the registered nodes.

fields

Alternatives on err:

SUCCESS (= 0)

The machine descriptor was successfully constructed

total_cpus

total number of CPUS beloging to all of the registered nodes.

UNKNOWN ( = 1): An unknown error has occured.

request

GSNodeQueryTotalCPUCount

see also

GSNodeQuery

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

__init__(tag, ref, err, total_cpus=0, err_info='', _tc=None)

property total_cpus

get_sdict()

class AbnormalTermination

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, err_info='', host_id=0, _tc=None)

get_sdict()

class ExceptionlessAbort

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class GSStarted

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class GSPingSH

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class GSIsUp

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class GSPingProc

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, mode=None, argdata=None, _tc=None)

get_sdict()

class GSDumpState

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, filename, _tc=None)

get_sdict()

class GSHeadExit

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, exit_code=0, _tc=None)

get_sdict()

class GSTeardown

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class GSUnexpected

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, ref, _tc=None)

get_sdict()

class GSChannelRelease

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class GSHalted

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class SHProcessCreate

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

The initial_stdin is a string which if non-empty is written along with a terminating newline character to the stdin of the newly created process.

The stdin, stdout, and stderr are all either None or an instance of SHChannelCreate to be processed by the local services component.

__init__(tag, p_uid, r_c_uid, t_p_uid, exe, args, env=None, rundir='', options=None, initial_stdin='', stdin=None, stdout=None, stderr=None, group=None, user=None, umask=-1, pipesize=None, stdin_msg=None, stdout_msg=None, stderr_msg=None, pmi_info=None, layout=None, gs_ret_chan_msg=None, _tc=None)

property options

get_sdict()

class SHProcessCreateResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

FAIL = 1

__init__(tag, ref, err, err_info='', stdin_resp=None, stdout_resp=None, stderr_resp=None, gs_ret_chan_resp=None, _tc=None)

get_sdict()

class SHProcessKill

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, t_p_uid, sig, hide_stderr=False, _tc=None)

get_sdict()

class SHProcessKillResponse

Bases: InfraMsg

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

FAIL = 1

__init__(tag, ref, err, err_info='', _tc=None)

get_sdict()

class SHMultiProcessKill

Bases: InfraMsg

__init__(tag, r_c_uid, procs: List[Dict | SHProcessKill], _tc=None)

get_sdict()

class SHMultiProcessKillResponse

Bases: InfraMsg

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

FAIL = 1

__init__(tag, ref, err, err_info='', exit_code=0, responses: List[Dict | SHProcessKillResponse] | None = None, failed: bool = False, _tc=None)

get_sdict()

class SHProcessExit

Bases: InfraMsg

Refer to definition and to Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

__init__(tag, p_uid, creation_msg_tag=None, exit_code=0, _tc=None)

get_sdict()

class SHMultiProcessCreate

Bases: InfraMsg

__init__(tag, r_c_uid, procs: List[Dict | SHProcessCreate], pmi_group_info: PMIGroupInfo | None = None, _tc=None)

get_sdict()

class SHMultiProcessCreateResponse

Bases: InfraMsg

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

FAIL = 1

__init__(tag, ref, err, err_info='', exit_code=0, responses: List[Dict | SHProcessCreateResponse] | None = None, failed: bool = False, _tc=None)

get_sdict()

class SHPoolCreate

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, size, m_uid, name, attr='', _tc=None)

get_sdict()

class SHPoolCreateResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0: Pool was created

FAIL = 1: Pool was not created

__init__(tag, ref, err, desc=None, err_info='', _tc=None)

get_sdict()

class SHPoolDestroy

Bases: InfraMsg

Refer to definition and to the Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, m_uid, _tc=None)

get_sdict()

class SHPoolDestroyResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

FAIL = 1

__init__(tag, ref, err, err_info='', _tc=None)

get_sdict()

class SHExecMemRequest

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class KINDS

Bases: Enum

An enumeration.

MEMORY_POOL_REQUEST = 0

MEMORY_ALLOC_REQUEST = 1

__init__(tag, p_uid, r_c_uid, kind, request, _tc=None)

get_sdict()

class SHExecMemResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

FAIL = 1

__init__(tag, ref, err, err_code=0, err_info='', response=None, _tc=None)

get_sdict()

class SHChannelCreate

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, m_uid, c_uid, options=None, _tc=None)

get_sdict()

property options

class SHChannelCreateResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

FAIL = 1

__init__(tag, ref, err, desc=None, err_info='', _tc=None)

get_sdict()

class SHChannelDestroy

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, c_uid, _tc=None)

get_sdict()

class SHChannelDestroyResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

FAIL = 1

__init__(tag, ref, err, err_info='', _tc=None)

get_sdict()

class SHLockChannel

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, _tc=None)

get_sdict()

class SHLockChannelResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

ALREADY = 1

__init__(tag, ref, err, _tc=None)

get_sdict()

class SHAllocMsg

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, _tc=None)

get_sdict()

class SHAllocMsgResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

__init__(tag, ref, err, _tc=None)

get_sdict()

class SHAllocBlock

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, p_uid, r_c_uid, _tc=None)

get_sdict()

class SHAllocBlockResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

UNKNOWN = 1

FAIL = 2

__init__(tag, ref, err, seg_name='', offset=0, err_info='', _tc=None)

get_sdict()

class SHChannelsUp

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, node_desc, gs_cd, idx=0, net_conf_key=0, _tc=None)

get_sdict()

class SHPingGS

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, idx=0, node_sdesc=None, _tc=None)

get_sdict()

class SHTeardown

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class SHPingBE

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

EMPTY = ''

__init__(tag, shep_cd='', be_cd='', gs_cd='', default_pd='', inf_pd='', _tc=None)

get_sdict()

class SHHaltTA

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class SHHaltBE

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class SHHalted

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, idx=0, _tc=None)

get_sdict()

class SHFwdInput

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

MAX = 1024

__init__(tag, p_uid, r_c_uid, t_p_uid=None, input='', confirm=False, _tc=None)

get_sdict()

class SHFwdInputErr

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

FAIL = 1

__init__(tag, ref, err, idx=0, err_info='', _tc=None)

get_sdict()

class SHFwdOutput

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

MAX = 1024

class FDNum

Bases: Enum

An enumeration.

STDOUT = 1

STDERR = 2

__init__(tag, p_uid, idx, fd_num, data, _tc=None, pid=-1, hostname='NONE')

get_sdict()

class SHDumpState

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, filename=None, _tc=None)

get_sdict()

class BENodeIdxSH

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, node_idx, host_name=None, ip_addrs=None, primary=None, logger_sdesc=None, net_conf_key=None, _tc=None)

property logger_sdesc

get_sdict()

class BEPingSH

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class BEHalted

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class LABroadcast

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure. The _tc value of this message must be set to 68. The Launcher Network Front End has this as an external dependency.

__init__(tag, data, _tc=None)

get_sdict()

class LAPassThruFB

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, c_uid, data, _tc=None)

get_sdict()

class LAPassThruBF

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, data, _tc=None)

get_sdict()

class LAServerMode

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, frontend, backend, frontend_args=None, backend_args=None, backend_env=None, backend_run_dir='', backend_user_name='', backend_options=None, _tc=None)

get_sdict()

class LAServerModeExit

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0

FAIL = 1

__init__(tag, ref, err, _tc=None)

get_sdict()

class LAProcessDict

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class LAProcessDictResponse

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

class Errors

Bases: Enum

An enumeration.

SUCCESS = 0: Always succeeds

__init__(tag, ref, err, pdict=None, _tc=None)

get_sdict()

class LADumpState

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, filename=None, _tc=None)

get_sdict()

class LAChannelsInfo

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, nodes_desc, gs_cd, num_gw_channels, port=None, transport='tcp', _tc=None, *, fe_ext_ip_addr=None)

get_sdict()

class LoggingMsg

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, name, msg, time, func, hostname, ip_address, port, service, level, _tc=None)

get_sdict()

get_logging_dict()

class LoggingMsgList

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, records, _tc=None)

property records

get_sdict()

class LogFlushed

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class TAPingSH

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class TAHalted

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, _tc=None)

get_sdict()

class TAUp

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

The test_channels are empty unless the DRAGON_TRANSPORT_TEST environment variable is set to some value. When set in the environment, local services will create two channels and provide the base64 encoded serialized channel descriptors in this test_channels field to the launcher front end which then disseminates them to the test program which is started on each node.

__init__(tag, idx=0, test_channels=[], _tc=None)

get_sdict()

class Breakpoint

Bases: InfraMsg

__init__(tag, p_uid, index, out_desc, in_desc, _tc=None)

get_sdict()

class BEIsUp

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, be_ch_desc, host_id, _tc=None)

get_sdict()

class FENodeIdxBE

Bases: InfraMsg

Refer to definition and Common Fields for a description of the message structure.

__init__(tag, node_index, net_conf_key_mapping=None, forward: dict[str, NodeDescriptor | dict] | None = None, send_desc: B64 | str | None = None, _tc=None)