GALANTHUS / ABI FUNCTION REFERENCE
gln_describe_continuation
Declared in <galanthus/c_api/gln_capi.h>.
GLN_API gln_status_t GLN_CALL gln_describe_continuation(
gln_continuation_t* in_continuation,
char** out_describe_json,
gln_error_t* out_error);
Purpose
Serializes continuation metadata to a caller-owned JSON string returned through out_describe_json.
Use this when the caller needs phase-specific details or operator-facing continuation metadata.
Return
Returns GLN_OK on success and a non-OK gln_status_t value on failure.
| Type | Nullability | Ownership |
|---|---|---|
gln_status_t | value | value |
Parameters
| Name | Direction | Type | Nullability | Ownership |
|---|---|---|---|---|
in_continuation | input | gln_continuation_t* | nonnull | borrowed |
out_describe_json | output | char** | nonnull | transferred_out |
out_error | output | gln_error_t* | nullable | caller_allocated_output |
JSON Fields
The JSON includes backend, operation_kind, original_request_json, created_at_unix_ms, cached_bpd_present, cached_upd_present, and a progress object.
For FinTS continuations, progress.phase is tan_required, decoupled_pending, or vop_confirmation. progress.follow_up_kind is null for the continuation producers implemented by this C API. progress.retry_after_seconds is the saved decoupled polling interval when the continuation carries one, otherwise 0.
Use progress.phase == "vop_confirmation" to route a saved continuation to VoP confirmation UI instead of TAN entry.
Ownership
out_describe_json receives a caller-owned string. Release it with gln_release_string.
On failure, out_error is populated when provided. Release that populated direct error slot with gln_release_error before reusing it for another call.
See Continuations for how description relates to inspect and resume.