libzmq/src/zap_client.hpp

/*
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file

    This file is part of libzmq, the ZeroMQ core engine in C++.

    libzmq is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License (LGPL) as published
    by the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    As a special exception, the Contributors give you permission to link
    this library with independent modules to produce an executable,
    regardless of the license terms of these independent modules, and to
    copy and distribute the resulting executable under terms of your choice,
    provided that you also meet, for each linked independent module, the
    terms and conditions of the license of that module. An independent
    module is a module which is not derived from or based on this library.
    If you modify this library, you must extend this exception to your
    version of the library.

    libzmq is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
    License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef __ZMQ_ZAP_CLIENT_HPP_INCLUDED__
#define __ZMQ_ZAP_CLIENT_HPP_INCLUDED__

#include "mechanism.hpp"

namespace zmq
{
class session_base_t;

class zap_client_t : public virtual mechanism_t
{
  public:
    zap_client_t (session_base_t *const session_,
                  const std::string &peer_address_,
                  const options_t &options_);

    int send_zap_request (const char *mechanism,
                          size_t mechanism_length,
                          const uint8_t *credentials,
                          size_t credentials_size);

    int send_zap_request (const char *mechanism,
                          size_t mechanism_length,
                          const uint8_t **credentials,
                          size_t *credentials_sizes,
                          size_t credentials_count);


    int receive_and_process_zap_reply ();

  protected:
    session_base_t *const session;
    const std::string peer_address;

    //  Status code as received from ZAP handler
    std::string status_code;

    enum state_t
    {
        waiting_for_hello,
        sending_welcome,
        waiting_for_initiate,
        waiting_for_zap_reply,
        sending_ready,
        sending_error,
        error_sent,
        ready
    };
};
}

#endif