dnp3 (C++ API) 1.8.0-RC1
Loading...
Searching...
No Matches
dnp3::NextEndpointAction Class Reference

Action object used by ClientConnectionHandler.next() to specify the next connection attempt or sleep duration. More...

#include <dnp3.hpp>

Public Member Functions

 NextEndpointAction (NextEndpointAction &&other) noexcept
 Transfer ownership of the underlying C-type to this instance and invalidate the other instance. More...
 
ParamError connect_to (ConnectionInfo &info)
 Specify the next endpoint to attempt connection to. More...
 
ParamError sleep_for (std::chrono::steady_clock::duration duration)
 Indicate that the connection task should sleep for the specified duration. More...
 

Friends

class CppNextEndpointActionFriend
 

Detailed Description

Action object used by ClientConnectionHandler.next() to specify the next connection attempt or sleep duration.

Constructor & Destructor Documentation

◆ NextEndpointAction()

dnp3::NextEndpointAction::NextEndpointAction ( NextEndpointAction &&  other)
inlinenoexcept

Transfer ownership of the underlying C-type to this instance and invalidate the other instance.

Note
the moved class will now throw an exception if any method is called
Parameters
otherClass from which ownership will be transfer to this instance

Member Function Documentation

◆ connect_to()

ParamError dnp3::NextEndpointAction::connect_to ( ConnectionInfo &  info)

Specify the next endpoint to attempt connection to.

Parameters
infoConnection information including endpoint and optional parameters
Returns
Error status - Ok if successful

◆ sleep_for()

ParamError dnp3::NextEndpointAction::sleep_for ( std::chrono::steady_clock::duration  duration)

Indicate that the connection task should sleep for the specified duration.

Parameters
durationDuration to sleep
Returns
Error status - Ok if successful

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