pubsub

Category: Queues and messaging
Wire type: pubsub
Construction: CREATE

Queue and messaging types provide ordering, delivery, streaming, and publication semantics.

Create a value

Use the top-level CREATE command to initialize this structured value. The example shows its construction options.

amaquet-cli -uri amaquet://127.0.0.1:13378 CREATE '{"key":"example:pubsub","type":"pubsub","options":{}}'

Construction options

Example CREATE options: {}. Omitted fields use server defaults.

Supported operations

PUBLISH, STATS.

See the complete operation contract for exact arguments, defaults, results, and whether a listed GET is the top-level key command or a type-specific OP. It also identifies read-only operations and documents validation, lazy maintenance, and key-version behavior.

Operation payloads

The following examples use the public amaquet-cli JSON command format. Replace example:pubsub with the key used by your application.

Construction payloads

Use the payload below to initialize this type before issuing reads or type-specific operations.

CREATE

This payload initializes the value and must complete before its type-specific operations are used.

{
  "key": "example:pubsub",
  "type": "pubsub",
  "options": {}
}

Operations

Each request uses the OP envelope. The response is the type-specific value described in the complete operation contract.

OP PUBLISH

Accepts channel, nested value and returns number of server subscriber buffers that accepted the message.

{
  "key": "example:pubsub",
  "operation": "PUBLISH",
  "args": {
    "channel": "events",
    "value": {
      "type": "utf8_string",
      "value": "ping"
    }
  }
}

OP STATS

Takes no arguments and returns cumulative published, delivered, and dropped counts.

{
  "key": "example:pubsub",
  "operation": "STATS",
  "args": {}
}

Top-level read payload

GET reads the current value without changing it:

{
  "key": "example:pubsub"
}

Key lifecycle payloads

These commands apply to the key regardless of its registered type:

• TYPE: {"key":"example:pubsub"} — returns the wire type.
• EXISTS: {"key":"example:pubsub"} — reports whether the key exists.
• EXPIRE: {"key":"example:pubsub","ttl_ms":5000} — assigns a five-second TTL.
• TTL: {"key":"example:pubsub"} — returns the remaining TTL in milliseconds.
• PERSIST: {"key":"example:pubsub"} — removes the TTL.
• DEL: {"keys":["example:pubsub"]} — deletes the key.

For defaults, validation, result shapes, and persistence classification, see the complete operation contract.

Key lifecycle

The key participates in TYPE, EXISTS, TTL, EXPIRE, PERSIST, and DEL. Top-level GET returns the type’s direct public value or a synchronized snapshot.