queen-mq 0.3.1 → 0.4.0

package/README.md

@@ -2,15 +2,16 @@
 
 <div align="center">
 
-**A modern, high-performance message queue system built on PostgreSQL**
+**A modern, performant message queue system built on PostgreSQL**
 
 [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE.md)
 [![Node](https://img.shields.io/badge/node-%3E%3D22.0.0-brightgreen.svg)](https://nodejs.org/)
+[![C++](https://img.shields.io/badge/C%2B%2B-17-blue.svg)](https://en.cppreference.com/w/cpp/17)
 
-[Quick Start](#js-client-usage-v2) • [Complete V2 Guide](client-js/client-v2/README.md) • [Examples](#-examples) • [Webapp](#webapp) • [Server Setup](#install-server-and-configure-it) • [HTTP API](#raw-http-api)
+[Quick Start](#one-single-example) • [Complete V2 Guide](client-js/client-v2/README.md) • [Webapp](#webapp) • [Server Setup](#install-the-server-and-configure-it) • [HTTP API](#raw-http-api)
 
 <p align="center">
-  <img src="assets/queen-logo-rose.svg" alt="Queen Logo" width="120" />
+  <img src="assets/queen-logo.svg" alt="Queen Logo" width="120" />
 </p>
 
 </div>
@@ -29,6 +30,7 @@ Here are the main features:
 - Unlimited FIFO partitions within queues
 - Queue semantics like RabbitMQ
 - Consumer groups over queues like Kafka
+- Allows for all the patterns you need, from simple queues to complex workflows and request/response patterns
 - QoS levels: Exactly-once delivery (with transactionId), at-least-once delivery, and at-most-once delivery
 - Subscription modes for replay (new messages only or from a specific timestamp) and message history control
 - Transactions between operations (push and ack mainly) for atomicity
@@ -36,19 +38,88 @@ Here are the main features:
 - Lease renewal for long-running tasks
 - Message tracing for debugging workflows
 - Encryption of messages at DB level
+- Automatic message retention and cleanup - Configurable per-queue retention policies
+- Streaming capabilities for real-time aggregation and processing of messages
+- A nice webapp for monitoring and managing the system
+- Maintenace mode that allows to continue pushing messages even when the database is down, and to drain the messages to the database when the maintenance mode is disabled
 
-The system consists of a PostgreSQL database, a replicated server that can be scaled horizontally (though it won't be the bottleneck), and a client library for interacting with the server. All client-server communication happens over HTTP, and the client library is written in JavaScript (support for other languages is planned). There's also a modern Vue 3 web app for monitoring and managing the system.
+The system consists of a PostgreSQL database, a replicated server that can be scaled horizontally (though it won't be the bottleneck), and a client library for interacting with the server. All client-server communication happens over HTTP, and the client library are available for JavaScript and C++ (Other languages like Python are planned). There's also a modern Vue 3 web app for monitoring and managing the system.
 
-With proper batching, the system can handle +100k **messages** per second (not req/s) on modest hardware.
+With proper batching, the system can handle +200k **messages** per second (not req/s) on modest hardware.
 
 Main documentation:
-- [Client Guide](client-js/client-v2/README.md)
+- [Client Guide JS](client-js/client-v2/README.md)
+- [Client Guide C++](client-cpp/README.md)
 - [Server Guide](server/README.md)
-- [API Reference](API.md)
+- [Streaming Guide](docs/STREAMING_USAGE.md)
+- [API Reference](server/API.md)
+- [Message Retention & Cleanup](docs/RETENTION.md)
 - [Webapp](webapp/README.md)
+- [Expose the Webapp behind a proxy](proxy/README.md)
 
+## Concepts
 
-## JS Client Usage
+Although the system is designed to be simple to use (not really), there are some concepts that are important to understand to use the system effectively.
+
+### Queues
+
+Queues are a way to organize your messages into logical groups. Each queue is like a container for messages. You can have as many queues as you want, and you can configure each queue with different settings, like the lease time, retry limit, encryption, retention, priority, delayed processing, window buffer and retention.
+
+### Partitions
+
+Partitions are a way to organize your messages into logical ordered groups. Each partition is like a separate queue inside a queue, and messages in the same partition are guaranteed to be processed in order. Only one consumer/client can acquire the lock for a partition at a time. You can have as many partitions as you want, and you can have as many consumers/clients as you want. If the lease in not acknowledged in time, the message is released and can be acquired by another consumer/client. Use renewLease() to renew the lease during long-running tasks. Each different consumer group can acquire the lock for a partition independently, so you can have as many consumer groups as you want.
+
+### Default partition and consumer group
+
+The default partition (if not specified) is `Default`. If you don't specify a consumer group, the messages are processed in queue mode, that is creating a default consumer group named `__QUEUE_MODE__`. Each queue can be used at the same time by multiple consumer groups, and each consumer group can process messages from multiple partitions.
+
+### Consumer groups
+
+Consumer groups are a way to process messages for different purposes. Each consumer group is like a separate queue, and messages in the same consumer group partition are guaranteed to be processed in order. Each consumer group tracks its own position in the queue. You can start a consumer group from the beginning of the queue, from a specific timestamp, or only new messages.
+
+### Subscription modes
+
+Subscription modes are a way to control the message history that is processed. You can choose to process all messages (including historical ones), only new messages, or messages from a specific timestamp. Subscription modes are only available when using consumer groups.
+
+### Long polling (waiting for messages)
+
+The client works with the pull model for pop operations, meaning that you need to explicitly request messages from the queue. Pop and consume mehtods can "wait" server side for messages to be available. When the method is called with wait=true, the method will block until messages are available or the timeout is reached. When the timeout is reached, the method returns an empty array. Long polling is a very efficient way to wait for messages, and it is the recommended way to consume messages.
+
+### Lease renewal
+
+Lease renewal is a way to keep the lock for a partition or consumer group alive. You can use lease renewal to prevent the lock from expiring and being acquired by another consumer/client.
+
+### Ack and Nack
+
+Ack and Nack are the way to acknowledge or not a message. Ack means that the message has been processed successfully, and Nack means that the message has not been processed successfully. Ack/Nack requires the partitionId, the transactionId and the leaseId to be specified. If the ack is coming from a consumer group, the consumer group name is also required. This logic is handled automatically by the client library, you don't need to worry about it. If the message has already been acknowledged, the ack will be ignored. Based on the configuration, the message can be automatically acknowledged or manually acknowledged.
+
+### Transactions
+
+Transactions are a way to ensure that a group of operations are atomic. You can use transactions to ensure that a group of operations are executed together, and if one of the operations fails, the entire transaction is rolled back. Transactions are useful to achieve the exactly-once guarantee. You can process a message on a queue, and forward to the next queue only if the consumer lease is still valid, concatenating ack and push into a single transaction.
+
+### Dead letter queue
+
+The dead letter queue is a way to handle messages that are not processed successfully. When a message is not processed successfully, it is moved to the dead letter queue. Messages goes in the DLQ when they are NACK after the retry limit is reached. You configure the retry limit for each queue at queue config.
+
+## Comparison with RabbitMQ, Kafka, and NATS
+
+For users familiar with existing message queue systems, here's how Queen's semantics and usage patterns compare:
+
+### Conceptual Mapping
+
+| Queen Concept | RabbitMQ Equivalent | Kafka Equivalent | NATS Equivalent |
+|---------------|---------------------|------------------|-----------------|
+| Queue | Queue | Topic | Stream (JetStream) |
+| Partition | N/A (queues are single-consumer by default) | Partition | N/A |
+| Consumer Group | Competing Consumers pattern | Consumer Group | Queue Group |
+| Queue Mode (no group) | Exclusive consumer | N/A (always uses groups) | Single subscriber |
+| Lease | Message TTL / Visibility timeout | N/A (commit-based) | Ack wait / nak delay |
+| Ack/Nack | Ack/Nack | Commit offset | Ack/Nak |
+| Transaction | Publisher confirms + consumer acks | Transactional producer/consumer | N/A |
+| Dead Letter Queue | Dead Letter Exchange | N/A (manual) | N/A (manual) |
+
+
+## One single example
 
 > 📖 **[Complete Guide: client-js/client-v2/README.md](client-js/client-v2/README.md)** - Full tutorial with all features!
 
@@ -59,131 +130,105 @@ import { Queen } from 'queen-mq'
 const queen = new Queen('http://localhost:6632')
 
 // Create a queue
-await queen.queue('tasks').create()
+await queen
+.queue('critical-task')
+.config({
+  leaseTime: 10, // 10 seconds to process the messages (seconds)
+})
+.create()
 
 // Push messages
-await queen.queue('tasks').push([
-  { data: { job: 'send-email', to: 'alice@example.com' } },
-  { data: { job: 'process-image', id: 123 } }
+await queen
+.queue('critical-task')
+.partition('tenant-123')
+.push([
+  { 
+    transactionId: 'my-id', // This is autogenerated, but you can set your own. Unique per queue partition.
+    data: { id: 123, description: 'Critical task' }  // The message payload
+  },
 ])
-
-// Consume messages (auto-ack on success, auto-nack on error)
-await queen.queue('tasks').consume(async (message) => {
-  console.log('Processing:', message.data)
-  // If this succeeds → message completed ✅
-  // If this throws → message retried 🔄
+.onSuccess(async (messages) => { // Not mandatory
+  console.log('Messages pushed successfully:', messages)
+})
+.onDuplicate(async (messages) => { // Not mandatory, triggered when a message with the same transactionId is pushed
+  console.warn('Duplicate transaction IDs detected')
+})
+.onError(async (messages, error) => {  // Without callbacks, push throws an error if some messages are not pushed
+  console.error('Error pushing messages:', error)
 })
 
-// Pop messages manually
-const messages = await queen.queue('tasks').batch(10).pop()
-for (const msg of messages) {
-  try {
-    await processMessage(msg.data)
-    await queen.ack(msg, true)  // Success
-  } catch (error) {
-    await queen.ack(msg, false)  // Retry
-  }
-}
-
-// Partitions (for ordering)
-await queen
-  .queue('user-events')
-  .partition('user-123')
-  .push([{ data: { event: 'login' } }])
-
-// Consumer groups (for scaling)
-await queen
-  .queue('emails')
-  .group('processors')
-  .concurrency(5)
-  .consume(async (message) => {
-    await sendEmail(message.data)
-  })
-
-// Subscription modes (control message history)
-// Skip historical messages, only process new ones
-await queen
-  .queue('events')
-  .group('realtime-monitor')
-  .subscriptionMode('new')
-  .consume(async (message) => {
-    console.log('New event only:', message.data)
-  })
-
-// Start from a specific timestamp
-const timestamp = '2025-10-28T10:00:00.000Z'
-await queen
-  .queue('events')
-  .group('replay-from-timestamp')
-  .subscriptionFrom(timestamp)
-  .consume(async (message) => {
-    console.log('Replaying from 10am:', message.data)
-  })
-
-// Transactions (atomic ack + push)
-const [msg] = await queen.queue('input').pop()
+// Consume messages
 await queen
+.queue('critical-task')
+// The consumer group name, without this, the messages are processed in queue mode
+.group('processor-consumer-group') 
+// 10 parallel workers
+.concurrency(10)
+// I want to manually ack/nack messages 
+.autoAck(false) 
+// 10 messages per batch, prefetch them
+.batch(10) 
+// Auto-renew the lease for the messages every 2 seconds
+.renewLease(true, 2000) 
+// Process each message individually
+.each() 
+// Do your work here
+.consume(async (message) => {
+  console.log('Processing:', message.data) 
+})
+// Ack the messages if you processed them successfully
+.onSuccess(async (message) => {
+  await queen
   .transaction()
-  .ack(msg)
-  .queue('output')
-  .push([{ data: { processed: true } }])
-  .commit()
-
-// Client-side buffering (for high throughput)
-await queen
-  .queue('logs')
-  .buffer({ messageCount: 100, timeMillis: 1000 })
-  .push([{ data: { level: 'info', message: 'Server started' } }])
-
-// Message tracing (for debugging and monitoring)
-await queen.queue('orders').consume(async (msg) => {
-  await msg.trace({
-    traceName: ['tenant-acme', 'order-flow-123'],
-    data: { text: 'Processing started', orderId: msg.data.id }
-  })
-  
-  // Process order...
-  
-  await msg.trace({
-    traceName: ['tenant-acme', 'order-flow-123'],
-    data: { text: 'Order completed' }
-  })
+  .queue('critical-task-next')
+  .partition('XXX')
+  .push([{ data: { message: 'Final', count: 3 } }])
+  .ack(message)
+  .commit()  
+})
+// Nack the messages if you failed to process them
+.onError(async (message, error) => {
+  console.error('Error processing messages:', error)
+  await queen.ack(message, false)
 })
+```
+
+## Webapp
+
+A modern Vue 3 web interface for managing and monitoring Queen MQ. 
+
+![Queen MQ Dashboard](./assets/dashboard.png)
 
-// Graceful shutdown
-await queen.close()
+![Queen MQ Queues](./assets/queues.png) 
+
+![Queen MQ Messages](./assets/messages.png) 
+
+![Queen MQ Traces](./assets/traces.png) 
+
+![Queen MQ Analytics](./assets/analytics.png) 
+
+![Queen MQ System Metrics](./assets/systemmetrics.png) 
+
+**Features:**
+- 📊 Real-time dashboard with system metrics
+- 📈 Message throughput visualization
+- 🔍 Queue management and monitoring
+- 👥 Consumer group tracking
+- 💬 Message browser with trace timeline
+- 🔎 **Trace explorer for debugging distributed workflows**
+- 📉 Analytics and insights
+- 🌓 Dark/light theme support
+
+**Quick Start:**
+```bash
+cd webapp
+npm install
+npm run dev
 ```
 
-**Key Features:**
-- ✅ Fluent, chainable API
-- ✅ Auto-acknowledgment (or manual control)
-- ✅ Partitions for ordered processing
-- ✅ Consumer groups for scaling
-- ✅ **Subscription modes (new messages only or from timestamp)**
-- ✅ Transactions for atomicity
-- ✅ Client-side buffering for speed
-- ✅ Dead letter queue for failures
-- ✅ Lease renewal for long tasks
-- ✅ **Message tracing for debugging workflows**
-- ✅ Graceful shutdown with buffer flush
-
-## 📚 Examples
-
-### Client
-
-See the **[Complete V2 Guide](client-js/client-v2/README.md)** with 14 parts covering everything from basics to advanced features:
-- Queue creation, push, and consume
-- Partitions and consumer groups
-- **Subscription modes (new messages, timestamps)**
-- Transactions and buffering
-- Dead letter queues
-- Lease renewal
-- Message tracing
-- Complete real-world pipeline example
-- And much more!
-
-**Test Files** (94 working examples): [client-js/test-v2/](client-js/test-v2/)
+The dashboard will be available at `http://localhost:4000` or at `http://localhost:6632` directly from the server.
 
+See [webapp/README.md](webapp/README.md) for more details.
 
 ## Architecture
 
@@ -233,32 +278,54 @@ Queen automatically buffers messages to disk when PostgreSQL is unavailable - **
 FILE_BUFFER_DIR=/custom/path ./bin/queen-server
 ```
 
-## Webapp
+## Performance Benchmarks
 
-A modern Vue 3 web interface for managing and monitoring Queen MQ.
+**Preliminary results from C++ client benchmark** (detailed benchmarks on dedicated hardware coming soon)
 
-**Features:**
-- 📊 Real-time dashboard with system metrics
-- 📈 Message throughput visualization
-- 🔍 Queue management and monitoring
-- 👥 Consumer group tracking
-- 💬 Message browser with trace timeline
-- 🔎 **Trace explorer for debugging distributed workflows**
-- 📉 Analytics and insights
-- 🌓 Dark/light theme support
+### Test Environment
+- **Hardware:** Apple M4 Air (all components on same machine, 10 processors available)
+- **Server:** 1 server, 4 workers, 95 total DB connections/threads
+- **Database:** PostgreSQL in Docker
+- **Client:** C++ benchmark tool (`benchmark/bin/benchmark`)
+
+### Results
+
+| Mode | Threads | Messages | Batch Size | Partitions | Queue Mode | Throughput | Bandwidth |
+|------|---------|----------|------------|------------|------------|------------|-----------|
+| **Producer** | 100 | 10K | 1 | 100 | single-queue | **1,431 msg/sec** | 0.41 MB/sec |
+| **Producer** | 100 | 10K | 1 | 100 | multi-queue | 527 msg/sec | 0.15 MB/sec |
+| **Producer** | 10 | 1M | 1,000 | 100 | single-queue | **62,927 msg/sec** | 18.00 MB/sec |
+| **Producer** | 10 | 1M | 1,000 | 100 | multi-queue | 49,663 msg/sec | 14.21 MB/sec |
+| **Producer** | 10 | 1M | 10,000 | 10 | single-queue | 30,351 msg/sec | 8.68 MB/sec |
+| **Consumer** | 10 | 1M | 1,000 | 100 | single-queue | **31,922 msg/sec** | 16.25 MB/sec |
+| **Consumer** | 10 | 1M | 10,000 | 10 | single-queue | **82,974 msg/sec** | 42.25 MB/sec |
+
+### Key Observations
+
+- ✅ **Batch size matters:** Larger batches (1,000-10,000) dramatically improve throughput
+- ✅ **Single-queue mode faster:** Better partition-level parallelism than multi-queue
+- ✅ **Consumer performance:** Scales well with batch size (82K msg/sec with 10K batches)
+- ✅ **Producer peak:** 62K msg/sec with optimal batch size (1,000)
+- ⚠️ **Small batches:** Performance drops significantly with batch=1 (lock contention)
+
+**Note:** All timing metrics exclude idle timeouts and measure actual message processing time (first message → last message).
+
+### Run Your Own Benchmarks
 
-**Quick Start:**
 ```bash
-cd webapp
-npm install
-npm run dev
-```
+cd benchmark
+make
 
-The dashboard will be available at `http://localhost:4000`
+# Producer
+./bin/benchmark producer --threads 10 --count 1000000 --batch 1000 --partitions 100 --mode single-queue
 
-See [webapp/README.md](webapp/README.md) for more details.
+# Consumer
+./bin/benchmark consumer --threads 10 --batch 1000 --partitions 100 --mode single-queue
+```
+
+See [benchmark/README.md](benchmark/README.md) for detailed usage.
 
-## Install server and configure it
+## Install the server and configure it
 
 ### Quick Start
 
@@ -296,7 +363,7 @@ Includes:
 
 You can use Queen directly from HTTP without the JS client.
 
-[Here the complete list of API endpoints](API.md)
+[Here the complete list of API endpoints](server/API.md)
 
 ## ⚠️ Known Issues & Roadmap
 
@@ -312,6 +379,7 @@ You can use Queen directly from HTTP without the JS client.
 
 
 ### Other TODO Items
-- retention jobs
-- auth
-- streaming engine
+- Mini streaming engine
+- Proper concurrency on clients 
+- Check client failover
+- Py client

package/client-js/client-v2/Queen.js

@@ -8,6 +8,8 @@ import { LoadBalancer } from './http/LoadBalancer.js'
 import { BufferManager } from './buffer/BufferManager.js'
 import { QueueBuilder } from './builders/QueueBuilder.js'
 import { TransactionBuilder } from './builders/TransactionBuilder.js'
+import { StreamBuilder } from './stream/StreamBuilder.js'
+import { StreamConsumer } from './stream/StreamConsumer.js'
 import { CLIENT_DEFAULTS } from './utils/defaults.js'
 import { validateUrl, validateUrls } from './utils/validation.js'
 import * as logger from './utils/logger.js'
@@ -355,6 +357,32 @@ export class Queen {
     return stats
   }
 
+  // ===========================
+  // Streaming API
+  // ===========================
+
+  /**
+   * Define a stream for windowed processing
+   * @param {string} name - Stream name
+   * @param {string} namespace - Stream namespace
+   * @returns {StreamBuilder}
+   */
+  stream(name, namespace) {
+    logger.log('Queen.stream', { name, namespace })
+    return new StreamBuilder(this.#httpClient, this, name, namespace)
+  }
+
+  /**
+   * Create a consumer for a stream
+   * @param {string} streamName - Stream name
+   * @param {string} consumerGroup - Consumer group
+   * @returns {StreamConsumer}
+   */
+  consumer(streamName, consumerGroup) {
+    logger.log('Queen.consumer', { streamName, consumerGroup })
+    return new StreamConsumer(this.#httpClient, this, streamName, consumerGroup)
+  }
+
   // ===========================
   // Graceful Shutdown
   // ===========================

package/client-js/client-v2/README.md

@@ -28,8 +28,12 @@ Welcome to Queen client! This is your friendly guide to mastering message queues
 
 First, install and import:
 
+```sh
+npm install queen-mq
+```
+
 ```javascript
-import { Queen } from './client-js/client-v2/index.js'
+import { Queen } from 'queen-mq'
 
 // Connect to your Queen server
 const queen = new Queen('http://localhost:6632')
@@ -1874,7 +1878,7 @@ process.on('SIGINT', async () => {
 You now know everything about Queen v2! 🎉
 
 **Additional resources:**
-- [API Documentation](../../API.md) - Complete API reference
+- [API Documentation](../../server/API.md) - Complete API reference
 - [Test Examples](../test-v2/) - 94 working test cases
 - [Architecture Guide](../../docs/) - Deep dive into Queen's internals
 

package/client-js/client-v2/builders/QueueBuilder.js

@@ -2,7 +2,13 @@
  * Queue builder for fluent API
  */
 
-import { generateUUID } from '../../utils/uuid.js'
+import { v7 as uuidv7 } from 'uuid';
+
+export const generateUUID = () => {
+  return uuidv7();
+};
+
+//import { generateUUID } from '../../utils/uuid.js'
 import { isValidUUID } from '../utils/validation.js'
 import { QUEUE_DEFAULTS, CONSUME_DEFAULTS, POP_DEFAULTS } from '../utils/defaults.js'
 import * as logger from '../utils/logger.js'

package/client-js/client-v2/builders/TransactionBuilder.js

@@ -48,12 +48,19 @@ export class TransactionBuilder {
   }
 
   queue(queueName) {
-    // Return a sub-builder for push operations
-    return {
+    // Return a sub-builder for push operations with partition support
+    let partition = null
+    
+    const subBuilder = {
+      partition: (partitionKey) => {
+        partition = partitionKey
+        return subBuilder
+      },
+      
       push: (items) => {
         const itemArray = Array.isArray(items) ? items : [items]
         
-        logger.log('TransactionBuilder.queue.push', { queue: queueName, count: itemArray.length })
+        logger.log('TransactionBuilder.queue.push', { queue: queueName, partition, count: itemArray.length })
 
         this.#operations.push({
           type: 'push',
@@ -68,16 +75,25 @@ export class TransactionBuilder {
               payloadValue = item
             }
 
-            return {
+            const result = {
               queue: queueName,
               payload: payloadValue
             }
+            
+            // Add partition if set
+            if (partition !== null) {
+              result.partition = partition
+            }
+
+            return result
           })
         })
 
         return this
       }
     }
+    
+    return subBuilder
   }
 
   async commit() {

package/client-js/client-v2/stream/StreamBuilder.js

@@ -0,0 +1,72 @@
+/**
+ * StreamBuilder - Fluent API for defining streams
+ */
+export class StreamBuilder {
+  constructor(httpClient, queen, name, namespace) {
+    this.httpClient = httpClient;
+    this.queen = queen;
+    this.config = {
+      name,
+      namespace,
+      source_queue_names: [],
+      partitioned: false,
+      window_type: 'tumbling',
+      window_duration_ms: 60000,       // 1 minute default
+      window_grace_period_ms: 30000,   // 30 seconds default
+      window_lease_timeout_ms: 60000   // 1 minute default
+    };
+  }
+
+  /**
+   * Set the source queues for this stream
+   * @param {string[]} queueNames - Array of queue names
+   */
+  sources(queueNames = []) {
+    this.config.source_queue_names = queueNames;
+    return this;
+  }
+  
+  /**
+   * Enable partitioned processing (group by partition_id)
+   */
+  partitioned() {
+    this.config.partitioned = true;
+    return this;
+  }
+
+  /**
+   * Configure tumbling time window
+   * @param {number} seconds - Window duration in seconds
+   */
+  tumblingTime(seconds) {
+    this.config.window_type = 'tumbling';
+    this.config.window_duration_ms = seconds * 1000;
+    return this;
+  }
+  
+  /**
+   * Configure grace period for late-arriving messages
+   * @param {number} seconds - Grace period in seconds
+   */
+  gracePeriod(seconds) {
+    this.config.window_grace_period_ms = seconds * 1000;
+    return this;
+  }
+  
+  /**
+   * Configure lease timeout
+   * @param {number} seconds - Lease timeout in seconds
+   */
+  leaseTimeout(seconds) {
+    this.config.window_lease_timeout_ms = seconds * 1000;
+    return this;
+  }
+
+  /**
+   * Define/create the stream on the server
+   */
+  async define() {
+    return this.httpClient.post('/api/v1/stream/define', this.config);
+  }
+}
+