Public Types
enum	NET_ESP_ACCESS_MODE_T { NET_UNDEFINED_ACCESS = 0, NET_DIRECT_ACCESS = 1, NET_CALLBACK_ACCESS, NET_SELECTION_ACCESS }
enum	NET_ESP_SUBSCRIBER_FLAG { NET_ESP_SUBSCRIBER_FLAG_LOSSY = 0x01, NET_ESP_SUBSCRIBER_FLAG_NOBASE = 0x02, NET_ESP_SUBSCRIBER_FLAG_DISTRIBUTED = 0x04, NET_ESP_SUBSCRIBER_FLAG_DROPPABLE = 0x08, NET_ESP_SUBSCRIBER_FLAG_PRESERVE_BLOCKS = 0x20, NET_ESP_SUBSCRIBER_FLAG_SHINETHROUGH = 0x40 }
Public Member Functions
ESP_SDK_NAMESPACE::EspSubscriberOptions *	getEspSubscriberOptions ()
void	set_mode (NET_ESP_ACCESS_MODE_T access_mode)
NET_ESP_ACCESS_MODE_T	get_mode ()
void	set_flags (int32_t p)
void	set_queue_size (int32_t p)
void	set_base_drain_timeout (int32_t p)
void	set_pulse_interval (int32_t p)

Member Enumeration Documentation

Enumerator:

NET_ESP_SUBSCRIBER_FLAG_LOSSY	Server will drop rows if client cannot keep up
NET_ESP_SUBSCRIBER_FLAG_NOBASE	Server will not send rows existing in the stream at the time connection is set up
NET_ESP_SUBSCRIBER_FLAG_DISTRIBUTED	Not used
NET_ESP_SUBSCRIBER_FLAG_DROPPABLE	Server will drop the connection if client cannot keep up
NET_ESP_SUBSCRIBER_FLAG_PRESERVE_BLOCKS	Server will preseve transaction blocks
NET_ESP_SUBSCRIBER_FLAG_SHINETHROUGH	Not used

Member Function Documentation

NET_ESP_ACCESS_MODE_T NetEspSubscriberOptions::get_mode ( ) [inline]

Retrieves the access mode.

void NetEspSubscriberOptions::set_base_drain_timeout ( int32_t p ) [inline]

Set the maximum time server will allow for the base data to be read. Values less than 1000 milliseconds have no effect.

void NetEspSubscriberOptions::set_flags ( int32_t p ) [inline]

Sets subscription flags.

void NetEspSubscriberOptions::set_mode ( NET_ESP_ACCESS_MODE_T access_mode ) [inline]

Sets the mode subscriber will be accessed with - DIRECT, CALLBACK or SELECT.

void NetEspSubscriberOptions::set_pulse_interval ( int32_t p ) [inline]

Switch on pulsed subscription. Server consolidates rows for specified milliseconds before publishing the data to client.

void NetEspSubscriberOptions::set_queue_size ( int32_t p ) [inline]

Set the subscriber queue size - maximum number of records server will queue up to publish to client.