object ClientStub
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- ClientStub
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply[Alg[_[_, _, _, _, _]], F[_]](service: Service[Alg], channel: Channel[F])(implicit arg0: Monadic[F]): Either[UnsupportedProtocolError, Impl[F]]
Creates a JSON-RPC client implementation for a Smithy service.
Creates a JSON-RPC client implementation for a Smithy service.
Given a Smithy
Service[Alg]
and a JSON-RPC communicationChannel[F]
, this constructs a fully functional client that translates method calls into JSON-RPC messages sent over the channel.Before constructing the client, this method checks whether the given Smithy service supports the JSON-RPC protocol. If not, it returns a
Left(UnsupportedProtocolError)
.Supports both standard request-response and fire-and-forget notification endpoints.
Usage:
val stubOrError: Either[UnsupportedProtocolError, MyService[IO]] = ClientStub(myService, myChannel) val result: IO[Unit] = stubOrError match { case Right(stub) => stub.hello("world").void case Left(error) => IO.raiseError(new RuntimeException(error.toString)) }
- service
Smithy service definition
- channel
JSON-RPC communication channel
- returns
Either an error if the protocol is unsupported or a compiled client implementation
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)