Add xmpp_router behaviour specs to implementations

esl · Feb 5, 2025 · cf0c309 · cf0c309
1 parent 88952f6
commit cf0c309
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 0 deletions.
diff --git a/src/mongoose_router_dynamic_domains.erl b/src/mongoose_router_dynamic_domains.erl
@@ -19,9 +19,13 @@
 %% xmpp_router callback
 -export([filter/4, route/4]).
 
+-spec filter(jid:jid(), jid:jid(), mongoose_acc:t(), exml:element()) ->
+    drop | xmpp_router:filter().
 filter(From, To, Acc, Packet) ->
     {From, To, Acc, Packet}.
 
+-spec route(jid:jid(), jid:jid(), mongoose_acc:t(), exml:element()) ->
+    {done, mongoose_acc:t()} | xmpp_router:filter().
 route(From, To, Acc, Packet) ->
     LDstDomain = To#jid.lserver,
     case mongoose_lazy_routing:maybe_add_domain_or_subdomain(LDstDomain) of

diff --git a/src/mongoose_router_external.erl b/src/mongoose_router_external.erl
@@ -15,9 +15,13 @@
 %% xmpp_router callback
 -export([filter/4, route/4]).
 
+-spec filter(jid:jid(), jid:jid(), mongoose_acc:t(), exml:element()) ->
+    drop | xmpp_router:filter().
 filter(OrigFrom, OrigTo, OrigAcc, OrigPacket) ->
     {OrigFrom, OrigTo, OrigAcc, OrigPacket}.
 
+-spec route(jid:jid(), jid:jid(), mongoose_acc:t(), exml:element()) ->
+    {done, mongoose_acc:t()} | xmpp_router:filter().
 route(From, To, Acc0, Packet) ->
     LDstDomain = To#jid.lserver,
     case mongoose_component:lookup_component(LDstDomain) of

diff --git a/src/mongoose_router_external_localnode.erl b/src/mongoose_router_external_localnode.erl
@@ -16,9 +16,13 @@
 %% xmpp_router callback
 -export([filter/4, route/4]).
 
+-spec filter(jid:jid(), jid:jid(), mongoose_acc:t(), exml:element()) ->
+    drop | xmpp_router:filter().
 filter(OrigFrom, OrigTo, OrigAcc, OrigPacket) ->
     {OrigFrom, OrigTo, OrigAcc, OrigPacket}.
 
+-spec route(jid:jid(), jid:jid(), mongoose_acc:t(), exml:element()) ->
+    {done, mongoose_acc:t()} | xmpp_router:filter().
 route(From, To, Acc0, Packet) ->
     LDstDomain = To#jid.lserver,
     case mongoose_component:lookup_component(LDstDomain, node()) of

diff --git a/src/mongoose_router_global.erl b/src/mongoose_router_global.erl
@@ -13,6 +13,8 @@
 %% xmpp_router callback
 -export([filter/4, route/4]).
 
+-spec filter(jid:jid(), jid:jid(), mongoose_acc:t(), exml:element()) ->
+    drop | xmpp_router:filter().
 filter(OrigFrom, OrigTo, OrigAcc, OrigPacket) ->
     %% Filter globally
     case mongoose_hooks:filter_packet({OrigFrom, OrigTo, OrigAcc, OrigPacket}) of
@@ -22,5 +24,7 @@ filter(OrigFrom, OrigTo, OrigAcc, OrigPacket) ->
             drop
     end.
 
+-spec route(jid:jid(), jid:jid(), mongoose_acc:t(), exml:element()) ->
+    {done, mongoose_acc:t()} | xmpp_router:filter().
 route(From, To, Acc, Packet) ->
     {From, To, Acc, Packet}.
diff --git a/src/mongoose_router_localdomain.erl b/src/mongoose_router_localdomain.erl
@@ -14,9 +14,13 @@
 %% xmpp_router callback
 -export([filter/4, route/4]).
 
+-spec filter(jid:jid(), jid:jid(), mongoose_acc:t(), exml:element()) ->
+    drop | xmpp_router:filter().
 filter(From, To, Acc, Packet) ->
     {From, To, Acc, Packet}.
 
+-spec route(jid:jid(), jid:jid(), mongoose_acc:t(), exml:element()) ->
+    {done, mongoose_acc:t()} | xmpp_router:filter().
 route(From, To, Acc0, Packet) ->
     LDstDomain = To#jid.lserver,
     case mongoose_router:lookup_route(LDstDomain) of