Ocean::Network::SocketScheduler Class Reference

This class implements a high performance scheduler for socket events. More...

#include <SocketScheduler.h>

Inheritance diagram for Ocean::Network::SocketScheduler:

Protected Types
using	SocketSet = std::unordered_set< Socket * >
	Definition of a set holding socket pointers.
Protected Types inherited from Ocean::Thread
using	TimedJoinPair = std::pair< pthread_t, bool >
	Definition of a pair holding a thread id and a boolean state.
enum	ThreadPriority {   PRIORITY_IDLE , PRIORTY_BELOW_NORMAL , PRIORTY_NORMAL , PRIORTY_ABOVE_NORMAL ,   PRIORTY_HIGH , PRIORTY_REALTIME }
	Definition of different thread priority values. More...

Protected Member Functions
	SocketScheduler ()
	Creates a new scheduler object.
	~SocketScheduler () override
	Destructs a scheduler object.
void	registerSocket (Socket &socket)
	Register socket.
void	unregisterSocket (Socket &socket)
	Unregister socket.
bool	isSocketUnregistered (Socket &socket) const
	Checks whether a specific socket has been unregistered successfully.
void	threadRun () override
	The internal run function.
Protected Member Functions inherited from Ocean::Singleton< SocketScheduler >
	Singleton ()=default
	Default constructor.
Protected Member Functions inherited from Ocean::Thread
	Thread (const Thread &thread)=delete
	Disabled copy constructor.
void	createThread ()
	Creates the thread itself.
void	destroyThread ()
	Destroys the thread itself.
void	stopThreadExplicitly (const unsigned int timeout=5000u)
	Tries to stop the thread gracefully.
Thread &	operator= (const Thread &thread)=delete
	The disabled assign operator.
	Thread (const std::string &name=std::string())
	Creates a new thread object.
	Thread (const unsigned int randomNumberSeedValue, const std::string &name=std::string())
	Creates a new thread object.
virtual	~Thread ()
	Destructs a thread object.
bool	startThread ()
	Starts the thread.
void	stopThread ()
	Informs the thread to stop.
bool	terminateThread ()
	Terminates the thread.
bool	joinThread (const unsigned int timeout=(unsigned int)(-1))
	Waits until this thread has been stopped.
bool	shouldThreadStop () const
	Returns whether this thread should stop.
bool	isThreadInvokedToStart () const
	Returns whether this thread has been invoked to start immediately.
bool	isThreadActive () const
	Returns whether this thread is active.

Protected Attributes
SocketSet	activeSockets_
	The active sockets of this scheduler.
SocketSet	registerSockets_
	The set of sockets which are requested to be registered.
SocketSet	unregisterSockets_
	The set of sockets which are requested to be unregistered.
Lock	lock_
	The lock of this scheduler.

Friends
class	Socket
class	Singleton< SocketScheduler >

Additional Inherited Members
Static Public Member Functions inherited from Ocean::Singleton< SocketScheduler >
static SocketScheduler &	get ()
	Returns a reference to the unique object.
Static Protected Member Functions inherited from Ocean::Thread
static void	sleep (unsigned int ms)
	Sleeps the calling thread for a given time.
static void	giveUp ()
	Gives up the remaining thread time.
static ThreadId	currentThreadId ()
	Returns the thread id of the current (calling) thread.
static ThreadPriority	threadPriority ()
	Returns the priority of the current thread.
static bool	setThreadPriority (const ThreadPriority priority)
	Sets the priority of the current thread.
template<typename TObject , typename TExpectedValue >
static bool	waitForValue (TObject &object, const TExpectedValue &expectedValue, const double timeout=-1.0)
	Waits until an object/variable has an expected value.
template<typename TObject , typename TExpectedValue >
static bool	waitForValue (TObject &object, const TExpectedValue &expectedValue, TemporaryScopedLock &temporaryScopedLock, const double timeout=-1.0)
	Waits until an object/variable has an expected value.
static int	pthread_timedjoin_np (pthread_t thread, void **retval, const struct timespec *abstime)
	Implements a thread join function with timeout value.

Detailed Description

This class implements a high performance scheduler for socket events.

Member Typedef Documentation

SocketSet

using Ocean::Network::SocketScheduler::SocketSet = std::unordered_set<Socket*>

protected

Definition of a set holding socket pointers.

Constructor & Destructor Documentation

SocketScheduler()

Ocean::Network::SocketScheduler::SocketScheduler ( )

protected

Creates a new scheduler object.

~SocketScheduler()

Ocean::Network::SocketScheduler::~SocketScheduler ( )

overrideprotected

Destructs a scheduler object.

Member Function Documentation

isSocketUnregistered()

bool Ocean::Network::SocketScheduler::isSocketUnregistered ( Socket &  socket ) const

protected

Checks whether a specific socket has been unregistered successfully.

Parameters

socket

The socket which is checked

Returns

True, if the socket has been unregistered successfully

registerSocket()

void Ocean::Network::SocketScheduler::registerSocket ( Socket &  socket )

protected

Register socket.

Parameters

socket

The socket to be registered

threadRun()

void Ocean::Network::SocketScheduler::threadRun ( )

overrideprotectedvirtual

The internal run function.

Implements Ocean::Thread.

unregisterSocket()

void Ocean::Network::SocketScheduler::unregisterSocket ( Socket &  socket )

protected

Unregister socket.

Beware: The unregister process is not completed immediately!

Parameters

socket

The socket to be unregistered

Friends And Related Symbol Documentation

Singleton< SocketScheduler >

friend class Singleton< SocketScheduler >

friend

Socket

friend class Socket

friend

Field Documentation

activeSockets_

SocketSet Ocean::Network::SocketScheduler::activeSockets_

protected

The active sockets of this scheduler.

lock_

Lock Ocean::Network::SocketScheduler::lock_

mutableprotected

The lock of this scheduler.

registerSockets_

SocketSet Ocean::Network::SocketScheduler::registerSockets_

protected

The set of sockets which are requested to be registered.

unregisterSockets_

SocketSet Ocean::Network::SocketScheduler::unregisterSockets_

protected

The set of sockets which are requested to be unregistered.

---

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

• SocketScheduler.h