public interface OpaqueDatagram extends ImmutableEventDatagram
Title: Structured Data Objects
Description: The Opaque Datagram
represents a raw datagram object
optimized for transmission and serialization.
Event Key
and an Event Group Id
in order to allow basic selection
of the optimized event by Selectors
.
It does not support extended properties, user-defined properties or annotations. Opaque datagrams are useful for sending simple, compact, high performance datagrams. Their performance is close that of raw network speeds due to reduced overhead of structured event processing. Optimally the payload is a byte array or simple text.
Copyright: Copyright (c) 2010
Company: StreamScape Technologies
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SEMANTIC_TYPE_NAME |
DEFAULT_SERIAL_VERSION_ID
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getData()
Returns the event payload.
|
void |
setData(java.lang.Object newData)
Sets the specified payload of this event.
|
void |
setEventGroupId(java.lang.String group)
Sets the optional field that allows developers to group this event with others
of a similar type or within a sequence.
|
void |
setEventKey(java.lang.String key)
Sets an optional field that uniquely identifies this event type instance.
|
clone, getDurable, getEventGroupId, getEventId, getEventKey, getEventSource, getTimestamp, getTransmitAccess
getSerialVersionUID
static final java.lang.String SEMANTIC_TYPE_NAME
void setEventKey(java.lang.String key)
key
- the event key to be set.SDORuntimeException
- if the event is coalesced (locked for editing).void setEventGroupId(java.lang.String group)
SDORuntimeException
- if the event is coalesced (locked for editing).void setData(java.lang.Object newData) throws SDOException, SecurityViolationException
newData
- the data to be set.SDORuntimeException
- if the event is coalesced (locked for editing).SDOException
- if the specified newData
is null
or
if the specified data has wrong type.SecurityViolationException
java.lang.Object getData() throws SDOException
SDOException
- if some internal error occurs.Copyright © 2015-2024 StreamScape Technologies. All rights reserved.