Kea 3.1.1
isc::ping_check::SocketCallback Class Reference

Functor associated with the socket object. More...

#include <ping_channel.h>

Public Member Functions

 SocketCallback (SocketCallbackFunction socket_callback)
 Constructor.
 
void operator() (boost::system::error_code ec, size_t length=0)
 Operator called when event associated with a socket occurs.
 

Detailed Description

Functor associated with the socket object.

This functor calls a callback function specified in the constructor.

Definition at line 33 of file ping_channel.h.

Constructor & Destructor Documentation

◆ SocketCallback()

isc::ping_check::SocketCallback::SocketCallback ( SocketCallbackFunction socket_callback)
inlineexplicit

Constructor.

Parameters
socket_callbackCallback to be invoked by the functor upon an event associated with the socket.

Definition at line 39 of file ping_channel.h.

Member Function Documentation

◆ operator()()

void isc::ping_check::SocketCallback::operator() ( boost::system::error_code ec,
size_t length = 0 )
inline

Operator called when event associated with a socket occurs.

This operator returns immediately when received boost::system::error_code is equal to boost::asio::error::operation_aborted.

Parameters
ecError code.
lengthData length.

Definition at line 50 of file ping_channel.h.


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