Skip to content

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.

from cayu.collaboration import CollaborationHost

Explicit 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.

CollaborationHost.__init__(app: CayuApp, registration: _HostRegistration) -> None
CollaborationHost.inspect() -> _HostInspection
async CollaborationHost.service_once() -> _HostInspection
async CollaborationHost.run() -> None
async CollaborationHost.aclose() -> _HostInspection
async CollaborationHost.__aenter__() -> CollaborationHost
async CollaborationHost.__aexit__(exc_type, exc, traceback)

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import HostClarificationMaintenanceSource

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostClarificationRule

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostContinuationRule

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostInspection

Decorators: @dataclass(frozen=True, slots=True).

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
HostInspection.pending() -> bool

Local ownership remains, including reads and active native execution.

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import HostOwnershipLimits

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostPlannedProducer

Finite application choices, not a caller-created admission or launch grant.

Bases: ContractValue.

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)
HostPlannedProducer.bounded_input(value: object) -> Any
HostPlannedProducer.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import HostPlannedProducerRule

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostPlanningRule

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostProducerDisclosure

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostProducerExecution

Bases: ContractValue.

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)
HostProducerExecution.bounded_input(value: object) -> Any
HostProducerExecution.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import HostProducerExecutionRule

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostProducerMaintenance

Bases: ContractValue.

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
HostProducerMaintenance.bounded_input(value: object) -> Any
HostProducerMaintenance.immutable_fields() -> ContractValue
HostProducerMaintenance.exact_destination()

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import HostProducerMaintenanceRule

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostProducerOutputRule

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostProducerRegistrationRule

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostProducerSource

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostRegistration

Finite local configuration, never a durable work queue or authority grant.

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostRequestMaintenanceSource

Decorators: @dataclass(frozen=True, slots=True).

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

from cayu.collaboration import HostWaitRule

Decorators: @dataclass(frozen=True, slots=True).

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

Release source · Runtime guarantees · Capability guides