Skip to content

MessageType

veltix.network.types.MessageType

Defines a message type in the Veltix protocol.

Message codes are organized in ranges: - 0-199: System messages (reserved) - 200-499: User application messages - 500+: Plugin/extension messages

Parameters:

Name Type Description Default
code int

Unique type code (0-65535)

required
name Optional[str]

Human-readable type name

None
description Optional[str]

Optional detailed description

None

Raises:

Type Description
MessageTypeError

If code is out of range or already registered

__repr__

__repr__() -> str

Return string representation of MessageType.

__eq__

__eq__(other: object) -> bool

Check equality based on code.

__hash__

__hash__() -> int

Make MessageType hashable.

veltix.network.types.MessageTypeRegistry

Registry for managing message types.

Maintains a singleton mapping between message codes and MessageType instances. All MessageType instances are automatically registered on creation.

register classmethod

register(msg_type: MessageType) -> None

Register a message type.

Parameters:

Name Type Description Default
msg_type MessageType

MessageType instance to register

required

Raises:

Type Description
MessageTypeError

If code is already registered

get classmethod

get(code: int) -> Optional[MessageType]

Get a message type by its code.

Parameters:

Name Type Description Default
code int

Message type code to look up

required

Returns:

Type Description
Optional[MessageType]

MessageType instance or None if not found

list_all classmethod

list_all() -> list[MessageType]

Get all registered message types.