Module: Iodine::PubSub

Defined in:

lib/iodine/pubsub.rb,
ext/iodine/iodine_pubsub.c

Overview

Note:

From –subscribe_pattern Wikipedia: publish–subscribe is a messaging pattern where senders of messages, called publishers, do not program the messages to be sent directly to specific receivers, called subscribers, but instead characterize published messages into classes without knowledge of which subscribers, if any, there may be. Similarly, subscribers express interest in one or more classes and only receive messages that are of interest, without knowledge of which publishers, if any, there are.

Iodine is equiped with an internal pub/sub service that allows improved resource management from a deployment perspective.

The common paradigm, which is implemented by pub/sub services like Redis, is for a “client” to “subscribe” to one or more “channels”. Messages are streamed to these “channels” by different “publishers” (the application / other clients) and are broadcasted to the “clients” through their “subscription”.

Iodine’s approach it to offload pub/sub resource costs from the pub/sub service (which is usually expensive to scale) onto the application layer.

For example, the default (‘nil`) pub/sub Engine implements an internal pub/sub service that manages subscriptions (clients and channels) throughout an Iodine process cluster without any need to connect to an external pub/sub service.

If Iodine was runninng with 8 processes and 16 threads per process, a publishing in process A will be delivered to subscribers in process B.

In addition, by inheriting the Engine class, it’s easy to create pub/sub engines that connect to this underlying pub/sub service. This means that Iodine will call the engine’s ‘subscribe` method only once per channel and once messages arrive, Iodine will distribute the messages to all the subscribed clients.

Defined Under Namespace

Classes: Engine, Redis

Constant Summary

CLUSTER =

CLUSTER publishes data to all the subscribers in the process cluster.

iodine_pubsub_make_C_engine(FIO_PUBSUB_CLUSTER)

PROCESS =

PROCESS publishes data to all the subscribers in a single process.

iodine_pubsub_make_C_engine(FIO_PUBSUB_PROCESS)

SIBLINGS =

SIBLINGS publishes data to all the subscribers in the other processes process.

iodine_pubsub_make_C_engine(FIO_PUBSUB_SIBLINGS)

PUBLISH2ROOT =

PUBLISH2ROOT publishes data only to the root / master process.

iodine_pubsub_make_C_engine(FIO_PUBSUB_ROOT)

Class Method Summary

• .attach(engine) ⇒ Object

  Attaches an Engine to the pub/sub system (more than a single engine can be attached at the same time).

• .default ⇒ Object

  Returns the default Engine for pub/sub methods.

• .default=(engine) ⇒ Object

  Sets the default Engine for pub/sub methods.

• .detach(engine) ⇒ Object

  Removes an Engine from the pub/sub system.

• .dettach(engine) ⇒ Object

  Removes an Engine from the pub/sub system.

• .reset(engine) ⇒ Object

  Forces Iodine to call the Engine#subscribe callback for all existing subscriptions (i.e., when reconnecting to a Pub/Sub backend such as Redis).

Class Method Details

.attach(engine) ⇒ Object

Attaches an Engine to the pub/sub system (more than a single engine can be attached at the same time).

After an engine was attached, it’s callbacks will be called (Iodine::PubSub::Engine#subscribe and Iodine::PubSub::Engine#unsubscribe) in response to Pub/Sub events.

# File 'ext/iodine/iodine_pubsub.c', line 301

static VALUE iodine_pubsub_attach(VALUE self, VALUE engine) {
  iodine_pubsub_s *e = iodine_pubsub_CData(engine);
  if (!e) {
    rb_raise(rb_eTypeError, "not a valid engine");
    return Qnil;
  }
  if (e->handler == Qnil) {
    e->handler = engine;
  }
  IodineStore.add(engine);
  fio_pubsub_attach(e->engine);
  return engine;
  (void)self;
}

.default ⇒ Object

Returns the default Engine for pub/sub methods.

# File 'ext/iodine/iodine_pubsub.c', line 284

static VALUE iodine_pubsub_default_get(VALUE self) {
  VALUE def = rb_ivar_get(self, rb_intern2("default_engine", 14));
  if (def == Qnil) {
    def = rb_const_get(self, rb_intern2("CLUSTER", 7));
    iodine_pubsub_default_set(self, def);
  }
  return def;
}

.default=(engine) ⇒ Object

Sets the default Engine for pub/sub methods.

# File 'ext/iodine/iodine_pubsub.c', line 266

static VALUE iodine_pubsub_default_set(VALUE self, VALUE engine) {
  if (engine == Qnil) {
    engine = rb_const_get(self, rb_intern2("CLUSTER", 7));
  }
  iodine_pubsub_s *e = iodine_pubsub_CData(engine);
  if (!e) {
    rb_raise(rb_eTypeError, "not a valid engine");
    return Qnil;
  }
  if (e->handler == Qnil) {
    e->handler = engine;
  }
  FIO_PUBSUB_DEFAULT = e->engine;
  rb_ivar_set(self, rb_intern2("default_engine", 14), engine);
  return engine;
}

.detach(engine) ⇒ Object

Removes an Engine from the pub/sub system.

After an Engine was detached, Iodine will no longer call the Engine‘s callbacks (Iodine::PubSub::Engine#subscribe and Iodine::PubSub::Engine#unsubscribe)

# File 'ext/iodine/iodine_pubsub.c', line 323

static VALUE iodine_pubsub_detach(VALUE self, VALUE engine) {
  iodine_pubsub_s *e = iodine_pubsub_CData(engine);
  if (!e) {
    rb_raise(rb_eTypeError, "not a valid engine");
    return Qnil;
  }
  if (e->handler == Qnil) {
    e->handler = engine;
  }
  IodineStore.remove(engine);
  fio_pubsub_detach(e->engine);
  return engine;
  (void)self;
}

.dettach(engine) ⇒ Object

Removes an Engine from the pub/sub system.

After an Engine was detached, Iodine will no longer call the Engine‘s callbacks (Iodine::PubSub::Engine#subscribe and Iodine::PubSub::Engine#unsubscribe)

# File 'ext/iodine/iodine_pubsub.c', line 323

static VALUE iodine_pubsub_detach(VALUE self, VALUE engine) {
  iodine_pubsub_s *e = iodine_pubsub_CData(engine);
  if (!e) {
    rb_raise(rb_eTypeError, "not a valid engine");
    return Qnil;
  }
  if (e->handler == Qnil) {
    e->handler = engine;
  }
  IodineStore.remove(engine);
  fio_pubsub_detach(e->engine);
  return engine;
  (void)self;
}

.reset(engine) ⇒ Object

Forces Iodine to call the Iodine::PubSub::Engine#subscribe callback for all existing subscriptions (i.e., when reconnecting to a Pub/Sub backend such as Redis).

# File 'ext/iodine/iodine_pubsub.c', line 343

static VALUE iodine_pubsub_reset(VALUE self, VALUE engine) {
  iodine_pubsub_s *e = iodine_pubsub_CData(engine);
  if (!e) {
    rb_raise(rb_eTypeError, "not a valid engine");
    return Qnil;
  }
  if (e->handler == Qnil) {
    e->handler = engine;
  }
  fio_pubsub_reattach(e->engine);
  return engine;
  (void)self;
}