General

	Data Structures
	Error Handling

---

Enumeration Types

enum ESP_ACCESS_MODE_T

Enumerator:

UNDEFINED_ACCESS	Undefined, typically indicates and error condition.
DIRECT_ACCESS	All calls to entities are synchronous.
CALLBACK_ACCESS	Support a callback on entities.
SELECTION_ACCESS	Use an EspSelector to monitor entity events.

Functions
ESPAPICALL int32_t	esp_event_get_category (const void *event, EspError *error)
ESPAPICALL int32_t	esp_sdk_start (EspError *error)
ESPAPICALL int32_t	esp_sdk_stop (EspError *error)
ESPAPICALL int32_t	esp_trace_on (EspError *error)
ESPAPICALL int32_t	esp_trace_off (EspError *error)

---

Function Documentation

ESPAPICALL int32_t esp_event_get_category	(	const void *	event,
		EspError *	error
	)

Returns the category of the event this void * represents. void * pointer must have been retrieved using esp_list_get_event method. This allows code to cast the void * to the appropriate event object such as EspServerEvent, EspProjectEvent, EspPublisherEvent or EspSubscriberEvent.

Returns:

ESP_EVENT_CATEGORY_T enum. In case of error returns ESP_EVENT_UNKNOWN.

ESPAPICALL int32_t esp_sdk_start

(

EspError *

error

)

Initializes the SDK. Must be the first call made to use the API. Multiple start calls may be made, but they must be matched by the same number of stop calls.

ESPAPICALL int32_t esp_sdk_stop

(

EspError *

error

)

Shuts down the SDK. On the stop call matching the first start, closes all open entities, stops internal threads if any and releases any held resources.

ESPAPICALL int32_t esp_trace_off

(

EspError *

error

)

Turns off internal tracing.

ESPAPICALL int32_t esp_trace_on

(

EspError *

error

)

Turns on internal tracing for debugging.