rdmnet::EptClient::NotifyHandler Class Reference

Overview

A base class for a class that receives notification callbacks from an EPT client.

See Using the EPT Client API for details of how to use this API.

#include <rdmnet/cpp/ept_client.h>

Public Member Functions
virtual void	HandleConnectedToBroker (Handle client_handle, ScopeHandle scope_handle, const ClientConnectedInfo &info)=0
	An EPT client has successfully connected to a broker. More...
virtual void	HandleBrokerConnectFailed (Handle client_handle, ScopeHandle scope_handle, const ClientConnectFailedInfo &info)=0
	A connection attempt failed between an EPT client and a broker. More...
virtual void	HandleDisconnectedFromBroker (Handle client_handle, ScopeHandle scope_handle, const ClientDisconnectedInfo &info)=0
	An EPT client which was previously connected to a broker has disconnected. More...
virtual void	HandleClientListUpdate (Handle client_handle, ScopeHandle scope_handle, client_list_action_t list_action, const EptClientList &list)=0
	A client list update has been received from a broker. More...
virtual EptResponseAction	HandleEptData (Handle client_handle, ScopeHandle scope_handle, const EptData &data)=0
	EPT data has been received addressed to an EPT client. More...
virtual void	HandleEptStatus (Handle client_handle, ScopeHandle scope_handle, const EptStatus &status)=0
	An EPT status message has been received in response to a previously-sent EPT data message. More...

Member Function Documentation

HandleBrokerConnectFailed()

virtual void rdmnet::EptClient::NotifyHandler::HandleBrokerConnectFailed ( Handle  client_handle, ScopeHandle  scope_handle, const ClientConnectFailedInfo &  info  )

pure virtual

A connection attempt failed between an EPT client and a broker.

Parameters

client_handle	Handle to EPT client instance which has failed to connect.
scope_handle	Handle to the scope on which the connection failed.
info	More information about the failed connection.

HandleClientListUpdate()

virtual void rdmnet::EptClient::NotifyHandler::HandleClientListUpdate ( Handle  client_handle, ScopeHandle  scope_handle, client_list_action_t  list_action, const EptClientList &  list  )

pure virtual

A client list update has been received from a broker.

Parameters

client_handle	Handle to EPT client instance which has received the client list update.
scope_handle	Handle to the scope on which the client list update was received.
list_action	The way the updates in client_list should be applied to the EPT client's cached list.
list	The list of updates.

HandleConnectedToBroker()

virtual void rdmnet::EptClient::NotifyHandler::HandleConnectedToBroker ( Handle  client_handle, ScopeHandle  scope_handle, const ClientConnectedInfo &  info  )

pure virtual

An EPT client has successfully connected to a broker.

Parameters

client_handle	Handle to EPT client instance which has connected.
scope_handle	Handle to the scope on which the EPT client has connected.
info	More information about the successful connection.

HandleDisconnectedFromBroker()

virtual void rdmnet::EptClient::NotifyHandler::HandleDisconnectedFromBroker ( Handle  client_handle, ScopeHandle  scope_handle, const ClientDisconnectedInfo &  info  )

pure virtual

An EPT client which was previously connected to a broker has disconnected.

Parameters

client_handle	Handle to EPT client instance which has disconnected.
scope_handle	Handle to the scope on which the disconnect occurred.
info	More information about the disconnect event.

HandleEptData()

virtual EptResponseAction rdmnet::EptClient::NotifyHandler::HandleEptData ( Handle  client_handle, ScopeHandle  scope_handle, const EptData &  data  )

pure virtual

EPT data has been received addressed to an EPT client.

Parameters

client_handle	Handle to EPT client instance which has received the data.
scope_handle	Handle to the scope on which the EPT data was received.
data	The EPT data.

Returns

The action to take in response to this EPT data message.

HandleEptStatus()

virtual void rdmnet::EptClient::NotifyHandler::HandleEptStatus ( Handle  client_handle, ScopeHandle  scope_handle, const EptStatus &  status  )

pure virtual

An EPT status message has been received in response to a previously-sent EPT data message.

Parameters

client_handle	Handle to EPT client instance which has received the data.
scope_handle	Handle to the scope on which the EPT status message was received.
status	The EPT status message.

---

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

• include/rdmnet/cpp/ept_client.h