NetEspSubscriber Class Reference

List of all members.

Public Types
enum	NET_ESP_SUBSCRIBER_EVENT {   NET_ESP_SUBSCRIBER_EVENT_CONNECTED = 0x04000001, NET_ESP_SUBSCRIBER_EVENT_SUBSCRIBED = 0x04000002, NET_ESP_SUBSCRIBER_EVENT_UNSUBSCRIBED = 0x04000004, NET_ESP_SUBSCRIBER_EVENT_DISCONNECTED = 0x04000008,   NET_ESP_SUBSCRIBER_EVENT_CLOSED = 0x0400000A, NET_ESP_SUBSCRIBER_EVENT_DATA = 0x04000010, NET_ESP_SUBSCRIBER_EVENT_SYNC_START = 0x04000020, NET_ESP_SUBSCRIBER_EVENT_SYNC_END = 0x04000040,   NET_ESP_SUBSCRIBER_EVENT_DATA_INVALID = 0x04000080, NET_ESP_SUBSCRIBER_EVENT_STREAM_EXIT = 0x040000A0, NET_ESP_SUBSCRIBER_EVENT_DATA_LOST = 0x04000100, NET_ESP_SUBSCRIBER_EVENT_ERROR = 0x04000200,   NET_ESP_SUBSCRIBER_EVENT_ALL = 0x040003FF }
Public Member Functions
delegate void	SUBSCRIBER_EVENT_CALLBACK (NetEspSubscriberEvent^ event, IntPtr^ data)
	NetEspSubscriber (ESP_SDK_NAMESPACE::EspSubscriber *nSubscriber)
ESP_SDK_NAMESPACE::EspSubscriber *	getEspSubscriber ()
int32_t	init (NetEspProject^ project, String^ host, int port, NetEspSubscriberOptions^ options, NetEspCredentials^ creds, int token, NetEspError^ error)
int32_t	connect (NetEspError^ error)
int32_t	disconnect (NetEspError^ error)
int32_t	close (NetEspError^ error)
int32_t	subscribe_stream_name (String^ stream_name, NetEspError^ error)
int32_t	subscribe_stream (NetEspStream^ stream, NetEspError^ error)
int32_t	subscribe_sql (String^ sql, NetEspError^ error)
List< NetEspStream^ >^	get_subscribed_streams (NetEspError^ error)
NetEspSubscriberEvent^	get_next_event (NetEspError^ error)
NetEspProject^	get_project (NetEspError^ error)
int32_t	set_callback (uint32_t events, SUBSCRIBER_EVENT_CALLBACK^ callback, IntPtr^ user_data, NetEspError^ error)
int32_t	remove_callback (SUBSCRIBER_EVENT_CALLBACK^ callback, NetEspError^ error)
int32_t	select_with (NetEspSelector^ selector, uint32_t events, NetEspError^ error)

---

Member Enumeration Documentation

enum NetEspSubscriber::NET_ESP_SUBSCRIBER_EVENT

Enumerator:

NET_ESP_SUBSCRIBER_EVENT_CONNECTED	Connection to the server established
NET_ESP_SUBSCRIBER_EVENT_SUBSCRIBED	A Subscription request completed
NET_ESP_SUBSCRIBER_EVENT_UNSUBSCRIBED	An Unsubscription request completed
NET_ESP_SUBSCRIBER_EVENT_DISCONNECTED	Connection closed
NET_ESP_SUBSCRIBER_EVENT_CLOSED	Subscriber closed, will not generate events or accept commands
NET_ESP_SUBSCRIBER_EVENT_DATA	There is data on the line. Stream and MessageReader properties are valid
NET_ESP_SUBSCRIBER_EVENT_SYNC_START	Sync start / start of image. Stream property is valid
NET_ESP_SUBSCRIBER_EVENT_SYNC_END	Sync end / end of image. Stream property is valid
NET_ESP_SUBSCRIBER_EVENT_DATA_INVALID	The data is invalid. Stream property is valid
NET_ESP_SUBSCRIBER_EVENT_STREAM_EXIT	An error has occurred with a particular stream in the server. Stream property is valid
NET_ESP_SUBSCRIBER_EVENT_DATA_LOST	Not implemented yet
NET_ESP_SUBSCRIBER_EVENT_ERROR	An error occured while subscribing
NET_ESP_SUBSCRIBER_EVENT_ALL	Utility definition indicating all EspSubscriber events

---

Member Function Documentation

int32_t NetEspSubscriber::close

(

NetEspError^

error

)

Closes this instance of NetEspSubscriber. In DIRECT access mode returns when the entity is closed. In CALLBACK/SELECT will generate an NET_ESP_SUBSCRIBER_EVENT_CLOSED event.

int32_t NetEspSubscriber::connect

(

NetEspError^

error

)

Connect to the backend project. In DIRECT access mode returns when connected. In CALLBACK/SELECT will generate a NET_ESP_SUBSCRIBER_EVENT_CONNECTED event.

int32_t NetEspSubscriber::disconnect

(

NetEspError^

error

)

Disconnect from the project. In DIRECT access mode returns when disconnected. In CALLBACK/SELECT will generate an NET_ESP_SUBSCRIBER_EVENT_DISCONNECTED event.

NetEspSubscriberEvent NetEspSubscriber::get_next_event

(

NetEspError^

error

)

Determine the next event pending at the subscriber. This call should be made in DIRECT access mode only. In other access modes, the events are retrieved by the SDK and are either passed to the callback handler or returned from the NetEspSelector.select() call.

NetEspProject NetEspSubscriber::get_project

(

NetEspError^

error

)

Retrieves the parent NetEspProject for this subscriber.

List< NetEspStream^ > NetEspSubscriber::get_subscribed_streams

(

NetEspError^

error

)

Retrieves a list of streams currently subscribed to. If this is a sql subscription, the list will contain a single EspStream with the type SQL_QUERY and a schema that corresponds to the sql statement that was used to subscribe.

int32_t NetEspSubscriber::remove_callback	(	SUBSCRIBER_EVENT_CALLBACK^	callback,
		NetEspError^	error
	)

Deregisters the specified callback handler for the subscriber.

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

Register the NetEspSubscriber with the specified NetEspSelector object. Used for SELECTION mode access.

int32_t NetEspSubscriber::set_callback	(	uint32_t	events,
		SUBSCRIBER_EVENT_CALLBACK^	callback,
		IntPtr^	user_data,
		NetEspError^	error
	)

Sets the callback handler if the subscriber was created using CALLBACK access mode.

int32_t NetEspSubscriber::subscribe_sql	(	String^	sql,
		NetEspError^	error
	)

Subscribes using the provided sql statement.

int32_t NetEspSubscriber::subscribe_stream	(	NetEspStream^	stream,
		NetEspError^	error
	)

Subscribe to the stream represented by the specified NetEspStream instance. This call must be made after the subscriber has connected.

int32_t NetEspSubscriber::subscribe_stream_name	(	String^	stream_name,
		NetEspError^	error
	)

Subscribe to the stream with the specified name. This call must be made after the subscriber has connected.