summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorSimon MacMullen <simon@rabbitmq.com>2010-11-09 16:30:50 +0000
committerSimon MacMullen <simon@rabbitmq.com>2010-11-09 16:30:50 +0000
commitef4667da4a760a6376cff26a097451b10570bb16 (patch)
treeef08210e2e23c5518156d0d00019dea149247801 /src
parentb25a62b94ecabff3e75a9f0beb351f16b306b52d (diff)
downloadrabbitmq-server-git-ef4667da4a760a6376cff26a097451b10570bb16.tar.gz
Document a bit more
Diffstat (limited to 'src')
-rw-r--r--src/rabbit_auth_mechanism.erl10
1 files changed, 9 insertions, 1 deletions
diff --git a/src/rabbit_auth_mechanism.erl b/src/rabbit_auth_mechanism.erl
index 2e37432026..b13a14ec38 100644
--- a/src/rabbit_auth_mechanism.erl
+++ b/src/rabbit_auth_mechanism.erl
@@ -46,7 +46,15 @@ behaviour_info(callbacks) ->
%% object to be passed through all the stages of authentication.
{init, 0},
- %% Handle a stage of authentication
+ %% Handle a stage of authentication. Possible responses:
+ %% {ok, User}
+ %% Authentication succeeded, and here's the user record.
+ %% {challenge, Challenge, NextState}
+ %% Another round is needed. Here's the state I want next time.
+ %% {protocol_error, Msg, Args}
+ %% Client got the protocol wrong. Log and die.
+ %% {refused, Username}
+ %% Client failed authentication. Log and die.
{handle_response, 2}
];
behaviour_info(_Other) ->