stompman

https://pypi.org/project/stompman/
Admin
stompman is an asynchronous Python STOMP client with a modern, typed API for reliable messaging with...
Tokens:2,172
Snippets:31
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Stompman

Source: https://pypi.org/project/stompman

Install the stompman package using pip or add it to your Poetry project. For WebSocket support, install with `stompman[ws]`.

```bash
uv add stompman
poetry add stompman
```

--------------------------------

### Initialize Stompman Client

Source: https://pypi.org/project/stompman

Initialize the stompman client with a list of server connection parameters. Configure SSL, error handlers, and connection retry options.

```python
async with stompman.Client(
    servers=[
        stompman.ConnectionParameters(host="171.0.0.1", port=61616, login="user1", passcode="passcode1"),
        stompman.ConnectionParameters(host="172.0.0.1", port=61616, login="user2", passcode="passcode2"),
    ],


    # SSL — can be either `None` (default), `True`, or `ssl.SSLContext`
    ssl=None,

    # Error frame handler:
    on_error_frame=lambda error_frame: print(error_frame.body),

    # Optional parameters with sensible defaults:
    heartbeat=stompman.Heartbeat(will_send_interval_ms=1000, want_to_receive_interval_ms=1000),
    connect_retry_attempts=3,
    connect_retry_interval=1,
    connect_timeout=2,
    connection_confirmation_timeout=2,
    disconnect_confirmation_timeout=2,
    write_retry_attempts=3,
    check_server_alive_interval_factor=3,
    no_message_restart_interval=datetime.timedelta(hours=1),  # None to disable
) as client:
    ...
```

--------------------------------

### Subscribe with Custom Headers and Client Acknowledgment

Source: https://pypi.org/project/stompman

Subscribe to the 'DLQ' queue with custom headers, requiring manual client acknowledgment. Handles suppressed exceptions by printing them.

```python
await client.subscribe("DLQ", handle_message_from_dlq, ack="client", headers={"selector": "location = 'Europe'"}, on_suppressed_exception=print)
```

--------------------------------

### Initialize Client with WebSocket Connection

Source: https://pypi.org/project/stompman

Initialize the stompman client using a custom connection class, such as WebSocketConnection, for connecting over websockets.

```python
# uv/poetry add stompman[ws] to get WebScoketConnection support
from stompman.connection_ws import WebSocketConnection

async with stompman.Client(
    servers=[
        stompman.ConnectionParameters(host="171.0.0.1", port=8080, login="", passcode="", ws_uri_path="/ws/path"),
    ],
    connection_class=WebSocketConnection,
    ...
) as client:
    ...
```

--------------------------------

### Subscribe with Manual Acknowledgments

Source: https://pypi.org/project/stompman

Subscribe to the 'DLQ' queue requiring manual client acknowledgment. The handler function must explicitly call `message_frame.ack()`.

```python
async def handle_message_from_dlq(message_frame: stompman.AckableMessageFrame) -> None:
    print(message_frame.body)
    await message_frame.ack()

await client.subscribe_with_manual_ack("DLQ", handle_message_from_dlq, ack="client")
```

--------------------------------

### Subscribe to a Queue with Auto Acknowledgment

Source: https://pypi.org/project/stompman

Subscribe to the 'DLQ' queue and automatically acknowledge messages as soon as they are sent to the client. Handles suppressed exceptions by printing them.

```python
await client.subscribe("DLQ", handle_message_from_dlq, ack="auto", on_suppressed_exception=print)
```

--------------------------------

### Send a Message

Source: https://pypi.org/project/stompman

Send a message to a specified destination with optional headers. The message body should be in bytes.

```python
await client.send(b"hi there!", destination="DLQ", headers={"persistent": "true"})
```

--------------------------------

### Subscribe to a Destination

Source: https://pypi.org/project/stompman

Subscribe to a destination to listen for incoming messages. Define a handler function to process received messages and an exception handler.

```python
async def handle_message_from_dlq(message_frame: stompman.MessageFrame) -> None:
    print(message_frame.body)


await client.subscribe("DLQ", handle_message_from_dlq, on_suppressed_exception=print)
```

--------------------------------

### Subscribe with Client Acknowledgement

Source: https://pypi.org/project/stompman

Subscribe to a destination using client-side acknowledgement mode. This requires explicit ACK or NACK frames to be sent after message processing.

```python
# Server will assume that all messages sent to the subscription before the ACK'ed message are received and processed:
await client.subscribe("DLQ", handle_message_from_dlq, ack="client", on_suppressed_exception=print)
```

--------------------------------

### Subscribe with Custom Exception Handling

Source: https://pypi.org/project/stompman

Subscribe to a destination and provide a custom handler for suppressed exceptions during message processing. This allows for detailed logging or specific error handling.

```python
await client.subscribe(
    "DLQ",
    handle_message_from_dlq,
    on_suppressed_exception=lambda exception, message_frame: print(exception, message_frame),
)
```

--------------------------------

### Send Messages in a Transaction

Source: https://pypi.org/project/stompman

Send multiple messages within a transaction. All messages sent within the `begin()` context will be committed or rolled back together.

```python
async with client.begin() as transaction:
    for _ in range(10):
        await transaction.send(body=b"hi there!", destination="DLQ", headers={"persistent": "true"})
        await asyncio.sleep(0.1)
```

--------------------------------

### Unsubscribe from a Destination

Source: https://pypi.org/project/stompman

Unsubscribe from a destination to stop receiving messages. This is useful when you want to manually manage subscriptions and avoid blocking the client.

```python
dlq_subscription = await client.subscribe("DLQ", handle_message_from_dlq, on_suppressed_exception=print)
await dlq_subscription.unsubscribe()
```
Tokens:
Raw