doc(server): handle_QUIT callback

sntran · Feb 18, 2024 · 20d5f84 · 20d5f84
1 parent 895d8a4
commit 20d5f84
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/lib/gen_nntp.ex b/lib/gen_nntp.ex
@@ -540,6 +540,13 @@ defmodule GenNNTP do
   """
   @callback handle_HELP(state) :: {:ok, help_text :: String.t(), state}
 
+  @doc """
+  Invoked when a client quits.
+
+  Returning `{:ok, new_state}` to close the connection.
+  """
+  @callback handle_QUIT(state) :: {:ok, state}
+
   @doc """
   Invoked when an uknown command is asked by the client.
 
@@ -568,6 +575,7 @@ defmodule GenNNTP do
     handle_BODY: 2,
     handle_STAT: 2,
     handle_POST: 2,
+    handle_QUIT: 1,
     handle_command: 2
   ]
 end
diff --git a/src/gen_nntp.erl b/src/gen_nntp.erl
@@ -139,6 +139,8 @@
 
 -callback handle_HELP(state()) -> {ok, HelpText :: binary(), state()}.
 
+-callback handle_QUIT(state()) -> {ok, state()}.
+
 -callback handle_command(Command :: binary(), state()) ->
             {reply, Response :: binary(), state()}
             | {noreply, state()}
@@ -155,6 +157,7 @@
   handle_BODY/2,
   handle_STAT/2,
   handle_POST/2,
+  handle_QUIT/1,
   handle_command/2
 ]).