Implementing GenServer Behavior
Learn to implement a GenServer, managing state and handling synchronous and asynchronous calls, forming the backbone of most Erlang components.
Implementing GenServer Behavior is a free Erlang OTP: Distributed & Fault-Tolerant Systems Programming lesson on CoddyKit — lesson 2 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Erlang OTP: Distributed & Fault-Tolerant Systems Programming learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.
What is a GenServer?
Welcome back! In the previous lesson, we learned about Erlang's OTP behaviors. One of the most important is the GenServer.
- A GenServer is a generic server that handles requests.
- It manages internal state and processes messages in a sequential manner.
- Think of it as a standardized way to build reliable, fault-tolerant server processes in Erlang.
It's the foundation for many Erlang applications.
GenServer's Core: Callbacks
To implement a GenServer, you define a module that exports specific callback functions. These functions are called by the gen_server behavior at different stages.
init/1: Initializes the server's state.handle_call/3: Handles synchronous client requests (expects a reply).handle_cast/2: Handles asynchronous client requests (fire-and-forget).terminate/2: Cleans up when the server stops.code_change/3: Handles hot code upgrades.
We'll focus on init, handle_call, and handle_cast in this lesson.
Initializing State with `init/1`
Every GenServer starts by initializing its state. This is done in the init/1 callback function.
It takes one argument (typically a list of arguments passed during startup) and should return {ok, State}, where State is the initial data your GenServer will manage.
Here's a basic init function:
-module(my_counter).
-behaviour(gen_server).
-export([init/1]).
init([]) ->
io:format("Counter initialized with state 0.~n"),
{ok, 0}.Starting a GenServer Process
To get our GenServer running, we need to start it. The common way is using gen_server:start_link/3 or gen_server:start_link/4. We'll add a start_link/0 function to our module.
The start_link function creates a new Erlang process and links it to the calling process, making it part of a supervision tree (more on this later!).
-module(my_counter).
-behaviour(gen_server).
-export([start_link/0, init/1]).
start_link() ->
gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
init([]) ->
io:format("Counter process started!~n"),
{ok, 0}.Synchronous Calls: `handle_call`
When a client needs a reply from the server, it makes a synchronous call using gen_server:call/2 or gen_server:call/3.
The GenServer handles these requests in its handle_call/3 callback. This function takes three arguments:
Request: The message from the client.From: The sender's process ID (Pid) and a tag.State: The current internal state of the GenServer.
It typically returns {reply, Reply, NewState}.
Implementing `handle_call` (Counter)
Let's add an increment function to our counter. This will be a synchronous call, meaning the client waits for the new count.
Try running this code. First, compile it (`c(my_counter).`), then start it (`my_counter:start_link().`). You can then call `my_counter:increment().` to see the counter increase.
-module(my_counter).
-behaviour(gen_server).
-export([start_link/0, increment/0, get_count/0]).
-export([init/1, handle_call/3, handle_cast/2, terminate/2, code_change/3]).
start_link() ->
gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
increment() ->
gen_server:call(?MODULE, increment).
get_count() ->
gen_server:call(?MODULE, get_count).
init([]) ->
{ok, 0}.
handle_call(increment, _From, State) ->
NewState = State + 1,
{reply, NewState, NewState};
handle_call(get_count, _From, State) ->
{reply, State, State};
handle_call(_Request, _From, State) ->
{reply, {error, bad_request}, State}.
handle_cast(_Msg, State) -> % Placeholder
{noreply, State}.
terminate(_Reason, _State) -> ok.
code_change(_OldVsn, State, _Extra) -> {ok, State}.Asynchronous Calls: `handle_cast`
Sometimes, a client doesn't need a reply and just wants to send a message without waiting. This is an asynchronous call using gen_server:cast/2.
The GenServer handles these messages in its handle_cast/2 callback. It takes two arguments:
Message: The message from the client.State: The current internal state of the GenServer.
It always returns {noreply, NewState} because no reply is sent back to the client.
Implementing `handle_cast` (Reset)
Let's add a reset function to our counter. This will be an asynchronous call, as the client doesn't need to know the new count immediately.
Compile and start the module as before. Call `my_counter:increment().` a few times, then `my_counter:reset().`. You'll notice `reset` returns immediately without a value.
-module(my_counter).
-behaviour(gen_server).
-export([start_link/0, increment/0, get_count/0, reset/0]).
-export([init/1, handle_call/3, handle_cast/2, terminate/2, code_change/3]).
start_link() ->
gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
increment() ->
gen_server:call(?MODULE, increment).
get_count() ->
gen_server:call(?MODULE, get_count).
reset() ->
gen_server:cast(?MODULE, reset).
init([]) ->
{ok, 0}.
handle_call(increment, _From, State) ->
NewState = State + 1,
{reply, NewState, NewState};
handle_call(get_count, _From, State) ->
{reply, State, State};
handle_call(_Request, _From, State) ->
{reply, {error, bad_request}, State}.
handle_cast(reset, _State) ->
{noreply, 0};
handle_cast(_Msg, State) ->
{noreply, State}.
terminate(_Reason, _State) -> ok.
code_change(_OldVsn, State, _Extra) -> {ok, State}.GenServer State Management
The power of GenServers lies in how they manage state. The State argument is passed into each callback, and the callback returns a NewState.
- This ensures that only one process (the GenServer itself) ever modifies its state, preventing race conditions.
- It makes the server's internal logic easier to reason about.
- The state can be any Erlang term: an integer, a list, a map, a record, or a complex data structure.
This sequential processing of messages and explicit state passing is key to Erlang's concurrency model.
GenServer Call Types
Which of the following statements about GenServer calls are TRUE?
Recap: Implementing GenServer
You've successfully built your first GenServer! Here's what we covered:
- GenServers are standard OTP behaviors for building stateful servers.
- The
init/1callback initializes the server's state. gen_server:start_linkcreates the GenServer process.handle_call/3handles synchronous requests (client waits for reply).handle_cast/2handles asynchronous messages (client doesn't wait).- GenServers manage their state by passing it between callbacks, ensuring sequential updates.
Next, we'll see how supervisors can automatically restart failed GenServers!
Frequently asked questions
Is the “Implementing GenServer Behavior” lesson free?
Yes — the full text of “Implementing GenServer Behavior” is free to read here on the web, and the Erlang OTP: Distributed & Fault-Tolerant Systems Programming course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Erlang OTP: Distributed & Fault-Tolerant Systems Programming course, upgrade to CoddyKit PRO.
What will I learn in “Implementing GenServer Behavior”?
Learn to implement a GenServer, managing state and handling synchronous and asynchronous calls, forming the backbone of most Erlang components. You practise Erlang OTP: Distributed & Fault-Tolerant Systems Programming with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start Erlang OTP: Distributed & Fault-Tolerant Systems Programming?
No prior experience is required. Erlang OTP: Distributed & Fault-Tolerant Systems Programming on CoddyKit is structured for beginners through advanced learners; this is — lesson 2 of 4, so you can start here or from the beginning and move at your own pace.
How long does the “Implementing GenServer Behavior” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this Erlang OTP: Distributed & Fault-Tolerant Systems Programming lesson?
Yes. Every Erlang OTP: Distributed & Fault-Tolerant Systems Programming lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.
All lessons in this course
- Understanding OTP & Behaviors
- Implementing GenServer Behavior
- Introduction to Supervisors
- Building OTP Applications & Releases