Wizt::VValue< VSocketAction > Class Reference

The actual information that is stored for a socket connection within a VObject. More...

#include <ocean/streams/VSocketAction.hpp>

Inheritance diagram for Wizt::VValue< VSocketAction >:

Public Member Functions
bool	addReceiver (int fd, const string &url, const RefPtr< VSocketAction::Receiver > &R)
	Adding a callback receiver object to a given socket descriptor under the given URL.
Ageable &	age () override
	Return the age of this value.
RefPtr< VValueBase >	copy () const override
	Create a copy of the respective value.
const type_info &	getType () const override
	Implement the virtual function to query the type ID of this value.
bool	getValue (VSocketAction &Variable) const override
	Implement the virtual function to get the current value.
WeakPtr< VValueCreator >	getValueCreator () const override
	Implementation of the function providing the associated value creator.
bool	getValueFrom (const WeakPtr< VValueBase > &V) override
	Implement the generic copy of a value.
int	iterate (const iterator &it)
	Iterate over all stored Receiver objects.
bool	listen (int port, const RefPtr< VSocketAction::Connector > &Obj)
	Listen to new connections dripping in.
int	nReceivers () const
	How many socket receivers are availabe?
	operator const VSocketAction & () const
	Read-only retrieval of the associated value.
	operator VSocketAction & ()
	Implicit type conversion allows modification of the associated value.
void	remove (int fd, const RefPtr< VSocketAction::Receiver > &R)
	Remove/shutdown/delete a connection.
bool	setValue (const VSocketAction &Variable) override
	Implement the assignment of the current value.
RefPtr< VManagedObject >	source () override
	In case this object is memory-managed, return its container.
string	Text () const override
	Provide textual representation.
	VValue (const VValue< VSocketAction > &V)
	Copy constructor.
Public Member Functions inherited from Wizt::VTypedValueBase< VSocketAction >
bool	isDifferentFrom (const WeakPtr< VValueBase, VValueBase > &V) const override
	Implement the comparison function from the VValueBase class utilizing the VValueCompareTrait type trait class.
	VTypedValueBase (const Ageable &A, const VTypedValueBase &V)
	Copy constructor, takes care of exported members.
Public Member Functions inherited from Wizt::VValueBase
virtual const Ageable &	age () const =0
	Constant read-only version to the age.
VValueBasePtr_t	component (const string &name) const
	Retrieve a certain component from a compound value.
int	copyComponents (const VValueBase &ValueSource)
	Copy the components from another VValueBase.
virtual WeakPtr< InterfaceBase >	getInterface () const
	In case this value refers to the interface of some VObject, then this function may return such.
virtual bool	getValueFrom (const WeakVValueBasePtr_t &V)=0
	Copy or cast a value from a possibly compatible type.
int	iterate (ComponentIterator &CI) const
	Find out which components are contained in the certain compound type.
size_t	nComponents () const
	How many components are available here?
bool	operator!= (const VValueBase &V) const
	Test for inequality.
bool	operator!= (const WeakPtr< VValueBase, VValueBase > &V) const
	Compare for equality with a value.
bool	operator== (const VValueBase &V) const
	Test for equality.
virtual bool	setSource (const WeakPtr< VManagedObject > &Owner)
	For special values which refer to the interface of another object, this function may allow to set another source for referencing such an interface.
	VValueBase ()
	Default Constructor.
	VValueBase (const VValueBase &)
	Copy Constructor.
	~VValueBase ()
	Destructor.
Public Member Functions inherited from MemCore::ReferenceBase< VValueBase >
auto	getObjectCountID () const noexcept
	Get a unique ID for this object in the given domain.
bool	isIdentical (const WeakPtr< VValueBase, VValueBase > &PossibleSelf) const noexcept
	Check if this object is identical to the one used by the given pointer.
void	mkAutoDestructive ()
	Marks this object as being automatically destructed, e.g.
refcount_t	refcount () const noexcept
	The strong reference count.
	ReferenceBase (VValueBase *that) noexcept
	Constructor, initializes reference counter to zero.
const auto &	self () const
	Return weak pointer to the object self.
refcount_t	wrefcount () const noexcept
	The weak reference count.
Public Member Functions inherited from MemCore::Ageable
	Ageable () noexcept
	Constructor; remembers birth time from current time counter.
constexpr	Ageable (age_t t) noexcept
	Constructor with explicit time value.
constexpr	Ageable (const Ageable &A) noexcept
	Copy constructor.
	Ageable (const volatile Ageable &A) noexcept
	Copy constructor.
constexpr const Ageable &	getAge () const
	Return reference to this age, useful for derived classes.
bool	isNewerThan (const Ageable &a) const noexcept
	Comparison operator.
bool	isOlderThan (const Ageable &a) const noexcept
	Comparison operator.
bool	isYoungerThan (const Ageable &a) const noexcept
	Comparison operator (alias to isNewerThan() ).
bool	operator!= (const Ageable &a) const noexcept
	Comparison operator.
