utility::signals::LinkUnit Struct Reference

struct specifying actual link data between observers and subjects More...

#include <LinkUnit.hh>

Inheritance diagram for utility::signals::LinkUnit:

Public Member Functions
	LinkUnit (void *f)
	function pointer constructor More...
	~LinkUnit () override=default
	default destructor More...
template<typename Function >
Function &	fref ()
	return a reference to the function object with requested cast More...
template<typename Function , typename Signal >
void	send (Signal s)
	send a signal using the member function More...
Public Member Functions inherited from utility::VirtualBase
	VirtualBase ()=default
	Default constructor. More...
virtual	~VirtualBase ()=default
	The virtual destructor is one of the main reasons for the VirtualBase class. More...
	VirtualBase (VirtualBase const &)=default
	VirtualBase (VirtualBase &&)=default
VirtualBase &	operator= (VirtualBase const &)=default
VirtualBase &	operator= (VirtualBase &&)=default

Public Attributes
void *	fn
	the observer's member function More...
bool	valid
	connection still valid? More...
bool	blocked
	connection locally blocked? More...

Private Types
typedef utility::VirtualBase	Super

Private Member Functions
	LinkUnit ()
	disallow default constructor More...
	LinkUnit (LinkUnit const &rval)
	disallow copy constructor More...
LinkUnit &	operator= (LinkUnit const &rval)
	disallow copy assignment More...

Detailed Description

struct specifying actual link data between observers and subjects

Remarks

Used internally by SignalHub. There is no copy constructor and copy assignment, a LinkUnit is meant to be created only once for each connection.

Member Typedef Documentation

Super

typedef utility::VirtualBase utility::signals::LinkUnit::Super

private

Constructor & Destructor Documentation

LinkUnit() [1/3]

utility::signals::LinkUnit::LinkUnit ( )

private

disallow default constructor

LinkUnit() [2/3]

utility::signals::LinkUnit::LinkUnit ( LinkUnit const &  rval )

private

disallow copy constructor

LinkUnit() [3/3]

utility::signals::LinkUnit::LinkUnit ( void *  f )

inline

function pointer constructor

Parameters

f	pointer to function object with proper signature

~LinkUnit()

utility::signals::LinkUnit::~LinkUnit ( )

inlineoverridedefault

default destructor

Member Function Documentation

fref()

template<typename Function >

Function& utility::signals::LinkUnit::fref ( )

inline

return a reference to the function object with requested cast

References debug_assert, and fn.

operator=()

LinkUnit& utility::signals::LinkUnit::operator= ( LinkUnit const &  rval )

private

disallow copy assignment

send()

template<typename Function , typename Signal >

void utility::signals::LinkUnit::send ( Signal  s )

inline

send a signal using the member function

Template Parameters

the	boost function type
the	Signal to send, must match the necessary function signature

References blocked, debug_assert, fn, docking::s, and valid.

Member Data Documentation

blocked

bool utility::signals::LinkUnit::blocked

connection locally blocked?

Referenced by send().

fn

void* utility::signals::LinkUnit::fn

the observer's member function

dependent upon SignalHub to manage memory

Referenced by utility::signals::SignalHub< ReturnType, Signal >::deallocate(), fref(), and send().

valid

bool utility::signals::LinkUnit::valid

connection still valid?

Referenced by send().

---

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

• src/utility/signals/LinkUnit.hh