demessaging.messaging.constants module

Enums within the DASF Messaging Framework.

Classes:

MessageType(value)	Supported message types.
PropertyKeys(value)	Property keys for a message to the message broker.
Status(value)	Status flag of a request.

Functions:

generate_enum_doc(class_)

Utility function to generate the docstring for an enum.

class demessaging.messaging.constants.MessageType(value)

Bases: str, Enum

Supported message types.

The following values are valid:

• PING ("ping")

• PONG ("pong")

• REQUEST ("request")

• RESPONSE ("response")

• LOG ("log")

• INFO ("info")

• PROGRESS ("progress")

• API_INFO ("api_info")

Attributes:

API_INFO
INFO
LOG
PING
PONG
PROGRESS
REQUEST
RESPONSE

API_INFO = 'api_info'

INFO = 'info'

LOG = 'log'

PING = 'ping'

PONG = 'pong'

PROGRESS = 'progress'

REQUEST = 'request'

RESPONSE = 'response'

class demessaging.messaging.constants.PropertyKeys(value)

Bases: str, Enum

Property keys for a message to the message broker.

The following values are valid:

• REQUEST_CONTEXT ("requestContext")

• RESPONSE_TOPIC ("response_topic")

• SOURCE_TOPIC ("source_topic")

• REQUEST_MESSAGEID ("requestMessageId")

• MESSAGE_TYPE ("messageType")

• FRAGMENT ("fragment")

• NUM_FRAGMENTS ("num_fragments")

• STATUS ("status")

Attributes:

FRAGMENT
MESSAGE_TYPE
NUM_FRAGMENTS
REQUEST_CONTEXT
REQUEST_MESSAGEID
RESPONSE_TOPIC
SOURCE_TOPIC
STATUS

FRAGMENT = 'fragment'

MESSAGE_TYPE = 'messageType'

NUM_FRAGMENTS = 'num_fragments'

REQUEST_CONTEXT = 'requestContext'

REQUEST_MESSAGEID = 'requestMessageId'

RESPONSE_TOPIC = 'response_topic'

SOURCE_TOPIC = 'source_topic'

STATUS = 'status'

class demessaging.messaging.constants.Status(value)

Bases: str, Enum

Status flag of a request.

The following values are valid:

• SUCCESS ("success")

• ERROR ("error")

• RUNNING ("running")

Attributes:

ERROR
RUNNING
SUCCESS

ERROR = 'error'

RUNNING = 'running'

SUCCESS = 'success'

demessaging.messaging.constants.generate_enum_doc(class_: Type[Enum]) → Type[Enum]

Utility function to generate the docstring for an enum.