coral::bus::PendingSlaveControlConnection Class Reference

A handle for a pending connection to a slave. More...

#include "coral/bus/slave_control_messenger.hpp"

Public Member Functions
void	Close ()
	Aborts the connection attempt and calls the completion handler with an error code. More...
	operator bool () const CORAL_NOEXCEPT
	Returns whether this object refers to a pending connection. More...

Detailed Description

A handle for a pending connection to a slave.

This type is moveable, non-copyable and default-constructible. See ConnectToSlave() for more information about its use.

Member Function Documentation

void coral::bus::PendingSlaveControlConnection::Close

(

)

Aborts the connection attempt and calls the completion handler with an error code.

If the connection has already been completed and control of it passed into a SlaveControlConnection handle (i.e., the completion handler has been called), this operation has no effect.

coral::bus::PendingSlaveControlConnection::operator bool

(

)

const

Returns whether this object refers to a pending connection.

This is true from the moment the object is created (by ConnectToSlave()) up to (but not including) the point at which the completion handler is called.

---

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

• coral/bus/slave_control_messenger.hpp