| JVM | Platform | Status |
|---|---|---|
| OpenJDK (Temurin) Current | Linux |  |
| OpenJDK (Temurin) LTS | Linux |  |
| OpenJDK (Temurin) Current | Windows |  |
| OpenJDK (Temurin) LTS | Windows |  |
An API specification for simple RPC clients.
Many io7m projects implement some form of RPC client. The Hibiscus API is an attempt to define some common interface types so that unrelated projects nevertheless end up with a consistent look and feel across client implementations.
- A
Configurationis passed to aClientFactoryto produce aClient. - The
ClientsendsConnectionParametersto the server to log in. - The
Serversends backMessagesindicating if the login succeeded or failed. - Assuming success, the
ClientsendsMessagesto the server to perform operations. - The
ServersendsMessagesin response toMessages.
Clients conform to a simple state machine:
- Clients begin in the
DISCONNECTEDstate. - A
Loginoperation moves the client into theCONNECTINGstate. - If the login succeeds, the client moves to the
CONNECTEDstate after passing through theCONNECTION_SUCCEEDEDstate. - If the login fails, the client moves to the
DISCONNECTEDstate after passing through theCONNECTION_FAILEDstate.
In the CONNECTED state, the client can:
- Disconnect, moving to the
DISCONNECTEDstate. - Send messages, remaining in the
CONNECTEDstate.
A client maintains an internal Transport that performs the actual communication.
A Transport represents an object that can be used to read and write messages. A Transport exposes the following operations:
receive: Read a message from the transport.sendAndForget: Write a message to the transport, potentially discarding any response that might come back.sendAndWait: Write a message to the transport and wait for a response to come back.send: Write a message to the transport but do not wait for a response to come back. The response can be fetched later withreceive.
The package includes multiple example transports:
- EUDP0Transport - A UDP transport
- ETCP0Transport - A TCP transport
- EHTTP0Transport - An HTTP transport