trait SyncClient extends SyncClientCompat with HttpClientFactory[SyncClient] with AutoCloseable

A standard blocking http client interface

Linear Supertypes
AutoCloseable, HttpClientFactory[SyncClient], SyncClientCompat, AnyRef, Any
Known Subclasses
SyncClientImpl
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SyncClient
  2. AutoCloseable
  3. HttpClientFactory
  4. SyncClientCompat
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def build(newConfig: HttpClientConfig): SyncClient

    Create a new client sharing the same underlying http client

    Create a new client sharing the same underlying http client

    Attributes
    protected
    Definition Classes
    HttpClientFactory
  2. abstract def channel: HttpChannel
    Attributes
    protected
  3. abstract def config: HttpClientConfig
    Definition Classes
    SyncClient → HttpClientFactory

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. macro def call[Req, Resp](request: Request, requestContent: Req): Resp
    Definition Classes
    SyncClientCompat
  6. def callInternal[Req, Resp](req: Request, requestSurface: Surface, responseSurface: Surface, requestContent: Req): Resp
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def close(): Unit
    Definition Classes
    SyncClient → AutoCloseable
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. macro def readAs[Resp](request: Request): Resp

    Read the response as a specified type

    Read the response as a specified type

    returns

    a response translated to the specified type

    Definition Classes
    SyncClientCompat
    Exceptions thrown

    HttpClientException if failed to read or process the response

  18. def readAsInternal[Resp](req: Request, responseSurface: Surface): Resp
  19. def rpc[Req, Resp](method: RPCMethod, requestContent: Req): Resp

    Send an RPC request (POST) and return the RPC response.

    Send an RPC request (POST) and return the RPC response. This method will throw RPCException when an error happens

    Exceptions thrown

    RPCException when RPC request fails

  20. def send(req: Request, context: HttpClientContext = HttpClientContext.empty): Response

    Send an HTTP request and get the response.

    Send an HTTP request and get the response. It will throw an exception for non-successful responses. For example, when receiving non-retryable status code (e.g., 4xx), it will throw HttpClientException. For server side failures (5xx responses), this continues request retry until the max retry count.

    If it exceeds the number of max retry attempts, HttpClientMaxRetryException will be thrown.

    Exceptions thrown

    HttpClientException for non-retryable error is occurred

    HttpClientMaxRetryException if max retry reaches

  21. def sendSafe(req: Request, context: HttpClientContext = HttpClientContext.empty): Response

    Send an HTTP request and returns a response (or the last response if the request is retried).

    Send an HTTP request and returns a response (or the last response if the request is retried). Unlike send(), this method returns a regular Http Response object even for non-retryable responses (e.g., 4xx error code). For retryable responses (e.g., 5xx) this continues retry until the max retry count.

    After reaching the max retry count, it will return a the last response even for 5xx status code.

  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def withCircuitBreaker(filter: (CircuitBreaker) ⇒ CircuitBreaker): SyncClient
    Definition Classes
    HttpClientFactory
  28. def withClientFilter(filter: RxHttpFilter): SyncClient
    Definition Classes
    HttpClientFactory
  29. def withClientFilter(filter: HttpClientFilter): SyncClient
    Definition Classes
    HttpClientFactory
  30. def withConfig(filter: (HttpClientConfig) ⇒ HttpClientConfig): SyncClient
    Definition Classes
    HttpClientFactory
  31. def withConnectTimeout(duration: Duration): SyncClient
    Definition Classes
    HttpClientFactory
  32. def withReadTimeout(duration: Duration): SyncClient
    Definition Classes
    HttpClientFactory
  33. def withRequestFilter(requestFilter: (Request) ⇒ Request): SyncClient
    Definition Classes
    HttpClientFactory
  34. def withRetryContext(filter: (RetryContext) ⇒ RetryContext): SyncClient
    Definition Classes
    HttpClientFactory

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AutoCloseable

Inherited from HttpClientFactory[SyncClient]

Inherited from SyncClientCompat

Inherited from AnyRef

Inherited from Any

Ungrouped