peak::core::DeviceReconnectInformation Class Reference

#include <peak/reconnect/reconnect_information.hpp>

Public Member Functions
	DeviceReconnectInformation ()=default
	DeviceReconnectInformation (const PEAK_DEVICE_RECONNECT_INFORMATION &cStruct)
	~DeviceReconnectInformation ()=default
	DeviceReconnectInformation (const DeviceReconnectInformation &)=default
	DeviceReconnectInformation (DeviceReconnectInformation &&)=default
DeviceReconnectInformation &	operator= (const DeviceReconnectInformation &)=default
DeviceReconnectInformation &	operator= (DeviceReconnectInformation &&)=default
bool	IsSuccessful () const
bool	IsRemoteDeviceAcquisitionRunning () const
bool	IsRemoteDeviceConfigurationRestored () const
PEAK_DEVICE_RECONNECT_ERROR_FLAGS	GetErrorFlags () const

Detailed Description

Reconnect information signaling the state of the Device after it has been reconnected.

Constructor & Destructor Documentation

DeviceReconnectInformation() [1/4]

peak::core::DeviceReconnectInformation::DeviceReconnectInformation ( )

default

DeviceReconnectInformation() [2/4]

peak::core::DeviceReconnectInformation::DeviceReconnectInformation ( const PEAK_DEVICE_RECONNECT_INFORMATION &  cStruct )

inlineexplicit

~DeviceReconnectInformation()

peak::core::DeviceReconnectInformation::~DeviceReconnectInformation ( )

default

DeviceReconnectInformation() [3/4]

peak::core::DeviceReconnectInformation::DeviceReconnectInformation ( const DeviceReconnectInformation &  )

default

DeviceReconnectInformation() [4/4]

peak::core::DeviceReconnectInformation::DeviceReconnectInformation ( DeviceReconnectInformation &&  )

default

Member Function Documentation

GetErrorFlags()

PEAK_DEVICE_RECONNECT_ERROR_FLAGS peak::core::DeviceReconnectInformation::GetErrorFlags ( ) const

inline

Returns error flags indicating the failed reconnect operation and the corresponding error.

If an error occurs during a reconnect this flag field indicates the failed reconnect operation as well as a more detailed error flag. Based on the error the users application can complete the missing reconnect operations, e.g. reallocating the buffers if the PEAK_DEVICE_RECONNECT_OPERATION_REMOTE_DEVICE_ACQUISITION_RESTART_PAYLOAD_SIZE_LARGER_THAN_BUFFERS flag is set.

IsRemoteDeviceAcquisitionRunning()

bool peak::core::DeviceReconnectInformation::IsRemoteDeviceAcquisitionRunning ( ) const

inline

Returns true if the remote device acquisition is running when the device got reconnected.

IsRemoteDeviceConfigurationRestored()

bool peak::core::DeviceReconnectInformation::IsRemoteDeviceConfigurationRestored ( ) const

inline

Returns true if the configuration of the remote device has been restored.

IsSuccessful()

bool peak::core::DeviceReconnectInformation::IsSuccessful ( ) const

inline

Returns true if no error occured during the reconnect

operator=() [1/2]

DeviceReconnectInformation & peak::core::DeviceReconnectInformation::operator= ( const DeviceReconnectInformation &  )

default

operator=() [2/2]

DeviceReconnectInformation & peak::core::DeviceReconnectInformation::operator= ( DeviceReconnectInformation &&  )

default

---

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

• peak/reconnect/reconnect_information.hpp