PeanutButter.TinyEventAggregator.EventBase< TPayload > Class Template Reference

More...

Inheritance diagram for PeanutButter.TinyEventAggregator.EventBase< TPayload >:

Public Member Functions
SubscriptionToken	Subscribe (Action< TPayload > callback, [CallerFilePath] string sourceFile="", [CallerMemberName] string requestingMethod="(unknown)", [CallerLineNumber] int subscribingSourceLine=-1)
	Subscribe to the event.
SubscriptionToken	SubscribeOnce (Action< TPayload > action, [CallerFilePath] string sourceFile="", [CallerMemberName] string requestingMethod="(unknown)", [CallerLineNumber] int subscribingSourceLine=-1)
	Subscribe to the event for one iteration only.
SubscriptionToken	LimitedSubscription (Action< TPayload > action, int limit, [CallerFilePath] string sourceFile="", [CallerMemberName] string requestingMethod="(unknown)", [CallerLineNumber] int subscribingSourceLine=-1)
	Subscribe to the event for a limited number of notifications.
void	Publish (TPayload data, [CallerFilePath] string sourceFile="", [CallerMemberName] string requestingMethod="(unknown)", [CallerLineNumber] int publishingSourceLine=-1)
	Publish this event with some data to all subscribers.
Task	PublishAsync (TPayload data, [CallerFilePath] string sourceFile=null, [CallerMemberName] string requestingMethod=null, [CallerLineNumber] int publishingSourceLine=-1)
	Publish the event to all subscribers with the provided data.
void	Unsubscribe (SubscriptionToken token, [CallerFilePath] string sourceFile="", [CallerMemberName] string requestingMethod="(unknown)", [CallerLineNumber] int unsubscribingSourceLine=-1)
	Unsubscribe from this event with the provided token.
Public Member Functions inherited from PeanutButter.TinyEventAggregator.EventBase
void	Unsuspend ()
	Unsuspend this event.
void	Suspend ()
	Suspend this event.

Protected Member Functions
	EventBase ()

Properties
int	SubscriptionCount [get]
	The number of subscribers to this event.
SubscriptionAddedEventHandler	OnSubscriptionAdded [get, set]
	Fired when a subscription is added for this event.
SubscriptionRemovedEventHandler	OnSubscriptionRemoved [get, set]
	Fired when a subscription is removed for this event.
Properties inherited from PeanutButter.TinyEventAggregator.EventBase
bool	IsSuspended [get]
	Flag: is this event suspended.

Detailed Description

Member Function Documentation

LimitedSubscription()

SubscriptionToken PeanutButter.TinyEventAggregator.EventBase< TPayload >.LimitedSubscription	(	Action< TPayload >	action,
		int	limit,
		[CallerFilePath] string	sourceFile = "",
		[CallerMemberName] string	requestingMethod = "(unknown)",
		[CallerLineNumber] int	subscribingSourceLine = -1 )

Subscribe to the event for a limited number of notifications.

Parameters

action
limit
sourceFile
requestingMethod
subscribingSourceLine

Returns

Publish()

void PeanutButter.TinyEventAggregator.EventBase< TPayload >.Publish	(	TPayload	data,
		[CallerFilePath] string	sourceFile = "",
		[CallerMemberName] string	requestingMethod = "(unknown)",
		[CallerLineNumber] int	publishingSourceLine = -1 )

Publish this event with some data to all subscribers.

Parameters

data
sourceFile
requestingMethod
publishingSourceLine

PublishAsync()

Task PeanutButter.TinyEventAggregator.EventBase< TPayload >.PublishAsync	(	TPayload	data,
		[CallerFilePath] string	sourceFile = null,
		[CallerMemberName] string	requestingMethod = null,
		[CallerLineNumber] int	publishingSourceLine = -1 )

Publish the event to all subscribers with the provided data.

Parameters

data
sourceFile
requestingMethod
publishingSourceLine

Returns

Subscribe()

SubscriptionToken PeanutButter.TinyEventAggregator.EventBase< TPayload >.Subscribe	(	Action< TPayload >	callback,
		[CallerFilePath] string	sourceFile = "",
		[CallerMemberName] string	requestingMethod = "(unknown)",
		[CallerLineNumber] int	subscribingSourceLine = -1 )

Subscribe to the event.

Parameters

callback
sourceFile
requestingMethod
subscribingSourceLine

Returns

SubscribeOnce()

SubscriptionToken PeanutButter.TinyEventAggregator.EventBase< TPayload >.SubscribeOnce	(	Action< TPayload >	action,
		[CallerFilePath] string	sourceFile = "",
		[CallerMemberName] string	requestingMethod = "(unknown)",
		[CallerLineNumber] int	subscribingSourceLine = -1 )

Subscribe to the event for one iteration only.

Parameters

action
sourceFile
requestingMethod
subscribingSourceLine

Returns

Unsubscribe()

void PeanutButter.TinyEventAggregator.EventBase< TPayload >.Unsubscribe	(	SubscriptionToken	token,
		[CallerFilePath] string	sourceFile = "",
		[CallerMemberName] string	requestingMethod = "(unknown)",
		[CallerLineNumber] int	unsubscribingSourceLine = -1 )

Unsubscribe from this event with the provided token.

Parameters

token
sourceFile
requestingMethod
unsubscribingSourceLine

Exceptions

ArgumentNullException

---

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

• source/TinyEventAggregator/PeanutButter.TinyEventAggregator/EventBaseWithPayload.cs