UDP socket for use in a Reactor environment. More...

#include <tsReactiveUDPSocket.h>

Inheritance diagram for ts::ReactiveUDPSocket:

[legend]

Collaboration diagram for ts::ReactiveUDPSocket:

[legend]

Public Member Functions
	ReactiveUDPSocket (Reactor &reactor, UDPSocket &socket, Object *owner=nullptr)
	Constructor.

virtual	~ReactiveUDPSocket () override
	Destructor.

void	cancelSendReceive (bool silent=false)
	Cancel any pending send or receive operation on this socket.

bool	isOpen () const
	Check if the reactive socket is open.

bool	isOwned ()
	Check if the object is owned.

template<class OBJECT > requires std::derived_from<OBJECT, ts::Object>
bool	isOwned ()
	Check if the object is owned by an object of a given type.

Object *	owner ()
	Get the address of the optional "owner" object which was specified in the constructor.

template<class OBJECT > requires std::derived_from<OBJECT, ts::Object>
OBJECT *	owner ()
	Get the address of the "owner" object which was specified in the constructor.

Reactor &	reactor ()
	Get a reference to the associated reactor.

Report &	report ()
	Get a reference to the associated report.

UDPSocket &	socket ()
	Get a reference to the associated socket.

bool	startClose (ReactiveUDPHandlerInterface *handler, bool silent=false, const ObjectPtr &user_data=ObjectPtr())
	Start closing the socket.

bool	startReceive (ReactiveUDPHandlerInterface *handler, size_t max_message_size=IP_MAX_PACKET_SIZE, const ObjectPtr &user_data=ObjectPtr())
	Start the operation of receiving messages from the socket.

bool	startSend (ReactiveUDPHandlerInterface handler, const void data, size_t size, const IPSocketAddress &destination, const ObjectPtr &user_data=ObjectPtr())
	Start the operation of sending a message to a destination address and port.

bool	startSend (ReactiveUDPHandlerInterface handler, const void data, size_t size, const ObjectPtr &user_data=ObjectPtr())
	Start the operation of sending a message to the default destination address and port.

Protected Types
using	IOQueue = std::list< std::shared_ptr< IOSB > >
	Queues of I/O requests are queues of shared_ptr to IOSB.

using	IOSB = NonBlockingDevice::IOSB
	IOSB shortcut fpr subclasses.

using	IOSet = std::set< std::shared_ptr< IOSB > >
	Unordered set of I/O requests, set of shared_ptr to IOSB.

Protected Member Functions
bool	activateAsynchronousIO ()
	Activate notification for asynchronous I/O.

bool	activateReadReady ()
	Activate read-ready notification for non-blocking I/O.

bool	activateWriteReady ()
	Activate write-ready notification for non-blocking I/O.

bool	cancelAndWaitAsynchronousIO (NonBlockingDevice::IOSB &iosb, bool silent)
	Cancel one specific pending asynchronous I/O and wait for its completion.

void	cancelAsynchronousIO (bool silent)
	Cancel all asynchronous I/O in progress.

template<class REQUEST > requires std::derived_from<REQUEST, ts::Object>
void	cancelQueue (IOQueue &inqueue, IOQueue &outqueue)
	Transfer all requests from one queue to another and mark all I/O as canceled.

void	deactivateAll (bool silent)
	Deactivate all registrations for non-blocking and asynchronous I/O.

void	deactivateAsynchronousIO (bool silent)
	Deactivate notification for asynchronous I/O.

void	deactivateCompletedIO (bool silent)
	Deactivate the execution of processCompletedIO() in the context of a Reactor handler.

void	deactivateReadReady (bool silent)
	Deactivate read-ready notification for non-blocking I/O.

void	deactivateWriteReady (bool silent)
	Deactivate write-ready notification for non-blocking I/O.

virtual void	handleTimer (Reactor &reactor, EventId id)
	Handle a timer in a Reactor.

virtual void	handleUserEvent (Reactor &, EventId) override
	Handle a user-defined event in a Reactor.

std::shared_ptr< IOSB >	removeFromQueue (IOQueue &queue, IOSB *iosb)
	Search and remove a shared_ptr to IOSB, based on an IOSB address.

bool	signalCompletedIO ()
	Trigger the execution of processCompletedIO() in the context of a Reactor handler.

Detailed Description

UDP socket for use in a Reactor environment.

The class ReactiveUDPSocket is a wrapper around UDPSocket to handle reactive I/O.

