rdmnet::Device::NotifyHandler Class Reference

Overview

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

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

#include <rdmnet/cpp/device.h>

Public Member Functions
virtual void	HandleConnectedToBroker (Handle handle, const ClientConnectedInfo &info)=0
	A device has successfully connected to a broker. More...
virtual void	HandleBrokerConnectFailed (Handle handle, const ClientConnectFailedInfo &info)=0
	A connection attempt failed between a device and a broker. More...
virtual void	HandleDisconnectedFromBroker (Handle handle, const ClientDisconnectedInfo &info)=0
	A device which was previously connected to a broker has disconnected. More...
virtual RdmResponseAction	HandleRdmCommand (Handle handle, const RdmCommand &cmd)=0
	An RDM command has been received addressed to a device. More...
virtual RdmResponseAction	HandleLlrpRdmCommand (Handle handle, const llrp::RdmCommand &cmd)=0
	An RDM command has been received over LLRP, addressed to a device. More...
virtual void	HandleDynamicUidStatus (Handle handle, const DynamicUidAssignmentList &list)
	The dynamic UID assignment status for a set of virtual responders has been received. More...

Member Function Documentation

HandleBrokerConnectFailed()

virtual void rdmnet::Device::NotifyHandler::HandleBrokerConnectFailed ( Handle  handle, const ClientConnectFailedInfo &  info  )

pure virtual

A connection attempt failed between a device and a broker.

Parameters

handle	Handle to device instance which has failed to connect.
info	More information about the failed connection.

HandleConnectedToBroker()

virtual void rdmnet::Device::NotifyHandler::HandleConnectedToBroker ( Handle  handle, const ClientConnectedInfo &  info  )

pure virtual

A device has successfully connected to a broker.

Parameters

handle	Handle to device instance which has connected.
info	More information about the successful connection.

HandleDisconnectedFromBroker()

virtual void rdmnet::Device::NotifyHandler::HandleDisconnectedFromBroker ( Handle  handle, const ClientDisconnectedInfo &  info  )

pure virtual

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

Parameters

handle	Handle to device instance which has disconnected.
info	More information about the disconnect event.

HandleDynamicUidStatus()

virtual void rdmnet::Device::NotifyHandler::HandleDynamicUidStatus ( Handle  handle, const DynamicUidAssignmentList &  list  )

inlinevirtual

The dynamic UID assignment status for a set of virtual responders has been received.

This callback need only be implemented if adding virtual responders with dynamic UIDs. See Devices and Gateways and Using the Device API for more information.

Note that the list may indicate failed assignments for some or all responders, with a status code.

Parameters

handle	Handle to device instance which has received the dynamic UID assignments.
list	The list of dynamic UID assignments.

HandleLlrpRdmCommand()

virtual RdmResponseAction rdmnet::Device::NotifyHandler::HandleLlrpRdmCommand ( Handle  handle, const llrp::RdmCommand &  cmd  )

pure virtual

An RDM command has been received over LLRP, addressed to a device.

Parameters

handle	Handle to device instance which has received the RDM command.
cmd	The RDM command data.

Returns

The action to take in response to this LLRP RDM command.

HandleRdmCommand()

virtual RdmResponseAction rdmnet::Device::NotifyHandler::HandleRdmCommand ( Handle  handle, const RdmCommand &  cmd  )

pure virtual

An RDM command has been received addressed to a device.

Parameters

handle	Handle to device instance which has received the RDM command.
cmd	The RDM command data.

Returns

The action to take in response to this RDM command.

---

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

• include/rdmnet/cpp/device.h