Module client 

The client: the configuration, the call with the common contract’s retries (doc 19, section 18.4) and the nine operations of the surface (section 18.3).

Structs

Call

A call to the API, before it becomes HTTP.

Client

Config

ConsumeOptions

Delivery

What the handler receives: the whole message, the body (already deserialized in consume_typed; () in consume_with), delete (default true) and Delivery::change_visibility.

Error

The only kind of error of the connector: the API ErrorResponse, or a failure of the client itself (status zero and code client.network, client.timeout or client.invalid-config).

Message

A delivered message. The body always comes out as bytes (section 18.4).

Page

A page (Page<T>): the items and the cursor of the next one, if any.

PublishOptions

PublishResponse

Reply

The response of a call that succeeded.

Topic

TopicRequest

POST /topics. The connector sends only what was filled in; whatever does not apply to the type, the server refuses.

TopicUpdate

PATCH /topics/{topic}: only what was filled in is sent.

VisibilityResponse

Enums

ConsumeError

What consuming with a handler returns when it goes wrong: the API (or the client itself) or the handler.

Nullable

A PATCH field that accepts going back to the server default (null).

Constants

CONTRACT_VERSION

The version of the API contract this connector implements (UC-CNT-028).

DEFAULT_MAX_MESSAGES

One message at a time (the maxMessages of consuming with a handler).

DEFAULT_VISIBILITY_TIMEOUT

The invisibility of consuming with a handler, in seconds, which the renewal keeps.

DEFAULT_WAIT_TIME

The long polling of consuming with a handler, in seconds.

Type Aliases

HandlerError

The error the handler returns; its message is not deleted.