The actual socket is a separate object. It is initialized and configured by the application. The application shall not directly call send(), receive(), or close() on this socket and delegate these operations to startSend(), startReceive(), and startClose() in class ReactiveUDPSocket.

Member Typedef Documentation

◆ IOQueue

using ts::ReactiveBase::IOQueue = std::list<std::shared_ptr<IOSB> >

protectedinherited

Queues of I/O requests are queues of shared_ptr to IOSB.

This is typically used with non-blocking I/O where we must process requests in order. Send and receive requests are structures which are stored in the react_data of the IOSB.

◆ IOSet

using ts::ReactiveBase::IOSet = std::set<std::shared_ptr<IOSB> >

protectedinherited

Unordered set of I/O requests, set of shared_ptr to IOSB.

This is typically used with asynchronous I/O. The ordering is enforced because I/O are started in order of calls from applications. The completion processing is likely the same, but driven by the system I/O Completion Ports and we must not assume any order. Send and receive requests are structures which are stored in the react_data of the IOSB.

Constructor & Destructor Documentation

◆ ReactiveUDPSocket()

ts::ReactiveUDPSocket::ReactiveUDPSocket	(	Reactor &	reactor,
		UDPSocket &	socket,
		Object *	owner = `nullptr`
	)

Constructor.

Parameters

[in,out]	reactor	Associated reactor. The reactor object must remain valid as long as this object is valid.
[in,out]	socket	Associated socket. The socket object must remain valid as long as this object is valid. The ReactiveUDPSocket must be initialized before the socket is opened.
[in]	owner	Optional address of an "owner" object, typically an instance of class containing this object.

Member Function Documentation

◆ socket()

UDPSocket & ts::ReactiveUDPSocket::socket ( )

inline

Get a reference to the associated socket.

Returns: A reference to the associated socket.

◆ isOpen()

bool ts::ReactiveUDPSocket::isOpen ( ) const

inline

Check if the reactive socket is open.

This is different from Socket::isOpen() during the closing phase, after startClose() has been called but before the underlying socket is fully closed.

Returns: True if the reactive socket is open, false if the underlying socket is closed or if startClose() has been called.

◆ startSend() [1/2]

bool ts::ReactiveUDPSocket::startSend	(	ReactiveUDPHandlerInterface *	handler,
		const void *	data,
		size_t	size,
		const IPSocketAddress &	destination,
		const ObjectPtr &	user_data = `ObjectPtr()`
	)

Start the operation of sending a message to a destination address and port.

Parameters

[in]	handler	Handler class to call when the send operation completes. The method handleUDPSend() will be called. If nullptr, no handler is called.
[in]	data	Address of the message to send. The corresponding memory area must remain valid until the completion or cancelation of the send operation.
[in]	size	Size in bytes of the message to send.
[in]	destination	Socket address of the destination. Both address and port are mandatory in the socket address, they cannot be set to IPAddress::AnyAddress4 or IPSocketAddress::AnyPort.
[in]	user_data	A shared pointer which will be passed unmodified to handler.

Returns: True on success, false on error. Success means that the I/O was successfully started. The final status of the I/O will be transmitted in the handler.

◆ startSend() [2/2]

bool ts::ReactiveUDPSocket::startSend	(	ReactiveUDPHandlerInterface *	handler,
		const void *	data,
		size_t	size,
		const ObjectPtr &	user_data = `ObjectPtr()`
	)

inline

Start the operation of sending a message to the default destination address and port.

Parameters

[in]	handler	Handler class to call when the send operation completes. The method handleUDPSend() will be called. If nullptr, no handler is called.
[in]	data	Address of the message to send. The corresponding memory area must remain valid until the completion or cancelation of the send operation.
[in]	size	Size in bytes of the message to send.
[in]	user_data	A shared pointer which will be passed unmodified to handler.

Returns: True on success, false on error. Success means that the I/O was successfully started. The final status of the I/O will be transmitted in the handler.

◆ startReceive()

bool ts::ReactiveUDPSocket::startReceive	(	ReactiveUDPHandlerInterface *	handler,
		size_t	max_message_size = `IP_MAX_PACKET_SIZE`,
		const ObjectPtr &	user_data = `ObjectPtr()`
	)

Start the operation of receiving messages from the socket.

Parameters

