Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.08 KB

README.md

File metadata and controls

30 lines (24 loc) · 1.08 KB

concord-client

A work-in-progress high-level wrapper for Concord API. Uses tokio for async I/O.

Depends on reqwest and tokio-tungstenite for HTTP and WebSocket support, respectively.

Status

  • basic QueueClient implementation:
    • maintains a WebSocket connection to the Concord server
    • provides high-level API like next_process and next_command
    • graceful shutdown
    • automatic re-connection on errors
    • timeouts
  • basic ApiClient implementation:
    • can update process status
    • download process state
    • create and update log segments
    • timeouts
    • everything else

Code Conventions

  • warn! and error! messages should include how likely the error is a bug: (possibly a bug), (likely a bug), etc. ApiError messages, however, should not include this information, as the interpretation of the error is up to the caller.