Sybase ESP .NET SDK  5.0 ESD#1
NetEspPublisherOptions Class Reference

List of all members.

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_BLOCKING_MODE_T { NET_NO_BLOCKING = 0, NET_EXPLICIT_BLOCKING, NET_AUTO_BLOCKING }

Public Member Functions

void set_mode (NET_ESP_ACCESS_MODE_T access_mode)
NET_ESP_ACCESS_MODE_T get_mode ()
void set_exit_on_close (int32_t p)
void set_exit_on_timeout (int32_t p)
void set_finalizer_command (String^ p)
void set_finalizer_timeout (int32_t p)
void set_buffer_size (int32_t p)
void set_async (int32_t p)
void set_single_writer (int32_t p)
void set_block_mode (NET_ESP_BLOCKING_MODE_T p)
ESP_SDK_NAMESPACE::EspPublisherOptions * getEspPublisherOptions ()

Member Function Documentation

NET_ESP_ACCESS_MODE_T NetEspPublisherOptions::get_mode ( ) [inline]

Retrieves the access mode.

void NetEspPublisherOptions::set_async ( int32_t  p) [inline]

If set to true, EspPublisher publishes to the platform in 'synchronous' mode. In this mode, each time data is written to the platform, EspPublisher waits for an acknowledgement from the platform before the next data is sent.

This slows down the throughput but ensures that the data being written has reached the platform. Note - the acknowledgement only guarantees that the data has physically reached the platform.

void NetEspPublisherOptions::set_block_mode ( NET_ESP_BLOCKING_MODE_T  p) [inline]

Set the blocking mode to use for this publisher.

void NetEspPublisherOptions::set_buffer_size ( int32_t  p) [inline]

Sets the internal buffer size. If set to a positive value, all data published is queued to the buffer. EspPublisher creates an internal thread that picks up the data from the buffer and publishes it.

Buffering is enabled only in DIRECT_ACCESS modes. In other access modes this flag is ignored. Note that synchronous publishing cannot be done when buffering is enabled.

void NetEspPublisherOptions::set_exit_on_close ( int32_t  p) [inline]

If set to true, the project will exit if the publisher drops its connection.

void NetEspPublisherOptions::set_exit_on_timeout ( int32_t  p) [inline]

Set the time in milliseconds that a project will wait to exit if there is no data being published.

void NetEspPublisherOptions::set_finalizer_command ( String^  p) [inline]

Sets the command project will execute if the publisher does not publish any data for the configured timeout (see set_finalizer_command(String^ p)).

void NetEspPublisherOptions::set_finalizer_timeout ( int32_t  p) [inline]

Sets the timeout to invoke the finalizer command.

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

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