[in]	handler	Handler class to call each time a message is received. The method handleUDPReceive() will be called for each new datagram. Cannot be null. If a previous receive handler was registered, it is replaced.
[in]	max_message_size	Maximum incoming message size. Used as size of internal reception buffer. The default is the maximum IP packet size.
[in]	user_data	A shared pointer which will be passed unmodified to handler.

Returns: True on success, false on error. Success means that the I/O was successfully started. The final status of the I/O will be transmitted in the handler.

◆ cancelSendReceive()

void ts::ReactiveUDPSocket::cancelSendReceive ( bool silent = false )

Cancel any pending send or receive operation on this socket.

If a repeated reception operation is in progress, the repetition is canceled as well.

Parameters

[in] silent If true, do not report errors through the logger.

◆ startClose()

bool ts::ReactiveUDPSocket::startClose	(	ReactiveUDPHandlerInterface *	handler,
		bool	silent = `false`,
		const ObjectPtr &	user_data = `ObjectPtr()`
	)

Start closing the socket.

Pending asynchronous operations are canceled. The actual cancelation will take place later. In the meantime, the user's data buffers for these pending operations are busy and shall not be destroyed / deallocated by the application. The close operation terminates when the handler handleUDPClosed() is invoked. At this point, no more operation is pending and the application may get rid of data buffers.

Parameters

[in]	handler	Handler class to call when the close operation completes. The method handleUDPClosed() will be called. If nullptr, no handler is called.
[in]	silent	If true, do not report errors through the logger.
[in]	user_data	A shared pointer which will be passed unmodified to handler.

Returns: True on success, false on error.

◆ reactor()

Reactor & ts::ReactiveBase::reactor ( )

inlineinherited

Get a reference to the associated reactor.

Returns: A reference to the associated reactor.

◆ report()

Report & ts::ReactiveBase::report ( )

inlineinherited

Get a reference to the associated report.

Returns: A reference to the associated report.

◆ removeFromQueue()

std::shared_ptr< IOSB > ts::ReactiveBase::removeFromQueue	(	IOQueue &	queue,
		IOSB *	iosb
	)

protectedinherited

Search and remove a shared_ptr to IOSB, based on an IOSB address.

Search from the front (end) of the queue since a completed I/O is likely on the front.

Parameters

[in,out]	queue	The queue from which to remove iosb.
[in]	iosb	Standard pointer to an IOSB to search and remove.

Returns: The removed shared_ptr to IOSB, or a null pointer if iosb is not found.

◆ cancelQueue()

template<class REQUEST >
requires std::derived_from<REQUEST, ts::Object>

void ts::ReactiveBase::cancelQueue	(	IOQueue &	inqueue,
		IOQueue &	outqueue
	)

protectedinherited

Transfer all requests from one queue to another and mark all I/O as canceled.

Template Parameters

REQUEST The subclass of Object which is set in react_data of all requests in inqueue.

Parameters

[in,out]	inqueue	The queue from which all requests are removed.
[in,out]	outqueue	The queue which receives all canceled requests.

◆ signalCompletedIO()

bool ts::ReactiveBase::signalCompletedIO ( )

protectedinherited

Trigger the execution of processCompletedIO() in the context of a Reactor handler.

Create if necessary and then signal a dedicated user event.

Returns: True on success, false on error.

◆ deactivateCompletedIO()

void ts::ReactiveBase::deactivateCompletedIO ( bool silent )

protectedinherited

Deactivate the execution of processCompletedIO() in the context of a Reactor handler.

Deactivate and delete the dedicated user event.

Parameters

[in] silent If true, do not report errors through the logger.

◆ activateReadReady()

bool ts::ReactiveBase::activateReadReady ( )

protectedinherited

Activate read-ready notification for non-blocking I/O.

Returns: True on success, false on error.

◆ deactivateReadReady()

void ts::ReactiveBase::deactivateReadReady ( bool silent )

protectedinherited

Deactivate read-ready notification for non-blocking I/O.

Parameters

[in] silent If true, do not report errors through the logger.

◆ activateWriteReady()

bool ts::ReactiveBase::activateWriteReady ( )

protectedinherited

Activate write-ready notification for non-blocking I/O.

Returns: True on success, false on error.

◆ deactivateWriteReady()

void ts::ReactiveBase::deactivateWriteReady ( bool silent )

protectedinherited

Deactivate write-ready notification for non-blocking I/O.

Parameters

[in] silent If true, do not report errors through the logger.

◆ activateAsynchronousIO()

bool ts::ReactiveBase::activateAsynchronousIO ( )

protectedinherited

