Public Types
enum	NET_ESP_PROJECT_EVENT { NET_ESP_PROJECT_EVENT_CONNECTED = 0x02000001, NET_ESP_PROJECT_EVENT_DISCONNECTED = 0x02000002, NET_ESP_PROJECT_EVENT_CLOSED = 0x02000004, NET_ESP_PROJECT_EVENT_ERROR = 0x02000008, NET_ESP_PROJECT_EVENT_ALL = 0x0200000F }
Public Member Functions
delegate void	PROJECT_EVENT_CALLBACK (NetEspProjectEvent^ event, IntPtr^ data)
	NetEspProject (ESP_SDK_NAMESPACE::EspProject *nProject)
int32_t	connect (NetEspError^ error)
int32_t	disconnect (NetEspError^ error)
int32_t	close (NetEspError^ error)
NetEspServer^	get_server (NetEspError^ error)
List< String^ >^	get_model_stream_names (NetEspError^ error)
List< String^ >^	get_intermediate_stream_names (NetEspError^ error)
List< String^ >^	get_system_stream_names (NetEspError^ error)
List< String^ >^	get_error_stream_names (NetEspError^ error)
NetEspStream^	get_stream (String^ stream, NetEspError^ error)
NetEspSubscriber^	create_subscriber (NetEspSubscriberOptions^ sub_options, NetEspError^ error)
NetEspPublisher^	create_publisher (NetEspPublisherOptions^ pub_options, NetEspError^ error)
int32_t	is_connected (NetEspError^ error)
int32_t	is_quiesced (NetEspError^ error)
NetEspProjectOptions^	get_options ()
NetEspDeployment^	get_deployment (NetEspError^ error)
ESP_SDK_NAMESPACE::EspProject *	getEspProject ()
int32_t	set_callback (uint32_t events, PROJECT_EVENT_CALLBACK^ callback, IntPtr^ user_data, NetEspError^ error)
int32_t	remove_callback (PROJECT_EVENT_CALLBACK^ callback, NetEspError^ error)
int32_t	select_with (NetEspSelector^ selector, uint32_t events, NetEspError^ error)

Member Enumeration Documentation

enum NetEspProject::NET_ESP_PROJECT_EVENT

Enumerator:

NET_ESP_PROJECT_EVENT_CONNECTED	Project has connected to the backend
NET_ESP_PROJECT_EVENT_DISCONNECTED	Project has disconnected from the backend
NET_ESP_PROJECT_EVENT_CLOSED	Project entity is closed
NET_ESP_PROJECT_EVENT_ERROR	Project has encountered an error
NET_ESP_PROJECT_EVENT_ALL	All project events

Member Function Documentation

int32_t NetEspProject::close ( NetEspError^ error )

Once closed this project object is no longer available for interaction In DIRECT access mode, call returns when NetEspProject closes. In CALLBACK/SELECT returns immediately. Completion is indicated by an NET_ESP_PROJECT_EVENT_CLOSED event.

int32_t NetEspProject::connect ( NetEspError^ error )

Establishes a connection to the project. In DIRECT access mode, call returns when the connection is established. In CALLBACK/SELECT returns immediately. Completion is indicated by an NET_ESP_PROJECT_EVENT_CONNECTED event.

NetEspPublisher NetEspProject::create_publisher	(	NetEspPublisherOptions^	pub_options,
		NetEspError^	error
	)

Creates a publisher for the project.

NetEspSubscriber NetEspProject::create_subscriber	(	NetEspSubscriberOptions^	sub_options,
		NetEspError^	error
	)

Creates a subscriber for the project.

int32_t NetEspProject::disconnect ( NetEspError^ error )

Disconnects from a connected project In DIRECT access mode, call returns when EspProject disconnects. In CALLBACK/SELECT returns immediately. Completion is indicated by an NET_ESP_PROJECT_EVENT_DISCONNECTED event.

NetEspDeployment NetEspProject::get_deployment ( NetEspError^ error )

Retrieves the NetEspDeployment object for the connected project. If there is no error the returned information is valid at the time the information is returned and remains valid until the project remains connected. No connectivity check is performed when retrieving the data components of a NetEspDeployment instance. User code interested in monitoring connectivity should retrieve the NetEspDeployment object everytime it needs the information.

NOTE - not all members of EspDeployment are valid for standalone projects.

List< String^ > NetEspProject::get_error_stream_names ( NetEspError^ error )

Returns the list of error streams.

List< String^ > NetEspProject::get_intermediate_stream_names ( NetEspError^ error )

Returns the list of streams that have been generated by the compiler.

List< String^ > NetEspProject::get_model_stream_names ( NetEspError^ error )

Returns the list of streams that are modelled in the current project.

NetEspProjectOptions NetEspProject::get_options ( )

Retrieves the NetEspProjectOptions object for the project.

NetEspServer NetEspProject::get_server ( NetEspError^ error )

Retrieve the parent NetEspServer for this project

NetEspStream NetEspProject::get_stream	(	String^	stream,
		NetEspError^	error
	)

Retrieves the NetEspStream object for the stream.

List< String^ > NetEspProject::get_system_stream_names ( NetEspError^ error )

Returns the list of system streams.

int32_t NetEspProject::is_connected ( NetEspError^ error )

Returns 0 if the SDK detects a disconnection with the project.

int32_t NetEspProject::is_quiesced ( NetEspError^ error )

Checks if the backed project is quiesced. Returns 0 if the project is not quiesced, non zero otherwise.

int32_t NetEspProject::remove_callback	(	PROJECT_EVENT_CALLBACK^	callback,
		NetEspError^	error
	)

Deregisters the specified callback handler for the project.

int32_t NetEspProject::select_with	(	NetEspSelector^	selector,
		uint32_t	events,
		NetEspError^	error
	)

Registers this EspProject with the specified NetEspSelector. Waiting on the selector returns when the events registered for are triggered.

int32_t NetEspProject::set_callback	(	uint32_t	events,
		PROJECT_EVENT_CALLBACK^	callback,
		IntPtr^	user_data,
		NetEspError^	error
	)

Registers a callback handler for the project in CALLBACK access mode.

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation