farmbot v6.4.1 Farmbot.HTTP View Source
Wraps an HTTP Adapter.
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
Download a file to the filesystem
HTTP GET request
Same as get/3 but raises
Invoked when the server is started. start_link/3 or start/3 will
block until it returns
HTTP POST request
Same as post/4 but raises
Make an http request. Will not raise.
method- can be any http verburl- fully formatted url or an api slug.body- body can be any of:- binary
{:multipart, [{binary_key, binary_value}]}
- headers -
[{binary_key, binary_value}] opts - Keyword opts to be passed to adapter (hackney/httpoison)
file- option to be passed if the output should be saved to a file
Same as request/5 but raises
Start HTTP Services
Upload a file to FB storage
Link to this section Functions
Returns a specification to start this module under a supervisor.
See Supervisor.
Download a file to the filesystem.
get(url(), headers(), opts()) ::
{:ok, Farmbot.HTTP.Response.t()} | {:error, term()}
HTTP GET request.
get!(url(), headers(), opts()) :: Farmbot.HTTP.Response.t() | no_return()
Same as get/3 but raises.
Invoked when the server is started. start_link/3 or start/3 will
block until it returns.
args is the argument term (second argument) passed to start_link/3.
Returning {:ok, state} will cause start_link/3 to return
{:ok, pid} and the process to enter its loop.
Returning {:ok, state, timeout} is similar to {:ok, state}
except handle_info(:timeout, state) will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate} is similar to
{:ok, state} except the process is hibernated before entering the loop. See
c:handle_call/3 for more information on hibernation.
Returning :ignore will cause start_link/3 to return :ignore and the
process will exit normally without entering the loop or calling c:terminate/2.
If used when part of a supervision tree the parent supervisor will not fail
to start nor immediately try to restart the GenServer. The remainder of the
supervision tree will be (re)started and so the GenServer should not be
required by other processes. It can be started later with
Supervisor.restart_child/2 as the child specification is saved in the parent
supervisor. The main use cases for this are:
- The
GenServeris disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor. Likely this approach involves callingSupervisor.restart_child/2after a delay to attempt a restart.
Returning {:stop, reason} will cause start_link/3 to return
{:error, reason} and the process to exit with reason reason without
entering the loop or calling c:terminate/2.
Callback implementation for GenServer.init/1.
HTTP POST request.
Same as post/4 but raises.
request(method(), url(), body(), headers(), opts()) ::
{:ok, Farmbot.HTTP.Response.t()} | {:error, term()}
Make an http request. Will not raise.
method- can be any http verburl- fully formatted url or an api slug.body- body can be any of:- binary
{:multipart, [{binary_key, binary_value}]}
- headers -
[{binary_key, binary_value}] opts - Keyword opts to be passed to adapter (hackney/httpoison)
file- option to be passed if the output should be saved to a file.
request!(method(), url(), body(), headers(), opts()) :: Farmbot.HTTP.Response.t() | no_return()
Same as request/5 but raises.
Start HTTP Services.
Upload a file to FB storage.