goodboy
/
tractor
1
0
Fork 1
Code Issues 1 Pull Requests 4 Packages Projects Releases Wiki Activity

Expand `PayloadMsg` doc-str

runtime_to_msgspec
Tyler Goodlet 2024-06-18 09:57:10 -04:00
parent 711f639fc5
commit 72df312e71
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
tractor/msg/types.py
View File

@ -73,11 +73,22 @@ class PayloadMsg(
# as_array=True, # as_array=True,
): ):
''' '''
The "god" boxing msg type. An abstract payload boxing/shuttling IPC msg type.
Boxes user data-msgs in a `.pld` and uses `msgspec`'s tagged Boxes data-values passed to/from user code
unions support to enable a spec from a common msg inheritance
tree. (i.e. any values passed by `tractor` application code using any of
|_ `._streaming.MsgStream.send/receive()`
|_ `._context.Context.started/result()`
|_ `._ipc.Channel.send/recv()`
aka our "IPC primitive APIs")
as message "payloads" set to the `.pld` field and uses
`msgspec`'s "tagged unions" feature to support a subset of our
"SC-transitive shuttle protocol" specification with
a `msgspec.Struct` inheritance tree.
''' '''
cid: str # call/context-id cid: str # call/context-id