bool	operator< (const Ageable &a) const noexcept
	Comparison operator.
bool	operator<= (const Ageable &a) const noexcept
	Comparision operator.
bool	operator<= (const volatile Ageable &a) const volatile noexcept
	Comparision operator.
bool	operator== (const Ageable &a) const noexcept
	Comparison operator.
bool	operator> (const Ageable &a) const noexcept
	Comparison operator.
bool	operator> (const volatile Ageable &a) const volatile throw ()
	Comparision operator.
bool	operator>= (const Ageable &a) const noexcept
	Comparision operator.
bool	operator>= (const volatile Ageable &a) const volatile noexcept
	Comparison operator.
constexpr void	resetAge () noexcept
	Set time value to InfinitelyOld().
void	setInfinitelyNew () noexcept
	Set time value to InfinitelyNew().
age_t	time_value () const noexcept
	Return an object's current age.
age_t	time_value () const volatile noexcept
	Return an object's current age.
Ageable &	touch () noexcept
	Mark the current object as being modified "now".
age_t	update (age_t age) noexcept
	Set the age of the current object to a specific age if that is newer than the current one.
age_t	update (const Ageable &Other) noexcept
	Set the age of the current object to the age of another object if that other one is newer than the current one.
age_t	update (const volatile Ageable &Other) volatile noexcept
	Set the age of the current object to the age of another object if that other one is newer than the current one.
	~Ageable () noexcept
	Destructor.
Public Member Functions inherited from Wizt::VAbstractValue< VSocketAction >
	VAbstractValue (const VAbstractValue &V)
	Copy constructor.

Additional Inherited Members
Public Types inherited from MemCore::ReferenceBase< VValueBase >
using	reference_domain_t
	The type of the base class.
using	SelfPtr_t
	Type for a pointer to this object itself.
Static Public Member Functions inherited from MemCore::Ageable
static const Ageable &	InfinitelyNew () noexcept
	Return a time that is infinitely in the future (well, sort of).
static constexpr const Ageable &	InfinitelyOld () noexcept
	Return a time that is infinitely in the past (well, sort of).
static age_t	now () noexcept
	Return the current global time.
Protected Member Functions inherited from MemCore::ReferenceBase< VValueBase >
virtual void	extremeUnction ()
	A virtual function that will be called just before the object is destroyed.
ReferenceBase &	operator= (const ReferenceBase &R)
	Protected assignment operator (should not be called).
void	suicide ()
	Delete this.
virtual	~ReferenceBase ()
	Virtual destructor.

Detailed Description

The actual information that is stored for a socket connection within a VObject.

This is actually a list of Receiver objects.

Note that there is no actual VSocketAction, but only a reference to such.

Member Function Documentation

addReceiver()

bool Wizt::VValue< VSocketAction >::addReceiver	(	int	fd,
		const string &	url,
		const RefPtr< VSocketAction::Receiver > &	R )

Adding a callback receiver object to a given socket descriptor under the given URL.

Parameters

fd	The socket descriptor
url	An url that is associated with this descriptor.

References VValue().

getType()

const type_info & Wizt::VValue< VSocketAction >::getType ( ) const

inlineoverridevirtual

Implement the virtual function to query the type ID of this value.

For this value, the type is fixed throughout its lifetime and corresponds to the type of the template argument.

Reimplemented from Wizt::VTypedValueBase< VSocketAction >.

getValue()

bool Wizt::VValue< VSocketAction >::getValue ( VSocketAction & Variable ) const

inlineoverridevirtual

Implement the virtual function to get the current value.

Returns

True on successfull retrieval, which is always the case in the default implementation of a stored value. However, derived values which implement a procedural value might return false here as well.

Parameters

Variable

The external storage space where to assign this value.

Implements Wizt::VTypedValueBase< VSocketAction >.

getValueCreator()

WeakPtr< VValueCreator > Wizt::VValue< VSocketAction >::getValueCreator ( ) const

inlineoverridevirtual

Implementation of the function providing the associated value creator.

Accessing the static member object enforces creation of this static class member, thus registration of the value creators in the registry.

Implements Wizt::VValueBase.

getValueFrom()

bool Wizt::VValue< VSocketAction >::getValueFrom ( const WeakPtr< VValueBase > & V )

inlineoverride

Implement the generic copy of a value.

Some derived class may also implement type conversions when the Type template parameter does not match exactly. E.g. a cast from float to int or vice versa might be done through this interface.

Returns

false, if the parameter could not be used for conversion.

listen()

bool Wizt::VValue< VSocketAction >::listen	(	int	port,
		const RefPtr< VSocketAction::Connector > &	Obj )

Listen to new connections dripping in.

Parameters

Obj	The callback object.

References VValue().

setValue()

bool Wizt::VValue< VSocketAction >::setValue ( const VSocketAction & Variable )

inlineoverridevirtual

Implement the assignment of the current value.

Parameters

Variable

The external storage space from where to assign this value.

Implements Wizt::VTypedValueBase< VSocketAction >.