req.hpp

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

    This file is part of 0MQ.

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

    0MQ 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_REQ_HPP_INCLUDED__
#define __ZMQ_REQ_HPP_INCLUDED__

#include "dealer.hpp"
#include "stdint.hpp"

namespace zmq
{

    class ctx_t;
    class msg_t;
    class io_thread_t;
    class socket_base_t;

    class req_t : public dealer_t
    {
    public:

        req_t (zmq::ctx_t *parent_, uint32_t tid_, int sid_);
        ~req_t ();

        //  Overrides of functions from socket_base_t.
        int xsend (zmq::msg_t *msg_);
        int xrecv (zmq::msg_t *msg_);
        bool xhas_in ();
        bool xhas_out ();
        int xsetsockopt (int option_, const void *optval_, size_t optvallen_);
        void xpipe_terminated (zmq::pipe_t *pipe_);

    protected:

        //  Receive only from the pipe the request was sent to, discarding
        //  frames from other pipes.
        int recv_reply_pipe (zmq::msg_t *msg_);

    private:

        //  If true, request was already sent and reply wasn't received yet or
        //  was raceived partially.
        bool receiving_reply;

        //  If true, we are starting to send/recv a message. The first part
        //  of the message must be empty message part (backtrace stack bottom).
        bool message_begins;

        //  The pipe the request was sent to and where the reply is expected.
        zmq::pipe_t *reply_pipe;

        //  Whether request id frames shall be sent and expected.
        bool request_id_frames_enabled;

        //  The current request id. It is incremented every time before a new
        //  request is sent.
        uint32_t request_id;

        //  If false, send() will reset its internal state and terminate the
        //  reply_pipe's connection instead of failing if a previous request is
        //  still pending.
        bool strict;

        req_t (const req_t&);
        const req_t &operator = (const req_t&);
    };

    class req_session_t : public session_base_t
    {
    public:

        req_session_t (zmq::io_thread_t *io_thread_, bool connect_,
            zmq::socket_base_t *socket_, const options_t &options_,
            address_t *addr_);
        ~req_session_t ();

        //  Overrides of the functions from session_base_t.
        int push_msg (msg_t *msg_);
        void reset ();

    private:

        enum {
            bottom,
            body
        } state;

        req_session_t (const req_session_t&);
        const req_session_t &operator = (const req_session_t&);
    };

}

#endif