Extended Opcodes for esp_subscribe

Extended operations codes (opcodes) appear in the output when using esp_subscribe in verbose mode.

All extended opcode letters are preceded by ESP_OPS. Below is an example of the ESP_START_SYNC extended opcode:
ESP_OPS="s"
CP_MESSAGE
  • An extended opcode visible when using the subscribe tool with the '-C' option with a value of -1.
  • Indicates the last checkpointed sequence number. The opcode appears in guaranteed delivery mode output when the server sends a checkpoint message.
  • Represented as the letter 'C'.

Output examples:

XML format: 
<In1 ESP_OPS="C" SequenceNo="100" />
CSV format: 
In1,C,100
ESP_START_SYNC
  • An extended opcode visible when using the subscribe tool with the '-v' option.
  • Indicates that the base data (data in the window available when the subscription starts) is about to be delivered.
  • Represented as the letter 's' when subscribing to Streams, Windows, and Delta Streams.
ESP_END_SYNC
  • An extended opcode visible when using the subscribe tool with the '-v' option.
  • Indicates that the base data (data in the window available when the subscription starts) has been delivered.
  • Represented as the letter 'e' when subscribing to Streams, Windows, and Delta Streams.
ESP_WIPEOUT
  • An extended opcode visible when using the subscribe tool with the '-v' option.
  • This opcode is received when running in High Availability mode and the primary server goes down; and you are going to receive a fresh set of base data from the secondary server.
  • Represented as the letter 'w' when subscribing to Streams, Windows, and Delta Streams.
ESP_STREAM_EXIT
  • An extended opcode visible when using the subscribe tool with the '-v' option.
  • This opcode is received when the stream that is being subscribed to has exited. You will no longer receive more data from this Stream/Window/Delta Stream.
  • Represented as the letter 'X' when subscribing to Streams, Windows, and Delta Streams.
ESP_DATA_LOST
  • An extended opcode visible when using the subscribe tool with the '-v' option.
  • This opcode is received when subscribing to data in lossy mode. The server purges some data because the subscribe tool is not able to keep up with the server.
  • Represented as the letter 'l' (lowercase L) when subscribing to Streams, Windows, and Delta Streams.

Output in Guaranteed Delivery Mode

When you subscribe in GD mode (-U) with the verbose option (-v), the output of esp_subscribe includes an additional column, SequenceNo, which identifies the last transaction checkpointed by the server. XML output also includes ESP_FLAGS="g" to indicate that the record is a guaranteed delivery record. Output examples:

XML format: 
<In1 ESP_OPS="u" ESP_FLAGS="g" ESP_GDSequenceNo="100" Key1="100" Col1="val1" Col2="val2"/>
CSV format: 
In1,u,100,100,val1,val2

In the CSV example, the value after the second comma is the sequence number.

Parent topic: esp_subscribe