EMS Manual

Distributor Commands and Responses
EMS Manual—426909-005
17-25
GETEVENT Command (ZEMS-CMD-GETEVENT)
GETEVENT Command (ZEMS-CMD-GETEVENT)
The ZEMS-CMD-GETEVENT command gets the next event message to pass the
current filter. GETEVENT applies only to consumer distributors.
Tokens in Command Buffer
ZSPI-TKN-CONTEXT (type bytestring)
is the standard SPI context token, as returned in the previous GETEVENT
response message. You can include ZSPI-TKN-CONTEXT if the GETEVENT
command message asks the distributor to examine the next sequential event
message, the usual case.
Do not include ZSPI-TKN-CONTEXT if this is the first GETEVENT command
message or if a CONTROL command message has just changed the distributor’s
position within the source of event messages.
The distributor uses the context token for integrity checking. You can omit this
token.
ZEMS-TKN-EOFSTOP (type Boolean; nonshared)
if present with a value of ZSPI-VAL-TRUE, requests that the distributor immediately
return an end-of-file warning if an event message is not currently available. For
more information, see Operational Notes on page 17-26.
Command
ZEMS-CMD-GETEVENT
Tokens in Command Buffer
ZSPI-TKN-CONTEXT token-type ZSPI-TYP-BYTESTRING
ZEMS-TKN-EOFSTOP token-type ZSPI-TYP-BOOLEAN
Tokens in Response Buffer
ZEMS-TKN-EVENT token-type ZSPI-TYP-BYTESTRING
ZEMS-TKN-PASSVAL token-type ZSPI-TYP-INT
ZSPI-TKN-CONTEXT token-type ZSPI-TYP-BYTESTRING
ZSPI-TKN-RETCODE token-type ZSPI-TYP-ENUM
ZSPI-TKN-ERRLIST token-type ZSPI-TYP-LIST
.
.
.
ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL