ExIpfs.ApiStreamingClient (Elixir IPFS v0.2.1)

Copy Markdown View Source

An http client to handle streaming data from the IPFS API.

Summary

Functions

new(pid, url, timeout \\ :infinity, query_options \\ [])

Starts a stream client and returns a reference to the client.

Functions

new(pid, url, timeout \\ :infinity, query_options \\ [])

@spec new(pid(), binary(), :infinity | integer(), list()) ::
  {:ok, pid()} | {:error, term()}

Starts a stream client and returns a reference to the client.

Parameters

  • pid: The pid to stream the data to.
  • url: The full RPC URL to stream from.
  • timeout: Finch receive_timeout in milliseconds or :infinity.
  • query_options: Keyword list of query options merged into the URL query string.