SSE::field

Description

This command provides the ability to create, read, update, and delete individual fields on a Server Sent Events (SSE) message.

Syntax

SSE::field get <SSE_FIELD_NAME>
SSE::field set <SSE_FIELD_NAME> <ANY_CHARS>
SSE::field remove <SSE_FIELD_NAME>

SSE::field get <SSE_FIELD_NAME>

  • Returns the value of the specified field name. If field name does not exist, a null string is returned.

SSE::field set <SSE_FIELD_NAME> <ANY_CHARS>

  • Sets the value in ANY_CHARS the specified field name.

SSE::field remove <SSE_FIELD_NAME>

  • Removes the specified field name.

Examples

when SSE_RESPONSE {
    log local0. "event is " [SSE::field get event]

    SSE::field set my-custom-field  my-custom-value
    log local0. "my-custom-field is " [SSE::field get my-custom-field]

    SSE::field remove event
}