Activate notification for asynchronous I/O.

Returns: True on success, false on error.

◆ deactivateAsynchronousIO()

void ts::ReactiveBase::deactivateAsynchronousIO ( bool silent )

protectedinherited

Deactivate notification for asynchronous I/O.

Parameters

[in] silent If true, do not report errors through the logger.

◆ cancelAsynchronousIO()

void ts::ReactiveBase::cancelAsynchronousIO ( bool silent )

protectedinherited

Cancel all asynchronous I/O in progress.

The cancelation occurs in the background and end of canceled asynchronous I/O will be notified.

Parameters

[in] silent If true, do not report errors through the logger.

◆ cancelAndWaitAsynchronousIO()

bool ts::ReactiveBase::cancelAndWaitAsynchronousIO	(	NonBlockingDevice::IOSB &	iosb,
		bool	silent
	)

protectedinherited

Cancel one specific pending asynchronous I/O and wait for its completion.

Warning: This is a blocking call. It shall be used in case of trouble only.

Parameters

[in,out]	iosb	The asynchronous I/O status block.
[in]	silent	If true, do not report errors through the logger.

Returns: True on success, false on error.

◆ deactivateAll()

void ts::ReactiveBase::deactivateAll ( bool silent )

protectedinherited

Deactivate all registrations for non-blocking and asynchronous I/O.

Parameters

[in] silent If true, do not report errors through the logger.

◆ handleUserEvent()

virtual void ts::ReactiveBase::handleUserEvent	(	Reactor &	reactor,
		EventId	id
	)

overrideprotectedvirtualinherited

Handle a user-defined event in a Reactor.

Parameters

[in,out]	reactor	Reactor into which the handler is invoked.
[in]	id	Id of the event which was signaled.

Reimplemented from ts::ReactorHandlerInterface.

◆ owner() [1/2]

Object * ts::OwnedObject::owner ( )

inlineinherited

Get the address of the optional "owner" object which was specified in the constructor.

Returns: Address of the "owner" object or a null pointer if there was none.

◆ owner() [2/2]

template<class OBJECT >
requires std::derived_from<OBJECT, ts::Object>

OBJECT * ts::OwnedObject::owner ( )

inherited

Get the address of the "owner" object which was specified in the constructor.

This template version requires that the owner objet is set and of type OBJECT, or some subclass of it. If there is no owner object or if it is not compatible with the template class OBJECT, this is a fatal error and the application is terminated.

Template Parameters

OBJECT A subclass of Object

Returns: Address of the "owner" object or a null pointer if there was none.

◆ isOwned() [1/2]

bool ts::OwnedObject::isOwned ( )

inlineinherited

Check if the object is owned.

Returns: True if this object has an owner, false otherwise.

◆ isOwned() [2/2]

template<class OBJECT >
requires std::derived_from<OBJECT, ts::Object>

bool ts::OwnedObject::isOwned ( )

inlineinherited

Check if the object is owned by an object of a given type.

Template Parameters

OBJECT A subclass of Object

Returns: True if this object has an owner by an object of type OBJECT, false otherwise.

◆ handleTimer()

virtual void ts::ReactorHandlerInterface::handleTimer	(	Reactor &	reactor,
		EventId	id
	)

virtualinherited

Handle a timer in a Reactor.

Parameters

[in,out]	reactor	Reactor into which the handler is invoked.
[in]	id	Id of the timer which expires.

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

tsReactiveUDPSocket.h

Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ IOQueue

◆ IOSet

Constructor & Destructor Documentation

◆ ReactiveUDPSocket()

Member Function Documentation

◆ socket()

◆ isOpen()

◆ startSend() [1/2]

◆ startSend() [2/2]

◆ startReceive()

◆ cancelSendReceive()

◆ startClose()

◆ reactor()

◆ report()

◆ removeFromQueue()

◆ cancelQueue()

◆ signalCompletedIO()

◆ deactivateCompletedIO()

◆ activateReadReady()

◆ deactivateReadReady()

◆ activateWriteReady()

◆ deactivateWriteReady()

◆ activateAsynchronousIO()

◆ deactivateAsynchronousIO()

◆ cancelAsynchronousIO()

◆ cancelAndWaitAsynchronousIO()

◆ deactivateAll()

◆ handleUserEvent()

◆ owner() [1/2]

◆ owner() [2/2]

◆ isOwned() [1/2]

◆ isOwned() [2/2]

◆ handleTimer()