ESP SDK C API
Functions
Message Writer
Publishing

Functions

ESPAPICALL int32_t esp_message_writer_start_transaction (EspMessageWriter *writer, const uint32_t numoptions, EspError *error)
ESPAPICALL int32_t esp_message_writer_start_envelope (EspMessageWriter *writer, const uint32_t numoptions, EspError *error)
ESPAPICALL int32_t esp_message_writer_end_block (EspMessageWriter *writer, EspError *error)
ESPAPICALL EspRelativeRowWriter * esp_message_writer_get_relative_rowwriter (EspMessageWriter *writer, EspError *error)
ESPAPICALL const EspStream * esp_message_writer_get_stream (EspMessageWriter *writer, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_start_row (EspRelativeRowWriter *writer, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_end_row (EspRelativeRowWriter *writer, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_operation (EspRelativeRowWriter *writer, const ESP_OPERATION_T opcode, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_null (EspRelativeRowWriter *writer, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_shinethrough (EspRelativeRowWriter *writer, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_integer (EspRelativeRowWriter *writer, const int32_t int_value, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_long (EspRelativeRowWriter *writer, const int64_t long_value, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_float (EspRelativeRowWriter *writer, const double double_value, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_string (EspRelativeRowWriter *writer, const char *string_value, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_date (EspRelativeRowWriter *writer, const int64_t date_value, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_timestamp (EspRelativeRowWriter *writer, const int64_t data_value, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_money (EspRelativeRowWriter *writer, const EspMoney *money_value, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_legacy_money (EspRelativeRowWriter *writer, const EspMoney *money_value, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_money_as_long (EspRelativeRowWriter *writer, const int64_t long_value, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_bigdatetime (EspRelativeRowWriter *writer, const EspBigDatetime *bigdatetime_value, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_binary (EspRelativeRowWriter *writer, const void *binary_value, const uint32_t size, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_boolean (EspRelativeRowWriter *writer, const int32_t boolean_value, EspError *error)
ESPAPICALL int32_t esp_relative_rowwriter_set_interval (EspRelativeRowWriter *writer, const int64_t interval_value, EspError *error)

Function Documentation

ESPAPICALL int32_t esp_message_writer_end_block ( EspMessageWriter *  writer,
EspError *  error 
)

Ends a block previously started with either esp_message_writer_start_transaction() or esp_message_writer_start_envelope().

Returns:
0 on success.
Parameters:
writerEspMessageWriter for which to end the block
ESPAPICALL EspRelativeRowWriter* esp_message_writer_get_relative_rowwriter ( EspMessageWriter *  writer,
EspError *  error 
)

Retrieve EspRelativeRowWriter for which to format data. The row writer is initialized to format data for the stream for which the EspMessageWriter was created.

Returns:
0 on success.
Parameters:
writerEspMessageWriter to use to for formatting data
ESPAPICALL const EspStream* esp_message_writer_get_stream ( EspMessageWriter *  writer,
EspError *  error 
)

Retrieve the EspStream for which this EspMessageWriter was created.

Returns:
NULL on error.
ESPAPICALL int32_t esp_message_writer_start_envelope ( EspMessageWriter *  writer,
const uint32_t  numoptions,
EspError *  error 
)

Start an envelope block for this EspMessageWriter.

Returns:
0 on success.
Parameters:
writerEspMessageWriter on which to start an envelope
numoptionsIgnored
ESPAPICALL int32_t esp_message_writer_start_transaction ( EspMessageWriter *  writer,
const uint32_t  numoptions,
EspError *  error 
)

Start a transaction block for this EspMessageWriter.

Returns:
0 on success.
Parameters:
writerEspMessageWriter on which to start a transaction
numoptionsIgnored
ESPAPICALL int32_t esp_relative_rowwriter_end_row ( EspRelativeRowWriter *  writer,
EspError *  error 
)

Ends a row definition. Must the be the last call made after all data items have been populated. If publishing in buffered mode and no blocking is in effect, this call queues the row to the internal buffer to be picked up by the publishing thread.

Returns:
0 on success.
ESPAPICALL int32_t esp_relative_rowwriter_set_bigdatetime ( EspRelativeRowWriter *  writer,
const EspBigDatetime *  bigdatetime_value,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_binary ( EspRelativeRowWriter *  writer,
const void *  binary_value,
const uint32_t  size,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_boolean ( EspRelativeRowWriter *  writer,
const int32_t  boolean_value,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_date ( EspRelativeRowWriter *  writer,
const int64_t  date_value,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_float ( EspRelativeRowWriter *  writer,
const double  double_value,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_integer ( EspRelativeRowWriter *  writer,
const int32_t  int_value,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_interval ( EspRelativeRowWriter *  writer,
const int64_t  interval_value,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_legacy_money ( EspRelativeRowWriter *  writer,
const EspMoney *  money_value,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_long ( EspRelativeRowWriter *  writer,
const int64_t  long_value,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_money ( EspRelativeRowWriter *  writer,
const EspMoney *  money_value,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_money_as_long ( EspRelativeRowWriter *  writer,
const int64_t  long_value,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_null ( EspRelativeRowWriter *  writer,
EspError *  error 
)

Set the next column value to be NULL.

Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_operation ( EspRelativeRowWriter *  writer,
const ESP_OPERATION_T  opcode,
EspError *  error 
)

Set the operation for the row. Default is INSERT.

Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_shinethrough ( EspRelativeRowWriter *  writer,
EspError *  error 
)

Set the next column value to be shinethrough.

Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_string ( EspRelativeRowWriter *  writer,
const char *  string_value,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_set_timestamp ( EspRelativeRowWriter *  writer,
const int64_t  data_value,
EspError *  error 
)
Returns:
0 on success.
Parameters:
writerEspRelativeRowWriter to modify
ESPAPICALL int32_t esp_relative_rowwriter_start_row ( EspRelativeRowWriter *  writer,
EspError *  error 
)

Starts a new row definition. Must be the first call when starting a row.

Returns:
0 on success.
 All Classes Variables
Generated on Tue Dec 6 2011 15:13:25 for ESP SDK C API by   doxygen 1.7.5