Skip to main content

agora.receiver.memory

ReceiverMemory Objects​

class ReceiverMemory(ProtocolMemory)

Manages memory for the Receiver, including protocol registrations and suitability assessments.

register_new_protocol​

def register_new_protocol(protocol_id: str, protocol_sources: List[str],
                          protocol_document: str, metadata: dict)

Registers a new protocol with given sources, document, and metadata.

Arguments:

  • protocol_id str - The identifier of the protocol.
  • protocol_sources List[str] - A list of source URLs for the protocol.
  • protocol_document str - The protocol contents.
  • metadata dict - Additional protocol metadata.

get_protocol_conversations​

def get_protocol_conversations(protocol_id: str) -> int

Returns the number of conversations associated with a protocol.

Arguments:

  • protocol_id str - The protocol's identifier.

Returns:

  • int - The conversation count.

increment_protocol_conversations​

def increment_protocol_conversations(protocol_id: str) -> None

Increments the conversation count for the specified protocol.

Arguments:

  • protocol_id str - The identifier of the protocol.

set_suitability​

def set_suitability(protocol_id: str, suitability: Suitability) -> None

Sets the suitability for a given protocol.

Arguments:

  • protocol_id str - The identifier of the protocol.
  • suitability Suitability - The new suitability value.

get_suitability​

def get_suitability(protocol_id: str) -> Suitability

Retrieves the suitability for a given protocol.

Arguments:

  • protocol_id str - The protocol's identifier.

Returns:

  • Suitability - The current suitability status.