Overview

A base class for a class that receives notification callbacks from a controller.

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

#include <rdmnet/cpp/controller.h>

Public Member Functions
virtual void	HandleConnectedToBroker (Handle controller_handle, ScopeHandle scope_handle, const ClientConnectedInfo &info)=0
	A controller has successfully connected to a broker. More...

virtual void	HandleBrokerConnectFailed (Handle controller_handle, ScopeHandle scope_handle, const ClientConnectFailedInfo &info)=0
	A connection attempt failed between a controller and a broker. More...

virtual void	HandleDisconnectedFromBroker (Handle controller_handle, ScopeHandle scope_handle, const ClientDisconnectedInfo &info)=0
	A controller which was previously connected to a broker has disconnected. More...

virtual void	HandleClientListUpdate (Handle controller_handle, ScopeHandle scope_handle, client_list_action_t list_action, const RptClientList &list)=0
	A client list update has been received from a broker. More...

virtual void	HandleRdmResponse (Handle controller_handle, ScopeHandle scope_handle, const RdmResponse &resp)=0
	An RDM response has been received. More...

virtual void	HandleRptStatus (Handle controller_handle, ScopeHandle scope_handle, const RptStatus &status)=0
	An RPT status message has been received in response to a previously-sent RDM command. More...

virtual void	HandleResponderIdsReceived (Handle controller_handle, ScopeHandle scope_handle, const DynamicUidAssignmentList &list)
	A set of previously-requested mappings of dynamic UIDs to responder IDs has been received. More...

Member Function Documentation

◆ HandleBrokerConnectFailed()

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

pure virtual

A connection attempt failed between a controller and a broker.

Parameters

controller_handle	Handle to controller 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::Controller::NotifyHandler::HandleClientListUpdate	(	Handle	controller_handle,
		ScopeHandle	scope_handle,
		client_list_action_t	list_action,
		const RptClientList &	list
	)

pure virtual

A client list update has been received from a broker.

Parameters

controller_handle	Handle to controller 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 controller's cached list.
list	The list of updates.

◆ HandleConnectedToBroker()

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

pure virtual

A controller has successfully connected to a broker.

Parameters

controller_handle	Handle to controller instance which has connected.
scope_handle	Handle to the scope on which the controller has connected.
info	More information about the successful connection.

◆ HandleDisconnectedFromBroker()

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

pure virtual

A controller which was previously connected to a broker has disconnected.

Parameters

controller_handle	Handle to controller instance which has disconnected.
scope_handle	Handle to the scope on which the disconnect occurred.
info	More information about the disconnect event.

◆ HandleRdmResponse()

virtual void rdmnet::Controller::NotifyHandler::HandleRdmResponse	(	Handle	controller_handle,
		ScopeHandle	scope_handle,
		const RdmResponse &	resp
	)

pure virtual

An RDM response has been received.

Parameters

controller_handle	Handle to controller instance which has received the RDM response.
scope_handle	Handle to the scope on which the RDM response was received.
resp	The RDM response data.

◆ HandleResponderIdsReceived()

virtual void rdmnet::Controller::NotifyHandler::HandleResponderIdsReceived	(	Handle	controller_handle,
		ScopeHandle	scope_handle,
		const DynamicUidAssignmentList &	list
	)

inlinevirtual

A set of previously-requested mappings of dynamic UIDs to responder IDs has been received.

This callback does not need to be implemented if the controller implementation never intends to request responder IDs.

Parameters

controller_handle	Handle to controller instance which has received the responder IDs.
scope_handle	Handle to the scope on which the responder IDs were received.
list	The list of dynamic UID to responder ID mappings.

◆ HandleRptStatus()

virtual void rdmnet::Controller::NotifyHandler::HandleRptStatus	(	Handle	controller_handle,
		ScopeHandle	scope_handle,
		const RptStatus &	status
	)

pure virtual

An RPT status message has been received in response to a previously-sent RDM command.

Parameters

controller_handle	Handle to controller instance which has received the RPT status message.
scope_handle	Handle to the scope on which the RPT status message was received.
status	The RPT status data.

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

include/rdmnet/cpp/controller.h

Overview

Public Member Functions

Member Function Documentation

◆ HandleBrokerConnectFailed()

◆ HandleClientListUpdate()

◆ HandleConnectedToBroker()

◆ HandleDisconnectedFromBroker()

◆ HandleRdmResponse()

◆ HandleResponderIdsReceived()

◆ HandleRptStatus()