ept_client.h File Reference

Overview

Definitions for the RDMnet EPT Client API.

#include "etcpal/uuid.h"
#include "rdmnet/client.h"
#include "rdmnet/common.h"
#include "rdmnet/message.h"

Go to the source code of this file.

Data Structures
struct	RdmnetEptClientCallbacks
	A set of notification callbacks received about an EPT client. More...
struct	RdmnetEptClientConfig
	A set of information that defines the startup parameters of an EPT client. More...

Macros
#define	RDMNET_EPT_CLIENT_INVALID   -1
	An invalid RDMnet EPT Client handle value.
#define	RDMNET_EPT_CLIENT_CONFIG_DEFAULT_INIT
	A default-value initializer for an RdmnetEptClientConfig struct. More...

Typedefs
typedef int	rdmnet_ept_client_t
	A handle to an RDMnet EPT Client.
typedef void(*	RdmnetEptClientConnectedCallback) (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t scope_handle, const RdmnetClientConnectedInfo *info, void *context)
	An EPT client has successfully connected to a broker. More...
typedef void(*	RdmnetEptClientConnectFailedCallback) (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t scope_handle, const RdmnetClientConnectFailedInfo *info, void *context)
	A connection attempt failed between an EPT client and a broker. More...
typedef void(*	RdmnetEptClientDisconnectedCallback) (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t scope_handle, const RdmnetClientDisconnectedInfo *info, void *context)
	An EPT client which was previously connected to a broker has disconnected. More...
typedef void(*	RdmnetEptClientClientListUpdateReceivedCallback) (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t scope_handle, client_list_action_t list_action, const RdmnetEptClientList *client_list, void *context)
	A client list update has been received from a broker. More...
typedef void(*	RdmnetEptClientDataReceivedCallback) (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t scope_handle, const RdmnetEptData *data, RdmnetSyncEptResponse *response, void *context)
	EPT data has been received addressed to an EPT client. More...
typedef void(*	RdmnetEptClientStatusReceivedCallback) (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t scope_handle, const RdmnetEptStatus *status, void *context)
	An EPT status message has been received in response to a previously-sent EPT data message. More...
typedef struct RdmnetEptClientCallbacks	RdmnetEptClientCallbacks
	A set of notification callbacks received about an EPT client.
typedef struct RdmnetEptClientConfig	RdmnetEptClientConfig
	A set of information that defines the startup parameters of an EPT client.

Functions
void	rdmnet_ept_client_config_init (RdmnetEptClientConfig *config)
	Initialize an RdmnetEptClientConfig with default values for the optional config options. More...
void	rdmnet_ept_client_set_callbacks (RdmnetEptClientConfig *config, RdmnetEptClientConnectedCallback connected, RdmnetEptClientConnectFailedCallback connect_failed, RdmnetEptClientDisconnectedCallback disconnected, RdmnetEptClientClientListUpdateReceivedCallback client_list_update_received, RdmnetEptClientDataReceivedCallback data_received, RdmnetEptClientStatusReceivedCallback status_received, void *context)
	Set the callbacks in an RDMnet EPT client configuration structure. More...
etcpal_error_t	rdmnet_ept_client_create (const RdmnetEptClientConfig *config, rdmnet_ept_client_t *handle)
	Create a new instance of RDMnet EPT client functionality. More...
etcpal_error_t	rdmnet_ept_client_destroy (rdmnet_ept_client_t client_handle, rdmnet_disconnect_reason_t disconnect_reason)
	Destroy an EPT client instance. More...
etcpal_error_t	rdmnet_ept_client_add_scope (rdmnet_ept_client_t client_handle, const RdmnetScopeConfig *scope_config, rdmnet_client_scope_t *scope_handle)
	Add a new scope to an EPT client instance. More...
etcpal_error_t	rdmnet_ept_client_add_default_scope (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t *scope_handle)
	Add a new scope representing the default RDMnet scope to an EPT client instance. More...
etcpal_error_t	rdmnet_ept_client_remove_scope (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t scope_handle, rdmnet_disconnect_reason_t disconnect_reason)
	Remove a previously-added scope from an EPT client instance. More...
etcpal_error_t	rdmnet_ept_client_change_scope (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t scope_handle, const RdmnetScopeConfig *new_scope_config, rdmnet_disconnect_reason_t disconnect_reason)
	Change the configuration of a scope on an EPT client. More...
etcpal_error_t	rdmnet_ept_client_get_scope (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t scope_handle, char *scope_str_buf, EtcPalSockAddr *static_broker_addr)
	Retrieve the scope string of a previously-added scope. More...
etcpal_error_t	rdmnet_ept_client_request_client_list (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t scope_handle)
	Request a client list from a broker. More...
etcpal_error_t	rdmnet_ept_client_send_data (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t scope_handle, const EtcPalUuid *dest_cid, uint16_t manufacturer_id, uint16_t protocol_id, const uint8_t *data, size_t data_len)
	Send data from an EPT client on a scope. More...
etcpal_error_t	rdmnet_ept_client_send_status (rdmnet_ept_client_t client_handle, rdmnet_client_scope_t scope_handle, const EtcPalUuid *dest_cid, ept_status_code_t status_code, const char *status_string)
	Send a status message from an EPT client on a scope. More...