View Source ExIpfs.ApiStreamingClient (Elixir IPFS v0.1.1)

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

Link to this section Summary

Functions

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

Link to this section Functions

Link to this function

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

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

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

parameters

Parameters

  • pid: The pid to stream the data to.
  • url: The url to stream the data from.
  • timeout: The timeout for the stream. Defaults to infinity.
  • query_options: A list of query options to add to the url.