Fl4m3Ph03n1x

Fl4m3Ph03n1x

Background

I am trying to build an OTP compliant app using supervisors. However I am having trouble interpreting a part of the documentation.

Docs

The documentation states that Supervisor.start_link/2 returns the following:

{:ok, pid}
| :ignore 
| {:error, {:already_started, pid} | {:shutdown,term} | [term]}

Problem

The problem is that even though the documentation specifies when start_link returns {:ok, pid} and {:error, any} it doesn’t specify when it returns :ignore, leaving me to think that it can never return :ignore.

Question

In which cases does Supervisor.start_link/2 return :ignore?

Showing Posts 1 to 10

peerreynders

peerreynders

If I understand it correctly in module-based supervisors.

Fl4m3Ph03n1x

Fl4m3Ph03n1x OP

Yes, but those use Supervisor.start_link/3 and Supervisor.init/2. In short, they don’t use Supervisor.start_link/2.

LostKobrakai

LostKobrakai

If init/1 returns :ignore then start_link will return :ignore. This is useful if you want to selectively start certain parts of your supervision tree / workers.

It’s explicitly documented here GenServer — Elixir v1.20.2

peerreynders

peerreynders

The init/1 callback is allowed to return {:ok, {:supervisor.sup_flags(), [:supervisor.child_spec()]}} | :ignore

[Erlang] Designing for Scalability with Erlang/OTP (O'Reilly) p.81:

If the startup fails but you do not want to affect other processes started by the same supervisor, return ignore.

p.178

The init/1 callback function normally returns the whole tuple comprising the restart tuple and a list of child specifications. But if it instead returns ignore, the supervisor terminates with reason normal.

Fl4m3Ph03n1x

Fl4m3Ph03n1x OP

Yes, but how is any of this related to Supervisor.start_link/2?

I don’t care what the children may or may not return. It is specified how the Supervisor.start_link/2 function behaves for those scenarios.

What I really want to know is when Supervisor.start_link/2 returns :ignore.
In what circumstances?

LostKobrakai

LostKobrakai

A supervisor has an init/1 callback as well as workers have. So both actually work the same in regards to returning :ignore from that callback.

Fl4m3Ph03n1x

Fl4m3Ph03n1x OP

Forgive me for my ignorance, but I still don’t see how any of this affects the return value of Supervisor.start_link/2

If a child returns an error, the supervisor returns one.
If a child returns :ok or :ignore, the supervisor returns :ok.

So … when really?

peerreynders

peerreynders

A supervisor can be a child of a supervisor.

LostKobrakai

LostKobrakai

When the supervisor itself (it’s init/1) returns :ignore then Supervisor.start_link returns :ignore.

E.g.

defmodule MyApp.Supervisor do
  # Automatically defines child_spec/1
  use Supervisor

  def start_link(init_arg) do
    Supervisor.start_link(__MODULE__, init_arg, name: __MODULE__)
  end

  @impl true
  def init(_init_arg) do
    :ignore
  end
end

Supervisor.start_link(MyApp.Supervisor, [])
# :ignore
Fl4m3Ph03n1x

Fl4m3Ph03n1x OP

Excellent example!
But where is that code is the usage of Supervisor.start_link/2 ?


EDIT: ignore me, I get it now.

Thanks for the help!

Where Next? Top

Trending in Questions Top

itzmidinesh
Hi all, I’m working on a Phoenix project where I need to make external HTTP requests and I’m trying to choose between Req and HTTPoison....
New
yarrichar
I’m very new to Elixir, so sorry if this is a silly question: I am wondering what happens to the mailbox of a process when the machine i...
New
Hellowman
Hello everyone! I am new to coding with Elixir/Erlang. And i am looking for some utilities for fuzzing testing like AFL++. Does anyone ...
New
pragdave
How do I tell Hologram not to escape HTML when substituting into templates? {Textile.render(@product.long_description)} escapes the HTM...
New
Fl4m3Ph03n1x
Background When trying to execute mix release on a Windows 11 machine for a Phoenix project I get the following error: * assembling mark...
New
mandar1045
I load tested a plain Phoenix chat app backed by Postgres with 100 million messages in it, everything on default settings, to see what br...
New
rlipscombe
I’d like to create a file with 600 permissions (rw-------), but there’s a race condition if I create it and then change the permissions. ...
New

Other Trending Topics Top

aaronrussell
Omni 2.0 is out. Omni is a universal Elixir client for LLM APIs: text generation, tool use, structured output and decisions through one A...
New
dominicletz
Hey there, I haven’t seen a list of useful Elixir specific skills for the popular AI tools yet so I’m starting one here with my first. ...
New
raa-ziq
Hi everyone :waving_hand: I wanted to share something I’ve been building — NowBlind, a random chat app designed to help people discover ...
New
mudasobwa
I fully migrated to my own harness from Anthropic/Gemini and I think it’s time to share it. Welcome DSH, the DeepSeek Harness, fully writ...
New
OndrejValenta
(I just needed to vent somewhere and LinkedIn is full of hope, or hype, I’m not sure which exactly) AI dream has many faces, but general...
New
kip
Localize is the next generation localisation library for Elixir. Think of it as ex_cldr version 3.0. The first version will be released ...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews