View Source kpro_auth_backend behaviour (kafka_protocol v4.2.2)

Summary

Types

server_auth_response/0

Callbacks

auth/6
auth/7

Functions

auth(CallbackModule, Host, Sock, HandShakeVsn, Mod, ClientName, Timeout, SaslOpts)

Types

server_auth_response/0

-type server_auth_response() :: term().

Callbacks

auth/6

(optional) 
-callback auth(Host :: string(),
               Sock :: gen_tcp:socket() | ssl:sslsocket(),
               Mod :: gen_tcp | ssl,
               ClientName :: binary(),
               Timeout :: pos_integer(),
               SaslOpts :: term()) ->
                  ok | {ok, server_auth_response()} | {error, Reason :: term()}.

auth/7

-callback auth(Host :: string(),
               Sock :: gen_tcp:socket() | ssl:sslsocket(),
               HandShakeVsn :: non_neg_integer(),
               Mod :: gen_tcp | ssl,
               ClientName :: binary(),
               Timeout :: pos_integer(),
               SaslOpts :: term()) ->
                  ok | {ok, server_auth_response()} | {error, Reason :: term()}.

Functions

auth(CallbackModule, Host, Sock, HandShakeVsn, Mod, ClientName, Timeout, SaslOpts)

-spec auth(CallbackModule :: atom(),
           Host :: string(),
           Sock :: gen_tcp:socket() | ssl:sslsocket(),
           HandShakeVsn :: non_neg_integer(),
           Mod :: gen_tcp | ssl,
           ClientName :: binary(),
           Timeout :: pos_integer(),
           SaslOpts :: term()) ->
              ok | {ok, server_auth_response()} | {error, Reason :: term()}.