App settings

This module defines the settings options for the dasf-broker-django app.

Data:

DASF_CREATE_TOPIC_ON_MESSAGE	Create new topics on message
DASF_STORE_MESSAGES	Shall the messages be stored?
DASF_STORE_RESPONSE_MESSAGES	Shall the messages to response topics be stored?
DASF_STORE_SOURCE_MESSAGES	Shall the source messages be stored?
DASF_WEBSOCKET_URL_ROUTE	URL route for the websocket
ROOT_URL	root URL to your application

Classes:

StoreMessageOptions(value)

An enumeration.

dasf_broker.app_settings.DASF_CREATE_TOPIC_ON_MESSAGE: bool = True

Create new topics on message

This flag controls if new topics are created when a message comes from a producer. If False, messages with non-existing topics are ignored.

Note that a user also needs the dasf_broker.add_BrokerTopic permission to create topics.

dasf_broker.app_settings.DASF_STORE_MESSAGES: StoreMessageOptions = StoreMessageOptions.CACHE

Shall the messages be stored?

This flag controls whether the message broker caches messages from producers until they are consumed by the consumer. This is useful if the consumer looses connection to the server. This settings can take three different values:

"disabled"

The message is not stored at all

"cache"

The message is stored and removed ones one of the potential consumers acknowledges the message

"cacheall"

The message is stored and removed ones all consumers acknowledged the message

"store"

The message and response topics are stored forever and are not automatically removed

See also

DASF_STORE_SOURCE_MESSAGES, DASF_STORE_RESPONSE_MESSAGES

dasf_broker.app_settings.DASF_STORE_RESPONSE_MESSAGES: StoreMessageOptions = StoreMessageOptions.CACHE

Shall the messages to response topics be stored?

This flag controls whether the message broker caches messages from producers to topics that are marked as response topic. If this setting is not set, we use the DASF_STORE_MESSAGES setting.

dasf_broker.app_settings.DASF_STORE_SOURCE_MESSAGES: StoreMessageOptions = StoreMessageOptions.CACHE

Shall the source messages be stored?

This flag controls whether the message broker caches messages from producers to topics that are not marked as response topic. If this setting is not set, we use the DASF_STORE_MESSAGES setting.

dasf_broker.app_settings.DASF_WEBSOCKET_URL_ROUTE: str = 'ws/'

URL route for the websocket

This setting controls, where we expect to find the websockets. As there is no analog to django.urls.reverse() for channels, you should use this setting in your asgi.py file to include the routes of this package.

Examples

In your asgi.py file, include it like:

from channels.routing import ProtocolTypeRouter, URLRouter
from django.core.asgi import get_asgi_application
from channels.auth import AuthMiddlewareStack
import dasf_broker.routing as dasf_routing
from dasf_broker.app_settings import DASF_WEBSOCKET_URL_ROUTE

application = ProtocolTypeRouter(
    {
        "http": get_asgi_application(),
        "websocket": AuthMiddlewareStack(
            URLRouter(
                [
                    path(
                        DASF_WEBSOCKET_URL_ROUTE,
                        URLRouter(dasf_routing.websocket_urlpatterns),
                    )
                ]
            )
        ),
    }
)

dasf_broker.app_settings.ROOT_URL: str | None = None

root URL to your application

You can use this setting if you are behind a reverse proxy and the host names, etc. are not handled correctly.

If you leave this empty, we will use the build_absolute_uri method of the http request.

Examples

A standard value for this would be http://localhost:8000

class dasf_broker.app_settings.StoreMessageOptions(value)

Bases: str, Enum

An enumeration.

Attributes:

CACHE
CACHEALL
DISABLED
STORE

CACHE = 'cache'

CACHEALL = 'cacheall'

DISABLED = 'disabled'

STORE = 'store'