Antkeeper  0.0.1
Public Types | List of all members
event::publisher< T > Class Template Reference

Publishes messages to subscribers. More...

#include <publisher.hpp>

Public Types

typedef T message_type
 Message type. More...
 
typedef channel< message_typechannel_type
 Channel type. More...
 

Public Member Functions

template<class ExecutionPolicy >
void publish (ExecutionPolicy &&policy, const message_type &message) const
 Publishes a message. More...
 
void publish (const message_type &message) const
 Publishes a message. More...
 
const channel_typechannel () const noexcept
 Returns the channel through which messages are published. More...
 
channel_typechannel () noexcept
 Returns the channel through which messages are published. More...
 

Detailed Description

template<class T>
class event::publisher< T >

Publishes messages to subscribers.

Template Parameters
TMessage type.

Definition at line 35 of file publisher.hpp.

Member Typedef Documentation

◆ channel_type

template<class T >
typedef channel<message_type> event::publisher< T >::channel_type

Channel type.

Definition at line 42 of file publisher.hpp.

◆ message_type

template<class T >
typedef T event::publisher< T >::message_type

Message type.

Definition at line 39 of file publisher.hpp.

Member Function Documentation

◆ channel() [1/2]

template<class T >
const channel_type& event::publisher< T >::channel ( ) const
inlinenoexcept

Returns the channel through which messages are published.

Definition at line 78 of file publisher.hpp.

◆ channel() [2/2]

template<class T >
channel_type& event::publisher< T >::channel ( )
inlinenoexcept

Returns the channel through which messages are published.

Definition at line 83 of file publisher.hpp.

◆ publish() [1/2]

template<class T >
void event::publisher< T >::publish ( const message_type message) const
inline

Publishes a message.

Template Parameters
ExecutionPolicyExecution policy type.
Parameters
policyExecution policy to use.
messageMessage to publish.

Definition at line 68 of file publisher.hpp.

◆ publish() [2/2]

template<class T >
template<class ExecutionPolicy >
void event::publisher< T >::publish ( ExecutionPolicy &&  policy,
const message_type message 
) const
inline

Publishes a message.

Template Parameters
ExecutionPolicyExecution policy type.
Parameters
policyExecution policy to use.
messageMessage to publish.

Definition at line 54 of file publisher.hpp.


The documentation for this class was generated from the following files: