Subscription Events

Constant Definitions
#define	ESP_SUBSCRIBER_EVENT_CONNECTED
#define	ESP_SUBSCRIBER_EVENT_SUBSCRIBED
#define	ESP_SUBSCRIBER_EVENT_UNSUBSCRIBED
#define	ESP_SUBSCRIBER_EVENT_DISCONNECTED
#define	ESP_SUBSCRIBER_EVENT_CLOSED
#define	ESP_SUBSCRIBER_EVENT_DATA
#define	ESP_SUBSCRIBER_EVENT_SYNC_START
#define	ESP_SUBSCRIBER_EVENT_SYNC_END
#define	ESP_SUBSCRIBER_EVENT_DATA_INVALID
#define	ESP_SUBSCRIBER_EVENT_STREAM_EXIT
#define	ESP_SUBSCRIBER_EVENT_DATA_LOST
#define	ESP_SUBSCRIBER_EVENT_ERROR
#define	ESP_SUBSCRIBER_EVENT_ALL

---

Define Documentation

#define ESP_SUBSCRIBER_EVENT_ALL

Utility define indicating all EspSubscriber events.

#define ESP_SUBSCRIBER_EVENT_CLOSED

Subscriber closed, will not generate events or accept commands.

#define ESP_SUBSCRIBER_EVENT_CONNECTED

Connection to the server established.

#define ESP_SUBSCRIBER_EVENT_DATA

There is data on the line. Stream and MessageReader properties are valid.

#define ESP_SUBSCRIBER_EVENT_DATA_INVALID

The data for the stream is no longer valid. Stream property is valid.

#define ESP_SUBSCRIBER_EVENT_DATA_LOST

Engine has detected data loss. Stream property is valid.

#define ESP_SUBSCRIBER_EVENT_DISCONNECTED

Connection closed.

#define ESP_SUBSCRIBER_EVENT_ERROR

An error occured while subscribing.

#define ESP_SUBSCRIBER_EVENT_STREAM_EXIT

A stream in the project has closed. Stream property is valid.

#define ESP_SUBSCRIBER_EVENT_SUBSCRIBED

A subscription request completed.

#define ESP_SUBSCRIBER_EVENT_SYNC_END

Sync end / end of image. Stream property is valid.

#define ESP_SUBSCRIBER_EVENT_SYNC_START

Sync start / start of image. Stream property is valid.

#define ESP_SUBSCRIBER_EVENT_UNSUBSCRIBED

An unsubscription request has completed.

Functions
ESPAPICALL int32_t	esp_subscriber_event_get_type (const EspSubscriberEvent *event, uint32_t *type, EspError *error)
ESPAPICALL EspSubscriber *	esp_subscriber_event_get_subscriber (const EspSubscriberEvent *event, EspError *error)
ESPAPICALL const EspStream *	esp_subscriber_event_get_stream (const EspSubscriberEvent *event, EspError *error)
ESPAPICALL EspMessageReader *	esp_subscriber_event_get_reader (const EspSubscriberEvent *event, EspError *error)
ESPAPICALL EspError *	esp_subscriber_event_get_error (const EspSubscriberEvent *event, EspError *error)
ESPAPICALL int32_t	esp_subscriber_event_free (EspSubscriberEvent *event, EspError *error)

---

Function Documentation

ESPAPICALL int32_t esp_subscriber_event_free	(	EspSubscriberEvent *	event,
		EspError *	error
	)

Frees an event object that has been retrieved in DIRECT mode.

ESPAPICALL EspError* esp_subscriber_event_get_error	(	const EspSubscriberEvent *	event,
		EspError *	error
	)

For ESP_SUBSCRIBER_EVENT_ERROR events retrieve the associated EspError object.

Returns:

EspError, NULL on error.

ESPAPICALL EspMessageReader* esp_subscriber_event_get_reader	(	const EspSubscriberEvent *	event,
		EspError *	error
	)

Retrieve a message reader for the event. This will return a valid EspMessagerReader only for ESP_SUBSCRIBER_EVENT_DATA events.

Returns:

EspMessageReader, NULL on error.

ESPAPICALL const EspStream* esp_subscriber_event_get_stream	(	const EspSubscriberEvent *	event,
		EspError *	error
	)

Retrieve the EspStream for which this event is intended.

Returns:

EspStream, NULL on error.

ESPAPICALL EspSubscriber* esp_subscriber_event_get_subscriber	(	const EspSubscriberEvent *	event,
		EspError *	error
	)

Retrieve the EspSubscriber object that raised this event.

Returns:

EspSubscriber, NULL on error.

ESPAPICALL int32_t esp_subscriber_event_get_type	(	const EspSubscriberEvent *	event,
		uint32_t *	type,
		EspError *	error
	)

Retrieve the event type for the EspSubscriberEvent.

Returns:

0 on success. Error details on error