Venus::Role::Subscribable

Subscribable Role

Subscribable Role for Perl 5

method: publish method: subscribe method: subscribers method: unsubscribe

package Example;

use Venus::Class;

with 'Venus::Role::Subscribable';

sub execute {
  $_[0]->publish('on.execute');
}

package main;

my $example = Example->new;

# $example->subscribe('on.execute', sub{...});

# bless(..., 'Example')

# $example->publish('on.execute');

# bless(..., 'Example')

This package provides a mechanism for publishing and subscribing to events.

The publish method notifies all subscribers for a given event and returns the invocant.

publish(string $name, any @args) (object)

{ since => '1.75', }

=example-1 publish

# given: synopsis

package main;

$example = $example->publish;

# bless(..., 'Example')

The subscribe method registers a subscribers (i.e. callbacks) for a given event, and returns the invocant.

subscribe(string $name, coderef $code) (object)

{ since => '1.75', }

=example-1 subscribe

# given: synopsis

package main;

$example = $example->subscribe('on.execute', sub {$example->{emitted} = [@_]});

# bless(..., 'Example')

The subscribers method returns the number of subscribers (i.e. callbacks) for a given event.

subscribers(string $name) (number)

{ since => '1.75', }

=example-1 subscribers

# given: synopsis

package main;

$example = $example->subscribers;

# 0

The unsubscribe method deregisters all subscribers (i.e. callbacks) for a given event, or a specific callback if provided, and returns the invocant.

unsubscribe(string $name, coderef $code) (object)

{ since => '1.75', }

=example-1 unsubscribe

# given: synopsis

package main;

$example = $example->unsubscribe;

# bless(..., 'Example')

t/Venus.t: present: authors t/Venus.t: present: license