Crate hydracache_client_protocol 

Stable external client protocol primitives.

Release 0.49 starts the external-consumer surface by reserving a small, deterministic frame contract and golden fixtures. W1 expands the payload schema; W0 keeps the compatibility substrate intentionally narrow.

Modules

hibernate

Hibernate second-level cache contract types for external JVM providers.

java_migration

Java/Spring migration contract for legacy Hazelcast consumers.

Structs

BatchItemStatus

Per-item batch status.

BatchPutEntry

One batch put entry.

ClientContext

Optional context carried by every request.

ClientErrorEnvelope

Stable error envelope.

ClientFrame

A length-prefixed external client frame.

ClientRequestEnvelope

Client request envelope.

ClientResponseEnvelope

Client response envelope.

EntryEvent

IMap entry-event shaped cache signal.

EntryListenerContract

Executable contract for W6 listener semantics.

InvalidationEvent

Invalidation event streamed to remote near-caches.

Namespace

Namespace carried on the wire.

RegionId

Region id carried on the wire.

StructuredKey

Structured cache key made of reviewable segments.

SubscriptionWatermarkTracker

Region-scoped subscription state.

VersionHandshake

Negotiated protocol support window.

Watermark

Watermark used by remote near-cache repair.

Enums

CasExpectation

Expected value shape for single-key compare-and-set operations.

ClientErrorCode

Stable client error codes.

ClientProtocolError

External client protocol decode/encode errors.

ClientRequest

Client operations.

ClientResponse

Client responses.

ClientWireMessage

Wire messages carried inside ClientFrame payloads.

EntryEventKind

Entry-event kind exposed to Java/IMap-style listeners.

EntryEventProjection

Entry-event projection requested by Java/IMap-style listeners.

EntryEventSource

Source signal that can be projected into an IMap entry event kind.

LockConsistency

Linearizable-capable consistency labels for lock/CAS operations.

ReadConsistency

Remote read consistency labels.

RepairAction

Repair action selected for remote near-cache streams.

WriteConsistency

Remote write consistency labels.

Constants

LENGTH_PREFIX_BYTES

Bytes used by the unsigned length prefix.

LOCK_PROTOCOL_VERSION

First protocol version that carries the IMap/Fenced Lock operation family.

MIN_FRAME_BYTES

Smallest complete frame: length prefix plus version.

MIN_PROTOCOL_VERSION

First supported external client protocol version.

PROTOCOL_VERSION

Highest supported external client protocol version.

VERSION_BYTES

Bytes used by the protocol-version field inside the frame body.

Functions

ensure_supported_protocol_version

Reject an unsupported protocol version with the stable wire error.

protocol_version_supported

Return whether a request/response envelope version is in the supported window.

require_protocol_version

Reject an operation whose minimum version is newer than the negotiated version.