client.h File Reference

Overview

API definitions used by RDMnet clients (controllers and devices)

#include <stdbool.h>
#include <stdint.h>
#include "etcpal/inet.h"
#include "etcpal/uuid.h"
#include "rdm/uid.h"
#include "rdmnet/common.h"

Go to the source code of this file.

Data Structures
struct	RdmnetSourceAddr
	The source address for an unsolicited RDM response generated by a local component. More...
struct	RdmnetDestinationAddr
	A destination address for an RDM command in RDMnet's RPT protocol. More...
struct	RdmnetClientConnectedInfo
	Information provided by the library about a successful RDMnet client connection. More...
struct	RdmnetClientConnectFailedInfo
	Information provided by the library about an unsuccessful RDMnet client connection. More...
struct	RdmnetClientDisconnectedInfo
	Information provided by the library about an RDMnet client connection that disconnected after a successful connection. More...
struct	RdmnetScopeConfig
	A set of configuration information for a single scope in which an RDMnet client is participating. More...

Macros
#define	RDMNET_CLIENT_SCOPE_INVALID   -1
	An invalid RDMnet client scope handle value.
#define	RDMNET_ADDR_TO_DEFAULT_RESPONDER(manu_id, dev_id)
	Initialize an RdmnetDestinationAddr with a default responder address. More...
#define	RDMNET_ADDR_TO_DEFAULT_RESPONDER_SUBDEV(manu_id, dev_id, subdevice)
	Initialize an RdmnetDestinationAddr with the address of a subdevice on a default responder. More...
#define	RDMNET_ADDR_TO_SUB_RESPONDER(rdmnet_manu, rdmnet_dev, endpoint, rdm_manu, rdm_dev)
	Initialize an RdmnetDestinationAddr with the address of a sub-responder on a component. More...
#define	RDMNET_ADDR_TO_SUB_RESPONDER_SUBDEV(rdmnet_manu, rdmnet_dev, endpoint, rdm_manu, rdm_dev, subdevice)
	Initialize an RdmnetDestinationAddr with the address of a subdevice on a sub-responder. More...
#define	RDMNET_SCOPE_CONFIG_DEFAULT_INIT
	A default-value initializer for an RdmnetScopeConfig struct. More...
#define	RDMNET_CLIENT_SET_SCOPE(configptr, scope_str)
	Initialize an RdmnetScopeConfig struct with a scope string. More...
#define	RDMNET_CLIENT_SET_DEFAULT_SCOPE(configptr)
	Initialize an RdmnetScopeConfig struct with the default RDMnet scope. More...
#define	RDMNET_CLIENT_SET_STATIC_SCOPE(configptr, scope_str, broker_addr)
	Initialize an RdmnetScopeConfig struct with a scope string and static broker address. More...
#define	RDMNET_CLIENT_SET_STATIC_DEFAULT_SCOPE(configptr, broker_addr)
	Initialize an RdmnetScopeConfig struct with the default RDMnet scope and a static broker address. More...

Typedefs
typedef int	rdmnet_client_scope_t
	A handle to a scope that an RDMnet client participates in.
typedef struct RdmnetSourceAddr	RdmnetSourceAddr
	The source address for an unsolicited RDM response generated by a local component. More...
typedef struct RdmnetDestinationAddr	RdmnetDestinationAddr
	A destination address for an RDM command in RDMnet's RPT protocol. More...
typedef struct RdmnetClientConnectedInfo	RdmnetClientConnectedInfo
	Information provided by the library about a successful RDMnet client connection.
typedef struct RdmnetClientConnectFailedInfo	RdmnetClientConnectFailedInfo
	Information provided by the library about an unsuccessful RDMnet client connection.
typedef struct RdmnetClientDisconnectedInfo	RdmnetClientDisconnectedInfo
	Information provided by the library about an RDMnet client connection that disconnected after a successful connection.
typedef struct RdmnetScopeConfig	RdmnetScopeConfig
	A set of configuration information for a single scope in which an RDMnet client is participating.

Enumerations
enum	client_list_action_t {   kRdmnetClientListAppend = VECTOR_BROKER_CLIENT_ADD ,   kRdmnetClientListRemove = VECTOR_BROKER_CLIENT_REMOVE ,   kRdmnetClientListUpdate = VECTOR_BROKER_CLIENT_ENTRY_CHANGE ,   kRdmnetClientListReplace = VECTOR_BROKER_CONNECTED_CLIENT_LIST }
	How to apply the client entries to the existing client list in a client_list_update_received callback. More...