ZDK
Public Member Functions | List of all members
ZDK::ISIPProbeEventsHandler Class Referenceabstract
Inheritance diagram for ZDK::ISIPProbeEventsHandler:
ZDK::IEventHandle

Public Member Functions

virtual void OnProbeError (ZDK::Shared::Account account, ZDK::ProbeState curState, ZDK::Shared::ExtendedError error)=0
 Notify if Probe error occurs. More...
 
virtual void OnProbeState (ZDK::Shared::Account account, ZDK::ProbeState newState)=0
 Notify if Probe change in state occurs. More...
 
virtual void OnProbeSuccess (ZDK::Shared::Account account, ZDK::TransportType transport)=0
 Notify if Probe was successful. More...
 
virtual void OnProbeFailed (ZDK::Shared::Account account, ZDK::Shared::ExtendedError error)=0
 Notify if Probe fails. More...
 
- Public Member Functions inherited from ZDK::IEventHandle
virtual ZDK::ZDKHandle EventHandle ()=0
 

Member Function Documentation

◆ OnProbeError()

virtual void ZDK::ISIPProbeEventsHandler::OnProbeError ( ZDK::Shared::Account  account,
ZDK::ProbeState  curState,
ZDK::Shared::ExtendedError  error 
)
pure virtual

Notify if Probe error occurs.

An error occured during user probing. The process might continue with a different protocol.

Parameters
[in]accountThe account
[in]curStateThe state that generated the error.
[in]errorCode of the error
See also
IAccount, IProbeState, IExtendedError

◆ OnProbeFailed()

virtual void ZDK::ISIPProbeEventsHandler::OnProbeFailed ( ZDK::Shared::Account  account,
ZDK::Shared::ExtendedError  error 
)
pure virtual

Notify if Probe fails.

The probing process was unsuccesful. The process has ended.

Parameters
[in]accountThe account
[in]errorThe final error code
See also
IAccount, IExtendedError

◆ OnProbeState()

virtual void ZDK::ISIPProbeEventsHandler::OnProbeState ( ZDK::Shared::Account  account,
ZDK::ProbeState  newState 
)
pure virtual

Notify if Probe change in state occurs.

The probing process has entered another stage

Parameters
[in]accountThe account
[in]newStateThe new state
See also
IAccount, IProbeState

◆ OnProbeSuccess()

virtual void ZDK::ISIPProbeEventsHandler::OnProbeSuccess ( ZDK::Shared::Account  account,
ZDK::TransportType  transport 
)
pure virtual

Notify if Probe was successful.

The probing was successful. The process has ended.

Parameters
[in]accountThe account
[in]transportThe recommended transport
See also
IAccount, ITransportType

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