commflow
  • English

      • Feature Overview

      Planned product guide: Choose request, SSE, RPC, or socket by the communication task you need to complete. commflow@0.0.2 only provides the manifest API; runnable APIs are listed separately in Current Release Quick Start.

      Feature Matrix

      FeatureCommunication modelUser entryMain capabilities
      requestone-shot request/responseRequestHTTP calls, timeout, numeric retry, targets, headers, context, hooks.
      SSEserver-to-client event streamSSESubscribe, handle messages, reconnect, close, cleanup.
      RPCprocedure callRPCProcedure calls, arguments, returns, resolver, metadata, typed contracts.
      socketlong-lived bidirectional messagesSocketconnect, send, on, heartbeat, reconnect, backpressure, close.
      VextJS adapterframework integrationVextJS AdoptionCompare app.fetch behavior and verify a compatible migration.

      Choose By Scenario

      User scenarioRecommended featureReason
      Call REST APIs or internal HTTP servicesrequestKeeps HTTP semantics and fits one-shot calls.
      Subscribe to job progress, notifications, state updatesSSEOne-way event streams are simple and stable.
      Call services by procedure nameRPCBusiness code can focus on procedure instead of URL/method.
      Chat, rooms, realtime collaborationsocketNeeds bidirectional long-lived events.
      Replace VextJS fetch orchestrationrequest + VextJS adapterrequest is the first shared communication core.

      Shared Capability Truth Matrix

      CapabilityrequestSSERPCsocketUser meaning
      Service addressbaseURL / targetbaseURL + topic/pathresolver / endpointurlNames differ, but every transport must locate a service.
      timeoutPer-request timeoutconnect or first-message timeoutPer-procedure timeoutconnect/heartbeat timeoutSSE/socket do not treat the whole connection as one request timeout.
      retry / reconnectnumeric retry + retryDelayreconnect policyretry by procedure kindreconnect policyrequest/RPC retry calls; SSE/socket reconnect connections.
      headers / authHTTP headersheaders or token providermetadata / headersauth providerLong-lived auth needs refresh and reconnect handling.
      context / metadatacontextProvidersubscription metadata, Last-Event-IDper-call metadataconnection metadatarequestId/trace are propagated, not invented by the core.
      hooks / eventsbeforeRequest hooks and observersopen/message/error/reconnect/closeinvoke/stream/error hooksconnect/message/drain/reconnect/closeLifecycle events remain protocol-specific.
      structured errortimeout/network/aborted/config/hookconnection, parse, reconnect exhaustedtransport/protocol/business/contractnetwork, auth, protocol, manual closeError kinds must guide retry, reconnect, or stop behavior.

      Transport Scenario Coverage Matrix

      TransportTriggerExecuteStateFailureRecoveryObserve
      requestcall method/pathreturn Response or throw structured errorpending / fulfilled / failed / abortedHTTP failure, timeout, network, config, hookidempotent retry or business fallbackhooks, duration, requestId
      SSEsubscribe topic/pathcontinuously consume eventsconnecting / open / reconnecting / closed / faileddisconnect, 401, parse failure, reconnect exhaustedLast-Event-ID + reconnectopen/message/error/reconnect/close
      RPCcall procedurereturn result or stream chunkpending / streaming / fulfilled / failed / cancelledtransport, protocol, business, contractcautious query retry; streams do not replay by defaultprocedure, metadata, retry, duration
      socketexplicit connectsend/on bidirectional messagesconnecting / open / reconnecting / closing / closednetwork, auth, protocol, backpressure, orderingreconnect, resubscribe, queue handlingconnect/message/drain/reconnect/close

      Chapter Entry Points

      1. Guide entry: Product Guide (Planned APIs)
      2. HTTP calls: Request
      3. Server events: SSE
      4. Procedure calls: RPC
      5. Long-lived messages: Socket
      6. Configuration: Configuration
      7. Error recovery: Errors And Retries
      8. VextJS: VextJS Adoption

      Current Release Boundary

      commflow@0.0.2 currently only provides the manifest API. Run the current release with Current Release Quick Start, and look up exports in Manifest API.