cayu.collaboration.host
Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.
CollaborationHost
Section titled “CollaborationHost”from cayu.collaboration import CollaborationHostExplicit lifetime with retained native tasks, not another execution loop.
Construction validates and snapshots configuration only. No store, policy, model, or resource operation occurs until explicit servicing starts.
init (method)
Section titled “init (method)”CollaborationHost.__init__(app: CayuApp, registration: _HostRegistration) -> Noneinspect (method)
Section titled “inspect (method)”CollaborationHost.inspect() -> _HostInspectionservice_once (method)
Section titled “service_once (method)”async CollaborationHost.service_once() -> _HostInspectionrun (method)
Section titled “run (method)”async CollaborationHost.run() -> Noneaclose (method)
Section titled “aclose (method)”async CollaborationHost.aclose() -> _HostInspectionaenter (method)
Section titled “aenter (method)”async CollaborationHost.__aenter__() -> CollaborationHostaexit (method)
Section titled “aexit (method)”async CollaborationHost.__aexit__(exc_type, exc, traceback)Release source · Runtime guarantees · Capability guides
HostClarificationMaintenanceSource
Section titled “HostClarificationMaintenanceSource”from cayu.collaboration import HostClarificationMaintenanceSourceDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
source |
Literal['questions', 'deliveries', 'services'] |
required |
context |
CollaborationAccessContext |
required |
Release source · Runtime guarantees · Capability guides
HostClarificationRule
Section titled “HostClarificationRule”from cayu.collaboration import HostClarificationRuleDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
request |
ClarificationServiceRequest |
required |
context |
SessionExportAccessContext |
required |
delivery_context |
SessionExportAccessContext | None |
None |
Release source · Runtime guarantees · Capability guides
HostContinuationRule
Section titled “HostContinuationRule”from cayu.collaboration import HostContinuationRuleDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
expected |
ContinuationRecovery |
required |
request |
ResumeRequest |
required |
service |
ContinuationService |
required |
context |
CollaborationAccessContext |
required |
recovery_inactive_for_seconds |
int | None |
None |
Release source · Runtime guarantees · Capability guides
HostInspection
Section titled “HostInspection”from cayu.collaboration import HostInspectionDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
closing |
bool |
required |
servicing_pending |
bool |
required |
active |
int |
required |
uncertain |
int |
required |
failed |
int |
required |
source_failures |
int |
required |
serviced |
int |
required |
observed_blocked |
int |
required |
discovery_pending |
int |
0 |
coverage_complete |
bool |
False |
pending (property)
Section titled “pending (property)”HostInspection.pending() -> boolLocal ownership remains, including reads and active native execution.
Release source · Runtime guarantees · Capability guides
HostOwnershipLimits
Section titled “HostOwnershipLimits”from cayu.collaboration import HostOwnershipLimitsDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
execution_slots |
int |
required |
maintenance_slots |
int |
required |
retained_operations |
int |
required |
retained_bytes |
int |
required |
Release source · Runtime guarantees · Capability guides
HostPlannedProducer
Section titled “HostPlannedProducer”from cayu.collaboration import HostPlannedProducerFinite application choices, not a caller-created admission or launch grant.
Bases: ContractValue.
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
plan |
RequestPlanningRequest |
required |
operation |
OperationRef |
required |
binding_incarnation |
Identifier |
required |
execution_key |
Identifier |
required |
recovery_inactive_for_seconds |
int | None |
Field(default=None, strict=True, ge=1, le=86400) |
limits |
ProducerOutputLimits |
required |
destinations |
tuple[ProducerDeliveryDestination, ...] |
Field(min_length=1, max_length=MAX_OUTPUT_DESTINATIONS) |
bounded_input (method)
Section titled “bounded_input (method)”HostPlannedProducer.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”HostPlannedProducer.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
HostPlannedProducerRule
Section titled “HostPlannedProducerRule”from cayu.collaboration import HostPlannedProducerRuleDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
selected |
HostPlannedProducer |
required |
context |
CollaborationAccessContext |
required |
producer_context |
MandateAccessContext |
required |
Release source · Runtime guarantees · Capability guides
HostPlanningRule
Section titled “HostPlanningRule”from cayu.collaboration import HostPlanningRuleDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
expected |
RequestPlanningRequest |
required |
context |
MandateAccessContext |
required |
Release source · Runtime guarantees · Capability guides
HostProducerDisclosure
Section titled “HostProducerDisclosure”from cayu.collaboration import HostProducerDisclosureDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
destination |
OperationRef |
required |
context |
SessionExportAccessContext |
required |
Release source · Runtime guarantees · Capability guides
HostProducerExecution
Section titled “HostProducerExecution”from cayu.collaboration import HostProducerExecutionBases: ContractValue.
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
recovery |
ProducerOutputRecovery |
required |
expected_plan |
RequestPlanningRequest | None |
None |
recovery_inactive_for_seconds |
int | None |
Field(default=None, strict=True, ge=1, le=86400) |
bounded_input (method)
Section titled “bounded_input (method)”HostProducerExecution.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”HostProducerExecution.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
HostProducerExecutionRule
Section titled “HostProducerExecutionRule”from cayu.collaboration import HostProducerExecutionRuleDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
intent |
HostProducerExecution |
required |
context |
CollaborationAccessContext |
required |
producer_context |
MandateAccessContext |
required |
Release source · Runtime guarantees · Capability guides
HostProducerMaintenance
Section titled “HostProducerMaintenance”from cayu.collaboration import HostProducerMaintenanceBases: ContractValue.
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
recovery |
ProducerOutputRecovery |
required |
action |
Action |
required |
destination |
OperationRef | None |
None |
bounded_input (method)
Section titled “bounded_input (method)”HostProducerMaintenance.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”HostProducerMaintenance.immutable_fields() -> ContractValueexact_destination (method)
Section titled “exact_destination (method)”HostProducerMaintenance.exact_destination()Release source · Runtime guarantees · Capability guides
HostProducerMaintenanceRule
Section titled “HostProducerMaintenanceRule”from cayu.collaboration import HostProducerMaintenanceRuleDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
intent |
HostProducerMaintenance |
required |
context |
CollaborationAccessContext |
required |
disclosure_context |
SessionExportAccessContext | None |
None |
Release source · Runtime guarantees · Capability guides
HostProducerOutputRule
Section titled “HostProducerOutputRule”from cayu.collaboration import HostProducerOutputRuleDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
recovery |
ProducerOutputRecovery |
required |
context |
CollaborationAccessContext |
required |
failure_context |
SessionExportAccessContext |
required |
destinations |
tuple[_ProducerDisclosure, ...] |
required |
Release source · Runtime guarantees · Capability guides
HostProducerRegistrationRule
Section titled “HostProducerRegistrationRule”from cayu.collaboration import HostProducerRegistrationRuleDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
expected |
ProducerOutputRegistration |
required |
context |
CollaborationAccessContext |
required |
producer_context |
MandateAccessContext |
required |
Release source · Runtime guarantees · Capability guides
HostProducerSource
Section titled “HostProducerSource”from cayu.collaboration import HostProducerSourceDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
participant |
ParticipantRef |
required |
context |
CollaborationAccessContext |
required |
Release source · Runtime guarantees · Capability guides
HostRegistration
Section titled “HostRegistration”from cayu.collaboration import HostRegistrationFinite local configuration, never a durable work queue or authority grant.
Decorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
limits |
HostOwnershipLimits |
required |
producer_sources |
tuple[_ProducerSource, ...] |
required |
producer_rules |
tuple[_ProducerMaintenanceRule, ...] |
required |
batch_size |
int |
8 |
page_bytes |
int |
65536 |
observation_timeout_s |
float |
5 |
poll_interval_s |
float |
0.1 |
shutdown_timeout_s |
float |
5 |
producer_execution_rules |
tuple[_ProducerExecutionRule, ...] |
() |
producer_output_rules |
tuple[_ProducerOutputRule, ...] |
() |
planning_rules |
tuple[_PlanningRule, ...] |
() |
producer_registration_rules |
tuple[_ProducerRegistrationRule, ...] |
() |
wait_rules |
tuple[_WaitRule, ...] |
() |
continuation_rules |
tuple[_ContinuationRule, ...] |
() |
clarification_rules |
tuple[_ClarificationRule, ...] |
() |
clarification_maintenance_sources |
tuple[_ClarificationMaintenanceSource, ...] |
() |
planned_producer_rules |
tuple[_PlannedProducerRule, ...] |
() |
request_maintenance_sources |
tuple[_RequestMaintenanceSource, ...] |
() |
discovery_slots |
int |
4 |
discovery_bytes |
int |
512 * 1024 |
Release source · Runtime guarantees · Capability guides
HostRequestMaintenanceSource
Section titled “HostRequestMaintenanceSource”from cayu.collaboration import HostRequestMaintenanceSourceDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
context |
MandateAccessContext |
required |
Release source · Runtime guarantees · Capability guides
HostWaitRule
Section titled “HostWaitRule”from cayu.collaboration import HostWaitRuleDecorators: @dataclass(frozen=True, slots=True).
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
expected |
WaitRecovery |
required |
context |
MandateAccessContext |
required |