Húzz egy számot Deluxe

GenServer

A GenServer (általános szerver) egy viselkedés, amely elvonatkoztatja az Elixir-folyamatok közötti gyakori kliens-szerver interakciókat.

Emlékszel a receive-ciklusra, amikor a folyamatokról tanultunk? A GenServer viselkedés elvonatkoztatásokat nyújt az ilyen ciklusok megvalósításához, és ahhoz, hogy üzeneteket váltsunk egy ilyen ciklust futtató folyamattal. Megkönnyíti az állapot megőrzését és az aszinkron kód futtatását.

A GenServer viselkedés egy kötelező visszahívást definiál, az init/1-et, valamint néhány érdekes opcionális visszahívást: handle_call/3, handle_cast/2 és handle_info/3. A GenServer-t használó kliensek nem hivatottak közvetlenül meghívni ezeket a visszahívásokat. Ehelyett a GenServer modul olyan függvényeket biztosít, amelyekkel a kliensek kommunikálhatnak egy GenServer-folyamattal.

Gyakran egyetlen modul definiálja egyszerre a kliens API-t, azaz a függvények egy halmazát, amelyeket az Elixir-alkalmazásod más részei meghívhatnak, hogy kommunikáljanak ezzel a GenServer-folyamattal, és a szerver-visszahívások implementációit, amelyek ennek a GenServer-nek a logikáját tartalmazzák.

Nézzünk meg először egy egyszerű példát a GenServer-re, aztán megtanuljuk, hogy mit jelentenek az egyes visszahívások.

Példa

Ez egy példaszerver, amely válaszolni tud egy bosszantó utas ismétlődő faggatásaira egy hosszú autós út során, pontosabban a kérdésre: „megérkeztünk már?”. Nyilvántartja, hányszor tették fel ezt a kérdést, és egyre ingerültebb válaszokat ad.

defmodule AnnoyingPassengerAutoresponder do
  use GenServer
  # Client API

  def start_link(init_arg) do
    GenServer.start_link(__MODULE__, init_arg)
  end

  def are_we_there_yet?(pid) do
    GenServer.call(pid, :are_we_there_yet?)
  end

  # Server callbacks

  @impl GenServer
  def init(_init_arg) do
    # the initial count of questions asked is always 0
    state = 0
    {:ok, state}
  end

  @impl GenServer
  def handle_call(:are_we_there_yet?, _from, state) do
    reply =
      cond do
        state <= 3 -> "No."
        state <= 10 -> "I told you #{state} times already. No."
        true -> "..."
      end

    # increase the count of questions asked
    new_state = state + 1
    # reply to the caller
    {:reply, reply, new_state}
  end
end

Visszahívások

init/1

Egy szervert a GenServer.start/3 vagy a GenServer.start_link/3 meghívásával lehet elindítani. Ezen függvények közötti különbségről a linkek fogalomban tanultunk.

Ez a két függvény:

• Első argumentumként egy olyan modult fogad, amely implementálja a GenServer viselkedést.
• Második argumentumként bármit elfogad, amit init_arg-nak nevezünk. Ahogy a neve is sugallja, ezt az argumentumot kapja meg az init/1 visszahívás.
• Elfogad egy opcionális harmadik argumentumot is, amely haladó beállításokat tartalmaz a folyamat futtatásához; ezeket most nem tárgyaljuk.

Ha egy szervert a GenServer.start/3 vagy a GenServer.start_link/3 meghívásával indítasz el, az blokkoló módon hívja meg az init/1 visszahívást. Az init/1 visszatérési értéke dönti el, hogy a szerver sikeresen elindulhat-e.

Az init/1 visszahívás általában a következő értékek egyikét adja vissza:

• {:ok, state}. A szerver elindítja a receive-ciklusát, és a state-et használja kezdő állapotként. A state bármilyen típusú lehet.
• {:stop, reason}. A reason bármilyen típusú lehet. A szerver nem indítja el a receive-ciklusát. A folyamat a megadott okkal lép ki.

Vannak ennél haladóbb lehetőségek is, amelyeket most nem tárgyalunk.

