Kea 2.5.8
isc::asiolink::IOService Class Reference

The IOService class is a wrapper for the ASIO io_service class. More...

#include <io_service.h>

Constructors and Destructor

Note: The copy constructor and the assignment operator are intentionally defined as private, making this class non-copyable.

 IOService ()
 The constructor.
 
 ~IOService ()
 The destructor.
 
void run ()
 Start the underlying event loop.
 
size_t runOne ()
 Run the underlying event loop for a single event.
 
size_t poll ()
 Run the underlying event loop for a ready events.
 
size_t pollOne ()
 Run the underlying event loop for a ready events.
 
void stop ()
 Stop the underlying event loop.
 
bool stopped () const
 Indicates if the IOService has been stopped.
 
void restart ()
 Restarts the IOService in preparation for a subsequent run() invocation.
 
void stopWork ()
 Removes IO service work object to let it finish running when all handlers have been invoked.
 
boost::asio::io_service & getInternalIOService ()
 Return the native io_service object used in this wrapper.
 
void post (const std::function< void()> &callback)
 Post a callback to the end of the queue.
 

Detailed Description

The IOService class is a wrapper for the ASIO io_service class.

Definition at line 33 of file io_service.h.

Constructor & Destructor Documentation

◆ IOService()

isc::asiolink::IOService::IOService ( )

The constructor.

Definition at line 122 of file io_service.cc.

◆ ~IOService()

isc::asiolink::IOService::~IOService ( )

The destructor.

Definition at line 125 of file io_service.cc.

Member Function Documentation

◆ getInternalIOService()

boost::asio::io_service & isc::asiolink::IOService::getInternalIOService ( )

Return the native io_service object used in this wrapper.

This is a short term work around to support other Kea modules that share the same io_service with the authoritative server. It will eventually be removed once the wrapper interface is generalized.

Definition at line 169 of file io_service.cc.

◆ poll()

size_t isc::asiolink::IOService::poll ( )

Run the underlying event loop for a ready events.

This method executes handlers for all ready events and returns. It will return immediately if there are no ready events.

Returns
The number of handlers that were executed.

Definition at line 139 of file io_service.cc.

◆ pollOne()

size_t isc::asiolink::IOService::pollOne ( )

Run the underlying event loop for a ready events.

This method executes handlers for all ready events and returns. It will return immediately if there are no ready events.

Returns
The number of handlers that were executed.

Definition at line 144 of file io_service.cc.

◆ post()

void isc::asiolink::IOService::post ( const std::function< void()> &  callback)

Post a callback to the end of the queue.

Requests the callback be called sometime later. It is not guaranteed by the underlying asio, but it can reasonably be expected the callback is put to the end of the callback queue. It is not called from within this function.

It may be used to implement "background" work, for example (doing stuff by small bits that are called from time to time).

Definition at line 174 of file io_service.cc.

◆ restart()

void isc::asiolink::IOService::restart ( )

Restarts the IOService in preparation for a subsequent run() invocation.

Definition at line 159 of file io_service.cc.

◆ run()

void isc::asiolink::IOService::run ( )

Start the underlying event loop.

This method does not return control to the caller until the stop() method is called via some handler.

Definition at line 129 of file io_service.cc.

◆ runOne()

size_t isc::asiolink::IOService::runOne ( )

Run the underlying event loop for a single event.

This method return control to the caller as soon as the first handler has completed. (If no handlers are ready when it is run, it will block until one is.)

Returns
The number of handlers that were executed.

Definition at line 134 of file io_service.cc.

◆ stop()

void isc::asiolink::IOService::stop ( )

Stop the underlying event loop.

This will return the control to the caller of the run() method.

Definition at line 149 of file io_service.cc.

◆ stopped()

bool isc::asiolink::IOService::stopped ( ) const

Indicates if the IOService has been stopped.

Returns
true if the IOService has been stopped, false otherwise.

Definition at line 154 of file io_service.cc.

◆ stopWork()

void isc::asiolink::IOService::stopWork ( )

Removes IO service work object to let it finish running when all handlers have been invoked.

Definition at line 164 of file io_service.cc.


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