Skip to main content

Module api

Module api 

Source
Expand description

The routes the screens call (doc 34, section 3), typed, over Client::call: each ApiCall becomes a taba_client::Call and each reply is read into a small struct. Nothing is added to taba-client.

Structs§

Backup
The S3 backup of a node (GET /nodes/{id}/backup).
ClusterStatus
Condition
Drain
GET, POST and DELETE /nodes/{id}/drain.
FlushNode
What one node reported on a backup flush.
FlushReport
Me
Who the token is (GET /auth/me).
Missing
A node that did not answer in a consolidated read.
NodeInfo
An item of GET /nodes.
NodeStatus
One member of GET /cluster/status: the node, and its NodeStatus when it answered.
Nodes
PublishSpec
What the publish form asks to send.
Published
What a publication answered: the id (queue), whether it was a duplicate (FIFO) and how many queues matched (distributor).
StopReport
Token
A token of GET /tokens (never with the secret).
TokenPage
A page of tokens and where the next one starts.
Topic
A topic of GET /topics (doc 16): its definition, as the server keeps it.
TopicNumbers
The numbers of one topic in the list (GET /stats/topics). A distributor has no queue, so no numbers.
TopicPage
A page of topics and where the next one starts.
TopicSample
One reading of a queue for its charts (GET /stats/topics/{name}): the counts, the rates, the age of the oldest message and that of the largest groups.
TopicStatsPage
A page of statistics and where the next one starts.

Enums§

ApiCall
What a call is for; it comes back with the reply so update knows what to do with it.
Severity
warning or critical; the order is the severity.

Constants§

RECEIVE_HOLD_SECS
How long the messages of a reading stay invisible to the others, in seconds.
RECEIVE_MAX
How many messages one reading takes.

Functions§

parse_backup
parse_cluster_status
parse_drain
parse_flush
The reply of a flush of one node (the report itself) or of the cluster (a nodes list).
parse_me
parse_nodes
parse_pruned
How many messages a prune removed.
parse_published
parse_received
The messages of a reading (GET /topics/{name}/messages).
parse_stop
parse_token_created
The reply of POST /tokens: the token and its secret, which exists only here.
parse_tokens
parse_topic
The reply of POST /topics and PATCH /topics/{name}: the topic as it is now.
parse_topic_sample
parse_topic_stats
parse_topics