akkoma/lib/pleroma/reverse_proxy/client.ex

21 lines
759 B
Elixir
Raw Normal View History

# Pleroma: A lightweight social networking server
# Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
# SPDX-License-Identifier: AGPL-3.0-only
2019-07-09 16:54:13 +00:00
defmodule Pleroma.ReverseProxy.Client do
2020-02-11 07:12:57 +00:00
@type status :: pos_integer()
@type header_name :: String.t()
@type header_value :: String.t()
@type headers :: [{header_name(), header_value()}]
@callback request(atom(), String.t(), headers(), String.t(), list()) ::
{:ok, status(), headers(), reference() | map()}
| {:ok, status(), headers()}
2019-07-09 16:54:13 +00:00
| {:ok, reference()}
| {:error, term()}
2020-02-11 07:12:57 +00:00
@callback stream_body(map()) :: {:ok, binary(), map()} | :done | {:error, atom() | String.t()}
2019-07-09 16:54:13 +00:00
@callback close(reference() | pid() | map()) :: :ok
end