session.hpp 3.01 KB
Newer Older
1
/*
2
    Copyright (c) 2007-2010 iMatix Corporation
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

    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__

23 24
#include <string>

25
#include "i_inout.hpp"
Martin Sustrik's avatar
Martin Sustrik committed
26
#include "i_endpoint.hpp"
27
#include "owned.hpp"
28
#include "options.hpp"
29 30 31 32

namespace zmq
{

Martin Sustrik's avatar
Martin Sustrik committed
33
    class session_t : public owned_t, public i_inout, public i_endpoint
34 35 36
    {
    public:

37 38 39 40 41 42 43 44
        //  Creates unnamed session.
        session_t (object_t *parent_, socket_base_t *owner_,
            const options_t &options_);

        //  Creates named session. If name is NULL, transient session with
        //  auto-generated name is created.
        session_t (object_t *parent_, socket_base_t *owner_,
            const options_t &options_, const char *name_);
Martin Sustrik's avatar
Martin Sustrik committed
45

46
        //  i_inout interface implementation.
47 48
        bool read (::zmq_msg_t *msg_);
        bool write (::zmq_msg_t *msg_);
49
        void flush ();
50 51 52
        void detach (owned_t *reconnecter_);
        class io_thread_t *get_io_thread ();
        class socket_base_t *get_owner ();
53
        uint64_t get_ordinal ();
54

Martin Sustrik's avatar
Martin Sustrik committed
55
        //  i_endpoint interface implementation.
56
        void attach_pipes (class reader_t *inpipe_, class writer_t *outpipe_);
Martin Sustrik's avatar
Martin Sustrik committed
57 58
        void detach_inpipe (class reader_t *pipe_);
        void detach_outpipe (class writer_t *pipe_);
59 60
        void kill (class reader_t *pipe_);
        void revive (class reader_t *pipe_);
Martin Sustrik's avatar
Martin Sustrik committed
61

62 63 64 65
    private:

        ~session_t ();

66 67 68
        //  Handlers for incoming commands.
        void process_plug ();
        void process_unplug ();
69
        void process_attach (struct i_engine *engine_);
70

Martin Sustrik's avatar
Martin Sustrik committed
71 72 73 74 75 76 77 78 79
        //  Inbound pipe, i.e. one the session is getting messages from.
        class reader_t *in_pipe;

        //  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;

80
        struct i_engine *engine;
81

82 83 84 85 86 87 88 89 90
        enum {
            transient,
            named,
            unnamed
        } type;

        //  Ordinal of the session (if any).
        uint64_t ordinal;

91 92 93 94
        //  The name of the session. One that is used to register it with
        //  socket-level repository of sessions.
        std::string name;

Martin Sustrik's avatar
Martin Sustrik committed
95 96 97
        //  Inherited socket options.
        options_t options;

98 99 100 101 102 103 104
        session_t (const session_t&);
        void operator = (const session_t&);
    };

}

#endif