Timeout (p.awskit.0.2.0.doc.awskit.Awskit.Timeout)

Sourcetype phase = [

| `Connect
| `Attempt
| `Operation
| `Request_body
| `Response_body
| `Drain

]

Named timeout phases a runtime may enforce. `Operation is scoped to one runtime transport operation. For service calls that retry, the operation timer is applied independently to each attempt and does not include retry sleeps.

Sourcetype policy

Timeout policy for runtime adapters. None means no timeout for that phase.

Source

val create : 
  ?connect:Ptime.Span.t ->
  ?attempt:Ptime.Span.t ->
  ?operation:Ptime.Span.t ->
  ?request_body:Ptime.Span.t ->
  ?response_body:Ptime.Span.t ->
  ?drain:Ptime.Span.t ->
  unit ->
  (policy, Error.t) result

Build a timeout policy. Present spans must be positive.

Source

val create_exn : 
  ?connect:Ptime.Span.t ->
  ?attempt:Ptime.Span.t ->
  ?operation:Ptime.Span.t ->
  ?request_body:Ptime.Span.t ->
  ?response_body:Ptime.Span.t ->
  ?drain:Ptime.Span.t ->
  unit ->
  policy

Like create, but raises Error.Awskit_error carrying the structured validation error on validation failure.

Sourceval default : policy

Conservative default policy. Currently enables connect and drain timeouts and leaves the other phases disabled.

Sourceval disabled : policy

Policy with all timeout phases disabled.

Sourceval span : policy -> phase -> Ptime.Span.t option

Return the configured span for a phase.