Package com.couchbase.client.core.msg

Class RequestContext

java.lang.Object
com.couchbase.client.core.cnc.AbstractContext
com.couchbase.client.core.CoreContext
com.couchbase.client.core.msg.RequestContext
All Implemented Interfaces:
Context
public class RequestContext
extends CoreContext
Additional context which might be attached to an individual Request.
Since:
2.0.0

  • Constructor Details

  • Method Details

    • dispatchLatency

      @Volatile public long dispatchLatency()
      Returns the duration of the dispatch phase if set.
      Returns:
      the duration of the dispatch phase.

    • dispatchLatency

      @Internal public RequestContext dispatchLatency​(long dispatchLatency)
      Allows to set the dispatch duration of the request.
      Parameters:
      dispatchLatency - the duration.

    • encodeLatency

      @Volatile public long encodeLatency()

    • encodeLatency

      @Internal public RequestContext encodeLatency​(long encodeLatency)

    • lastChannelId

      @Volatile public String lastChannelId()

    • lastChannelId

      @Internal public RequestContext lastChannelId​(String lastChannelId)

    • serverLatency

      @Volatile public long serverLatency()

    • serverLatency

      @Internal public RequestContext serverLatency​(long serverLatency)

    • logicallyComplete

      @Internal public RequestContext logicallyComplete()
      Signals that this request is completed fully, including streaming sections or logical sub-requests also being completed (i.e. observe polling).

    • retryAttempts

      public int retryAttempts()

    • retryReasons

      public Set<RetryReason> retryReasons()

    • lastRetryDuration

      public Duration lastRetryDuration()

    • logicallyCompletedAt

      public long logicallyCompletedAt()
      Returns the absolute nano time when the request got logically completed.

    • logicalRequestLatency

      public long logicalRequestLatency()
      Returns the request latency once logically completed (includes potential "inner" operations like observe calls).

    • incrementRetryAttempts

      @Internal public RequestContext incrementRetryAttempts​(Duration lastRetryDuration, RetryReason reason)

    • lastDispatchedTo

      public HostAndPort lastDispatchedTo()

    • lastDispatchedToNode

      @Internal public NodeIdentifier lastDispatchedToNode()

    • lastDispatchedTo

      @Internal public RequestContext lastDispatchedTo​(HostAndPort lastDispatchedTo)

    • lastDispatchedToNode

      @Internal public RequestContext lastDispatchedToNode​(NodeIdentifier lastDispatchedToNode)

    • lastDispatchedFrom

      public HostAndPort lastDispatchedFrom()

    • lastDispatchedFrom

      @Internal public RequestContext lastDispatchedFrom​(HostAndPort lastDispatchedFrom)

    • clientContext

      public Map<String,​Object> clientContext()
      Returns the custom user payload of this request.
      Returns:
      the payload if set.

    • clientContext

      @Internal public RequestContext clientContext​(Map<String,​Object> clientContext)
      Allows to set a custom payload for this request.
      Parameters:
      clientContext - the payload to set.

    • request

      public Request<? extends Response> request()

    • injectExportableParams

      public void injectExportableParams​(Map<String,​Object> input)
      Description copied from class: AbstractContext
      This method needs to be implemented by the actual context implementations to inject the params they need for exporting.
      Overrides:
      injectExportableParams in class CoreContext
      Parameters:
      input - pass exportable params in here.

    • cancel

      @Uncommitted public RequestContext cancel()
      Allows to cancel the attached Request from anywhere in the code.

      If the operation is already completed (either successfully or failed) this is an operation without side-effect.