libzmq/src/object.hpp

125 lines
4.4 KiB
C++
Raw Normal View History

2009-07-29 12:07:54 +02:00
/*
Copyright (c) 2007-2010 iMatix Corporation
2009-07-29 12:07:54 +02:00
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
2009-07-29 12:07:54 +02:00
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.
2009-07-29 12:07:54 +02:00
You should have received a copy of the GNU Lesser General Public License
2009-07-29 12:07:54 +02:00
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
2009-08-03 11:30:13 +02:00
#ifndef __ZMQ_OBJECT_HPP_INCLUDED__
#define __ZMQ_OBJECT_HPP_INCLUDED__
2009-07-29 12:07:54 +02:00
#include "../include/zmq.h"
2009-07-29 12:07:54 +02:00
#include "stdint.hpp"
#include "blob.hpp"
2009-07-29 12:07:54 +02:00
2009-08-03 11:30:13 +02:00
namespace zmq
2009-07-29 12:07:54 +02:00
{
// Base class for all objects that participate in inter-thread
// communication.
class object_t
{
public:
object_t (class ctx_t *ctx_, uint32_t tid_);
2009-07-29 12:07:54 +02:00
object_t (object_t *parent_);
2009-09-08 16:55:03 +02:00
virtual ~object_t ();
2009-07-29 12:07:54 +02:00
uint32_t get_tid ();
2010-05-05 14:24:54 +02:00
ctx_t *get_ctx ();
2009-07-29 12:07:54 +02:00
void process_command (struct command_t &cmd_);
protected:
2009-11-21 20:59:55 +01:00
// Using following function, socket is able to access global
// repository of inproc endpoints.
int register_endpoint (const char *addr_, struct endpoint_t &endpoint_);
2009-11-21 20:59:55 +01:00
void unregister_endpoints (class socket_base_t *socket_);
struct endpoint_t find_endpoint (const char *addr_);
2009-11-21 20:59:55 +01:00
// Logs an message.
void log (zmq_msg_t *msg_);
// Chooses least loaded I/O thread.
class io_thread_t *choose_io_thread (uint64_t affinity_);
2009-07-29 12:07:54 +02:00
// Zombify particular socket. In other words, pass the ownership to
// the context.
2010-08-11 14:09:56 +02:00
void zombify_socket (class socket_base_t *socket_);
2009-07-29 12:07:54 +02:00
// Derived object can use these functions to send commands
// to other objects.
void send_stop ();
2010-08-11 14:09:56 +02:00
void send_plug (class own_t *destination_,
bool inc_seqnum_ = true);
void send_own (class own_t *destination_,
class own_t *object_);
void send_attach (class session_t *destination_,
struct i_engine *engine_, const blob_t &peer_identity_,
bool inc_seqnum_ = true);
2010-08-11 14:09:56 +02:00
void send_bind (class own_t *destination_,
2009-12-02 21:26:47 +01:00
class reader_t *in_pipe_, class writer_t *out_pipe_,
const blob_t &peer_identity_, bool inc_seqnum_ = true);
2010-08-28 10:15:03 +02:00
void send_activate_reader (class reader_t *destination_);
void send_activate_writer (class writer_t *destination_,
uint64_t msgs_read_);
2009-08-28 16:51:46 +02:00
void send_pipe_term (class writer_t *destination_);
void send_pipe_term_ack (class reader_t *destination_);
2010-08-11 14:09:56 +02:00
void send_term_req (class own_t *destination_,
class own_t *object_);
void send_term (class own_t *destination_, int linger_);
2010-08-11 14:09:56 +02:00
void send_term_ack (class own_t *destination_);
2009-07-29 12:07:54 +02:00
// These handlers can be overloaded by the derived objects. They are
// called when command arrives from another thread.
virtual void process_stop ();
virtual void process_plug ();
2010-08-11 14:09:56 +02:00
virtual void process_own (class own_t *object_);
virtual void process_attach (struct i_engine *engine_,
const blob_t &peer_identity_);
virtual void process_bind (class reader_t *in_pipe_,
class writer_t *out_pipe_, const blob_t &peer_identity_);
2010-08-28 10:15:03 +02:00
virtual void process_activate_reader ();
virtual void process_activate_writer (uint64_t msgs_read_);
2009-08-28 16:51:46 +02:00
virtual void process_pipe_term ();
virtual void process_pipe_term_ack ();
2010-08-11 14:09:56 +02:00
virtual void process_term_req (class own_t *object_);
virtual void process_term (int linger_);
virtual void process_term_ack ();
2009-07-29 12:07:54 +02:00
2009-12-02 21:26:47 +01:00
// Special handler called after a command that requires a seqnum
// was processed. The implementation should catch up with its counter
// of processed commands here.
virtual void process_seqnum ();
private:
2010-05-05 14:24:54 +02:00
// Context provides access to the global state.
class ctx_t *ctx;
2009-07-29 12:07:54 +02:00
// Thread ID of the thread the object belongs to.
uint32_t tid;
2009-07-29 12:07:54 +02:00
void send_command (command_t &cmd_);
object_t (const object_t&);
void operator = (const object_t&);
};
}
#endif