libzmq/src/session.hpp

/*
    Copyright (c) 2007-2010 iMatix Corporation

    This file is part of 0MQ.

    0MQ is free software; you can redistribute it and/or modify it under
    the terms of the Lesser GNU 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
    Lesser GNU General Public License for more details.

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

#ifndef __ZMQ_SESSION_HPP_INCLUDED__
#define __ZMQ_SESSION_HPP_INCLUDED__

#include "i_inout.hpp"
#include "owned.hpp"
#include "options.hpp"
#include "blob.hpp"
#include "pipe.hpp"

namespace zmq
{

    class session_t :
        public owned_t,
        public i_inout,
        public i_reader_events,
        public i_writer_events
    {
    public:

        //  Creates unnamed session.
        session_t (object_t *parent_, socket_base_t *owner_,
            const options_t &options_);

        //  Creates named session.
        session_t (object_t *parent_, socket_base_t *owner_,
            const options_t &options_, const blob_t &peer_identity_);

        //  i_inout interface implementation.
        bool read (::zmq_msg_t *msg_);
        bool write (::zmq_msg_t *msg_);
        void flush ();
        void detach (owned_t *reconnecter_);
        class io_thread_t *get_io_thread ();
        class socket_base_t *get_owner ();
        uint64_t get_ordinal ();

        void attach_pipes (class reader_t *inpipe_, class writer_t *outpipe_,
            const blob_t &peer_identity_);

        //  i_reader_events interface implementation.
        void activated (class reader_t *pipe_);
        void terminated (class reader_t *pipe_);

        //  i_writer_events interface implementation.
        void activated (class writer_t *pipe_);
        void terminated (class writer_t *pipe_);

    private:

        ~session_t ();

        //  Define the delayed termination. (I.e. termination is postponed
        //  till all the data is flushed to the kernel.)
        bool is_terminable ();

        //  Handlers for incoming commands.
        void process_plug ();
        void process_unplug ();
        void process_attach (struct i_engine *engine_,
            const blob_t &peer_identity_);

        //  Inbound pipe, i.e. one the session is getting messages from.
        class reader_t *in_pipe;

        //  This flag is true if the remainder of the message being processed
        //  is still in the in pipe.
        bool incomplete_in;

        //  If true, in_pipe is active. Otherwise there are no messages to get.
        bool active;

        //  Outbound pipe, i.e. one the socket is sending messages to.
        class writer_t *out_pipe;

        struct i_engine *engine;

        //  Session is identified by ordinal in the case when it was created
        //  before connection to the peer was established and thus we are
        //  unaware of peer's identity.
        uint64_t ordinal;

        //  Identity of the peer.
        blob_t peer_identity;

        //  Inherited socket options.
        options_t options;

        session_t (const session_t&);
        void operator = (const session_t&);
    };

}

#endif