Publisher Events

Constant Definitions
#define	ESP_PUBLISHER_EVENT_CONNECTED
#define	ESP_PUBLISHER_EVENT_DISCONNECTED
#define	ESP_PUBLISHER_EVENT_CLOSED
#define	ESP_PUBLISHER_EVENT_READY
#define	ESP_PUBLISHER_EVENT_ERROR
#define	ESP_PUBLISHER_EVENT_ALL

---

Define Documentation

#define ESP_PUBLISHER_EVENT_ALL

Utility define for all publisher events.

#define ESP_PUBLISHER_EVENT_CLOSED

EspPublisher has closed.

#define ESP_PUBLISHER_EVENT_CONNECTED

EspPublisher has connected.

#define ESP_PUBLISHER_EVENT_DISCONNECTED

EspPublisher has disconnected.

#define ESP_PUBLISHER_EVENT_ERROR

EspPublisher has encountered an error.

#define ESP_PUBLISHER_EVENT_READY

EspPublisher is ready to publish next set of data.

Functions
ESPAPICALL uint32_t	esp_publisher_event_get_type (const EspPublisherEvent *event, uint32_t *type, EspError *error)
ESPAPICALL EspPublisher *	esp_publisher_event_get_publisher (const EspPublisherEvent *event, EspError *error)
ESPAPICALL EspError *	esp_publisher_event_get_error (const EspPublisherEvent *event, EspError *error)

---

Function Documentation

ESPAPICALL EspError* esp_publisher_event_get_error	(	const EspPublisherEvent *	event,
		EspError *	error
	)

For an ESP_PUBLISHER_EVENT_ERROR type event, retrieve the associated error object.

Returns:

NULL on error.

Parameters:

event

Event to query

ESPAPICALL EspPublisher* esp_publisher_event_get_publisher	(	const EspPublisherEvent *	event,
		EspError *	error
	)

Retrieve the EspPublisher for which this event is intended.

Returns:

NULL on error.

Parameters:

event

Event to query

ESPAPICALL uint32_t esp_publisher_event_get_type	(	const EspPublisherEvent *	event,
		uint32_t *	type,
		EspError *	error
	)

Retrieve the type of the event. The type will be one of the ESP_PUBLISHER_EVENT_xxx constants.

Returns:

0 on success.

Parameters:

event	Event to query
type	Pointer in which to store the type