GitHub

message_storage

API reference for message_storage.

Where messages to entities and their replies are kept (Effect's MessageStorage).

MessageStorage is the service; layer_memory keeps one runner's messages in memory, layer_noop keeps nothing, and drivers that persist (pyfect.cluster.sql_message_storage) implement EncodedStorage and are wrapped by make_encoded.

Values

AttributeTypeDescription
CLAIM_EXPIRATION_MILLISLiteral[600000]

How long a returned message stays claimed (the SQL driver's last_read < ten minutes ago).

layer_memorylayer_.Layer[MessageStorage | MemoryDriver]

Message storage in memory, with its driver.

memory_driver_layerlayer_.Layer[MemoryDriver]

Effect's MemoryDriver.layer.

NOOPMessageStorageService

The storage that keeps nothing; runners compare against it to skip reading replies back.

layer_nooplayer_.Layer[MessageStorage]
SAVE_SUCCESSSaveSuccess

Types

TypeDefinitionDescription
SaveResultEncodedtype SaveResultEncoded = SaveSuccess | DuplicateEncoded
SaveResulttype SaveResult = SaveSuccess | SaveDuplicate

Classes

Functions

make_encoded

make_encoded(encoded) -> Effect[MessageStorageService, Any, SnowflakeGeneratorTag]

A message storage on the driver encoded.

ParameterTypeDescription
encodedEncodedStorage

Returns Effect[MessageStorageService, Any, SnowflakeGeneratorTag]

def make_encoded(
    encoded: EncodedStorage,
) -> Effect[MessageStorageService, Any, SnowflakeGeneratorTag]:
    """A message storage on the driver ``encoded``."""

    def body() -> Generator[Effect[Any, Any, Any], Any, MessageStorageService]:
        snowflakes = yield from SnowflakeGeneratorTag()
        clock = yield from Clock()
        base = _EncodedBase(encoded, snowflakes, clock)
        return (yield from make(base))

    return gen(body)

make_memory_driver

make_memory_driver() -> Effect[MemoryDriverService, Any, snowflake.Generator]

Returns Effect[MemoryDriverService, Any, snowflake.Generator]

def make_memory_driver() -> Effect[MemoryDriverService, Any, snowflake.Generator]:
    def body() -> Generator[Effect[Any, Any, Any], Any, MemoryDriverService]:
        clock = yield from Clock()
        encoded = MemoryEncoded(clock)
        storage = yield from make_encoded(encoded)
        return MemoryDriverService(storage, encoded)

    return gen(body)

make

make(base) -> Effect[MessageStorageService]

A message storage on base (Effect's MessageStorage.make).

ParameterTypeDescription
baseStorageBase

Returns Effect[MessageStorageService]

def make(base: StorageBase) -> Effect[MessageStorageService]:
    """A message storage on ``base`` (Effect's ``MessageStorage.make``)."""
    return sync(lambda: MessageStorageService(base))