Skip to main content

config

Message Service configuration.

Module​

Global variables​

  • PRODUCTION_MESSAGE_SERVICE_URL - Production message service URL.

Classes​

MessageServiceConfig​

class MessageServiceConfig(    url: Optional[str] = None,    port: int = 443,    tls: bool = True,    use_local_storage: bool = False,):

Configuration for the message service.

Arguments

  • url: The URL of the message service. Defaults to PRODUCTION_MESSAGE_SERVICE_URL.
  • port: The port of the message service. Defaults to 443.
  • tls: Whether to use TLS. Defaults to True.
  • use_local_storage: Whether to use local storage instead of communicating via the message service if both parties are on the same device. This can be used to remove the overhead of communication. Defaults to False.

Raises

  • ValueError: If tls is False and url is a Bitfount URL.

Ancestors​

  • bitfount.types.UsedForConfigSchemas

Variables​

  • static port : int
  • static tls : bool
  • static url : Optional[str]
  • static use_local_storage : bool

Methods​

test_connection​

def test_connection(self) ‑> bool:

Check if the Message Service instance is reachable.