fge::BaseSubscription Class Reference

Inheritance diagram for fge::BaseSubscription:

Public Types
using	SubscriberCount = unsigned int

Protected Member Functions
virtual void	onDetach (fge::Subscriber *subscriber)=0
	Callback called when a subscriber is detached.
virtual void	detachAll ()=0
	Detach all subscribers.
virtual bool	detach (fge::Subscriber *subscriber)=0
	Detach a specific subscriber.
virtual SubscriberCount	detachOnce (fge::Subscriber *subscriber)=0
	Detach only once a specific subscriber.
virtual SubscriberCount	attach (fge::Subscriber *subscriber)=0
	Attach a specific subscriber.
virtual SubscriberCount	getCount (fge::Subscriber *subscriber) const =0
	Get the SubscriberCount of a specific subscriber.

Friends
class	fge::Subscriber

Member Function Documentation

attach()

virtual SubscriberCount fge::BaseSubscription::attach ( fge::Subscriber * subscriber )

protectedpure virtual

Attach a specific subscriber.

You can't directly attach a nullptr global scope subscriber. But if you do, this function will do nothing and return 1 as the SubscriberCount.

Parameters

subscriber

The subscriber to attach

Returns

The SubscriberCount

Implemented in fge::Subscription, and fge::UniqueSubscription.

detach()

virtual bool fge::BaseSubscription::detach ( fge::Subscriber * subscriber )

protectedpure virtual

Detach a specific subscriber.

Detaching a nullptr global scope subscriber will do nothing.

Parameters

subscriber

The subscriber to detach

Returns

true if the subscriber was detached, false otherwise

Implemented in fge::Subscription, and fge::UniqueSubscription.

detachAll()

virtual void fge::BaseSubscription::detachAll ( )

protectedpure virtual

Detach all subscribers.

Implemented in fge::Subscription, and fge::UniqueSubscription.

detachOnce()

virtual SubscriberCount fge::BaseSubscription::detachOnce ( fge::Subscriber * subscriber )

protectedpure virtual

Detach only once a specific subscriber.

You can attach a subscriber multiple times, and it will augment the SubscriberCount. This function will only detach one time the subscriber and decrement the SubscriberCount. If the SubscriberCount is 0, the subscriber will be detached.

Parameters

subscriber

The subscriber to detach

Returns

The remaining SubscriberCount

Implemented in fge::Subscription, and fge::UniqueSubscription.

getCount()

virtual SubscriberCount fge::BaseSubscription::getCount ( fge::Subscriber * subscriber ) const

nodiscardprotectedpure virtual

Get the SubscriberCount of a specific subscriber.

Parameters

subscriber

The subscriber to get the SubscriberCount

Returns

The SubscriberCount

Implemented in fge::Subscription, and fge::UniqueSubscription.

onDetach()

virtual void fge::BaseSubscription::onDetach ( fge::Subscriber * subscriber )

protectedpure virtual

Callback called when a subscriber is detached.

The subscriber, at this point, can't be nullptr.

Parameters

subscriber

The subscriber that was detached

Implemented in fge::CallbackHandler< Types >, fge::CallbackHandler< ClientSharedPtr const & >, fge::CallbackHandler< ClientSharedPtr const &, fge::net::Identity const & >, fge::CallbackHandler< ClientSharedPtr, fge::net::Identity const & >, fge::CallbackHandler< Event >, fge::CallbackHandler< fge::Event const &, SDL_AudioDeviceEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_CommonEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_ControllerAxisEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_ControllerButtonEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_ControllerDeviceEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_DollarGestureEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_DropEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_EventType, fge::GuiElementContext & >, fge::CallbackHandler< fge::Event const &, SDL_JoyAxisEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_JoyBallEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_JoyButtonEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_JoyDeviceEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_JoyHatEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_KeyboardEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_MouseButtonEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_MouseButtonEvent const &, fge::GuiElementContext & >, fge::CallbackHandler< fge::Event const &, SDL_MouseMotionEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_MouseMotionEvent const &, fge::GuiElementContext & >, fge::CallbackHandler< fge::Event const &, SDL_MouseWheelEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_MouseWheelEvent const &, fge::GuiElementContext & >, fge::CallbackHandler< fge::Event const &, SDL_MultiGestureEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_QuitEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_SysWMEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_TextEditingEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_TextInputEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_TouchFingerEvent const & >, fge::CallbackHandler< fge::Event const &, SDL_WindowEvent const & >, fge::CallbackHandler< fge::GuiElementHandler const &, fge::Vector2f const & >, fge::CallbackHandler< fge::net::Client & >, fge::CallbackHandler< fge::net::ClientSideNetUdp & >, fge::CallbackHandler< fge::net::ClientSideNetUdp &, TransmitPacketPtr & >, fge::CallbackHandler< fge::ObjButton * >, fge::CallbackHandler< fge::ObjSelectBox &, std::size_t >, fge::CallbackHandler< fge::ObjTextInputBox & >, fge::CallbackHandler< fge::ObjWindow & >, fge::CallbackHandler< fge::Scene & >, fge::CallbackHandler< fge::Scene &, fge::ObjectDataShared const & >, fge::CallbackHandler< fge::Scene &, fge::ObjectPlan >, fge::CallbackHandler< fge::Scene const &, fge::RenderTarget & >, fge::CallbackHandler< fge::TaskHandler & >, fge::CallbackHandler< fge::Timer & >, fge::CallbackHandler< fge::Vector2f const & >, fge::CallbackHandler< float >, fge::UniqueCallbackHandler< Types >, fge::UniqueCallbackHandler< ClientSharedPtr const &, fge::net::Identity const & >, fge::UniqueCallbackHandler< ClientSharedPtr const &, fge::net::Identity const &, ReceivedPacketPtr const & >, fge::UniqueCallbackHandler< ClientSharedPtr const &, fge::net::Identity const &, uint16_t >, fge::UniqueCallbackHandler< ClientSharedPtr const &, fge::net::Identity const &, uint16_t, ObjectSid, ObjectSid, ReceivedPacketPtr const & >, and fge::UniqueCallbackHandler< ClientSharedPtr const &, fge::net::Identity const &, uint16_t, ReceivedPacketPtr const & >.

---

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

• C_subscription.hpp