Ha a szerver receive-ciklusa elindul, a GenServer.start/3 és a GenServer.start_link/3 függvény egy {:ok, pid} tuple-t ad vissza. Ellenkező esetben {:error, reason}-t adnak vissza.

handle_call/3

Egy választ igénylő üzenetet a GenServer.call/2-vel küldhetsz egy szerverfolyamatnak. Ez a függvény első argumentumként egy futó szerverfolyamat pid-jét várja, másodikként pedig az üzenetet. Az üzenet bármilyen típusú lehet.

A handle_call/3 visszahívás felelős a szinkron üzenetek kezeléséért és megválaszolásáért. Három argumentumot kap:

1. message - a GenServer.call/2 második argumentumaként átadott érték.
2. from - annak a folyamatnak a pid-je, amely a GenServer.call/2-t hívja. Legtöbbször figyelmen kívül hagyható ez az argumentum.
3. state - a szerver aktuális állapota. Ne feledjük, hogy a kezdőértékét az init/1 visszahívásban állítottuk be.

A handle_call/3 visszahívás általában egy 3-as tuple-t ad vissza: {:reply, reply, state}. Ez azt jelenti, hogy a tuple második eleme, a reply, amely bármilyen típusú lehet, visszaküldésre kerül a hívónak. A tuple harmadik eleme, a state, a szerver új állapota az üzenet kezelése után.

Vannak ennél haladóbb lehetőségek is, amelyeket most nem tárgyalunk.

handle_cast/2

Egy választ nem igénylő üzenetet a GenServer.cast/2-vel küldhetsz egy szerverfolyamatnak. Az argumentumai megegyeznek a GenServer.call/2 argumentumaival.

A handle_cast/2 visszahívás felelős ezen üzenetek kezeléséért. Két argumentumot kap, a message-et és a state-et, amelyek ugyanazok, mint a handle_call/3 visszahívásban (a from kivételével).

A handle_cast/2 visszahívás általában egy 2-es tuple-t ad vissza: {:noreply, state}.

Vannak ennél haladóbb lehetőségek is, amelyeket most nem tárgyalunk.

A call-t vagy a cast-ot használjam?

Szinte mindig használd a call-t, még akkor is, ha a klienskódodnak nincs szüksége a szerver válaszára.

A call használata megvárja a választ, ami egy backpressure-mechanizmusként szolgál (megakadályozza, hogy a kliensek egyszerre túl sok üzenetet küldjenek). A szerver válaszának megérkezése az egyetlen módja annak, hogy biztos lehess abban, hogy a szerver megkapta és kezelte a kliens üzenetét.

handle_info/2

Az üzenetek a GenServer.call/2 vagy a GenServer.cast/2 meghívásán kívül más módon is eljuthatnak a szerver postafiókjába, például a sima send/2 függvény meghívásával.

Az ilyen üzenetek kezeléséhez a handle_info/2 visszahívást használd. Ez a visszahívás pontosan ugyanúgy működik, mint a handle_cast/2.

A GenServer viselkedés egy mindent elkapó alapértelmezett implementációt biztosít a handle_info/2-höz, amely naplózza a nem várt üzenetekkel kapcsolatos hibákat. Ha felülírod ezt az alapértelmezett implementációt, mindig gondoskodj róla, hogy szerepeljen benne a saját, mindent elkapó implementációd is. Ha elfelejted, a szerver összeomlik, ha nem várt üzenetet kap.

Időtúllépések

A fent leírt négy visszahívás visszatérési értéke egy további tuple-elemmel, egy időtúllépéssel egészíthető ki. Például ahelyett, hogy az init/1-ből {:ok, state}-et adnál vissza, adj vissza {:ok, state, timeout}-ot.

Az időtúllépéssel észlelhető, ha egy adott ideig nem érkezik üzenet a postafiókba. Ha a szerver egy időtúllépést ad vissza valamelyik visszahívásából, és eltelik a megadott ezredmásodperc anélkül, hogy üzenet érkezne, akkor a handle_info/2 hívódik meg :timeout első argumentummal.