rsb.protocol

Class NotificationType.Notification

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

rsb.protocol.NotificationType.Notification

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, NotificationType.NotificationOrBuilder

Enclosing class:

NotificationType

public static final class NotificationType.Notification
extends com.google.protobuf.GeneratedMessage
implements NotificationType.NotificationOrBuilder

Protobuf type rsb.protocol.Notification

 The Notification message is the wire format and serialization
 mechanism used by the RSB Spread transport and other transports.

 Notification messages contain

 * event routing information,
 * event payloads
 * and optional event meta-data such as timestamps

 See
 https://docs.cor-lab.org/rsb-manual/trunk/html/specification-event.html
 for more information regarding events.

Author:

Sebastian Wrede <swrede@techfak.uni-bielefeld.de>, Johannes Wienke <jwienke@techfak.uni-bielefeld.de>, Jan Moringen <jmoringe@techfak.uni-bielefeld.de>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotificationType.Notification.Builder Protobuf type rsb.protocol.Notification

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.BuilderParent, com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessage.ExtendableBuilder>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingType extends com.google.protobuf.Message,Type>

Field Summary

Fields

Modifier and Type	Field and Description
static int	CAUSES_FIELD_NUMBER
static int	DATA_FIELD_NUMBER
static int	EVENT_ID_FIELD_NUMBER
static int	META_DATA_FIELD_NUMBER
static int	METHOD_FIELD_NUMBER
static com.google.protobuf.Parser<NotificationType.Notification>	PARSER
static int	SCOPE_FIELD_NUMBER
static int	WIRE_SCHEMA_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders

Method Summary

Methods

Modifier and Type	Method and Description
EventIdType.EventId	getCauses(int index) repeated .rsb.protocol.EventId causes = 13;
int	getCausesCount() repeated .rsb.protocol.EventId causes = 13;
List<EventIdType.EventId>	getCausesList() repeated .rsb.protocol.EventId causes = 13;
EventIdType.EventIdOrBuilder	getCausesOrBuilder(int index) repeated .rsb.protocol.EventId causes = 13;
List<? extends EventIdType.EventIdOrBuilder>	getCausesOrBuilderList() repeated .rsb.protocol.EventId causes = 13;
com.google.protobuf.ByteString	getData() optional bytes data = 9;
static NotificationType.Notification	getDefaultInstance()
NotificationType.Notification	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
EventIdType.EventId	getEventId() required .rsb.protocol.EventId event_id = 108;
EventIdType.EventIdOrBuilder	getEventIdOrBuilder() required .rsb.protocol.EventId event_id = 108;
EventMetaDataType.EventMetaData	getMetaData() optional .rsb.protocol.EventMetaData meta_data = 15;
EventMetaDataType.EventMetaDataOrBuilder	getMetaDataOrBuilder() optional .rsb.protocol.EventMetaData meta_data = 15;
com.google.protobuf.ByteString	getMethod() optional bytes method = 14 [default = ""];
com.google.protobuf.Parser<NotificationType.Notification>	getParserForType()
com.google.protobuf.ByteString	getScope() optional bytes scope = 6;
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
com.google.protobuf.ByteString	getWireSchema() optional bytes wire_schema = 7;
boolean	hasData() optional bytes data = 9;
boolean	hasEventId() required .rsb.protocol.EventId event_id = 108;
boolean	hasMetaData() optional .rsb.protocol.EventMetaData meta_data = 15;
boolean	hasMethod() optional bytes method = 14 [default = ""];
boolean	hasScope() optional bytes scope = 6;
boolean	hasWireSchema() optional bytes wire_schema = 7;
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static NotificationType.Notification.Builder	newBuilder()
static NotificationType.Notification.Builder	newBuilder(NotificationType.Notification prototype)
NotificationType.Notification.Builder	newBuilderForType()
protected NotificationType.Notification.Builder	newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)
static NotificationType.Notification	parseDelimitedFrom(InputStream input)
static NotificationType.Notification	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NotificationType.Notification	parseFrom(byte[] data)
static NotificationType.Notification	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NotificationType.Notification	parseFrom(com.google.protobuf.ByteString data)
static NotificationType.Notification	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NotificationType.Notification	parseFrom(com.google.protobuf.CodedInputStream input)
static NotificationType.Notification	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static NotificationType.Notification	parseFrom(InputStream input)
static NotificationType.Notification	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
NotificationType.Notification.Builder	toBuilder()
protected Object	writeReplace()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

getAllFields, getDescriptorForType, getField, getRepeatedField, getRepeatedFieldCount, hasField, makeExtensionsImmutable, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashBoolean, hashCode, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getRepeatedField, getRepeatedFieldCount, hasField

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARSER

public static com.google.protobuf.Parser<NotificationType.Notification> PARSER

EVENT_ID_FIELD_NUMBER

public static final int EVENT_ID_FIELD_NUMBER

See Also:

Constant Field Values

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER

See Also:

Constant Field Values

METHOD_FIELD_NUMBER

public static final int METHOD_FIELD_NUMBER

See Also:

Constant Field Values

WIRE_SCHEMA_FIELD_NUMBER

public static final int WIRE_SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

DATA_FIELD_NUMBER

public static final int DATA_FIELD_NUMBER

See Also:

Constant Field Values

CAUSES_FIELD_NUMBER

public static final int CAUSES_FIELD_NUMBER

See Also:

Constant Field Values

META_DATA_FIELD_NUMBER

public static final int META_DATA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDefaultInstance

public static NotificationType.Notification getDefaultInstance()

getDefaultInstanceForType

public NotificationType.Notification getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessage

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getParserForType

public com.google.protobuf.Parser<NotificationType.Notification> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

hasEventId

public boolean hasEventId()

required .rsb.protocol.EventId event_id = 108;

 The unique ID of the event, consisting of the unique id of
 sending participant and the sequence number of the event.

 The odd field number is a historical artifact.
 

Specified by:

hasEventId in interface NotificationType.NotificationOrBuilder

getEventId

public EventIdType.EventId getEventId()

required .rsb.protocol.EventId event_id = 108;

 The unique ID of the event, consisting of the unique id of
 sending participant and the sequence number of the event.

 The odd field number is a historical artifact.
 

Specified by:

getEventId in interface NotificationType.NotificationOrBuilder

getEventIdOrBuilder

public EventIdType.EventIdOrBuilder getEventIdOrBuilder()

required .rsb.protocol.EventId event_id = 108;

 The unique ID of the event, consisting of the unique id of
 sending participant and the sequence number of the event.

 The odd field number is a historical artifact.
 

Specified by:

getEventIdOrBuilder in interface NotificationType.NotificationOrBuilder

hasScope

public boolean hasScope()

optional bytes scope = 6;

 The scope to which the encoded event was sent.
 

Specified by:

hasScope in interface NotificationType.NotificationOrBuilder

getScope

public com.google.protobuf.ByteString getScope()

optional bytes scope = 6;

 The scope to which the encoded event was sent.
 

Specified by:

getScope in interface NotificationType.NotificationOrBuilder

hasMethod

public boolean hasMethod()

optional bytes method = 14 [default = ""];

 An ASCII-string designating the role of this event within a
 communication pattern.

 Two such roles could be "REQUEST" and "REPLY" in RPC
 communication.

 Note: The bytes type has been chosen to avoid UTF-8 de- and
 encoding.
 

Specified by:

hasMethod in interface NotificationType.NotificationOrBuilder

getMethod

public com.google.protobuf.ByteString getMethod()

optional bytes method = 14 [default = ""];

 An ASCII-string designating the role of this event within a
 communication pattern.

 Two such roles could be "REQUEST" and "REPLY" in RPC
 communication.

 Note: The bytes type has been chosen to avoid UTF-8 de- and
 encoding.
 

Specified by:

getMethod in interface NotificationType.NotificationOrBuilder

hasWireSchema

public boolean hasWireSchema()

optional bytes wire_schema = 7;

 An ASCII-string designating the wire schema with which the
 event payload (in the "data" field) has been serialized.

 Note: The bytes type has been chosen to avoid UTF-8 de- and
 encoding.
 

Specified by:

hasWireSchema in interface NotificationType.NotificationOrBuilder

getWireSchema

public com.google.protobuf.ByteString getWireSchema()

optional bytes wire_schema = 7;

 An ASCII-string designating the wire schema with which the
 event payload (in the "data" field) has been serialized.

 Note: The bytes type has been chosen to avoid UTF-8 de- and
 encoding.
 

Specified by:

getWireSchema in interface NotificationType.NotificationOrBuilder

hasData

public boolean hasData()

optional bytes data = 9;

 The serialized payload of the event.
 

Specified by:

hasData in interface NotificationType.NotificationOrBuilder

getData

public com.google.protobuf.ByteString getData()

optional bytes data = 9;

 The serialized payload of the event.
 

Specified by:

getData in interface NotificationType.NotificationOrBuilder

getCausesList

public List<EventIdType.EventId> getCausesList()

repeated .rsb.protocol.EventId causes = 13;

 A collection of id of other events which have in some way
 caused this event to be sent.
 

Specified by:

getCausesList in interface NotificationType.NotificationOrBuilder

getCausesOrBuilderList

public List<? extends EventIdType.EventIdOrBuilder> getCausesOrBuilderList()

repeated .rsb.protocol.EventId causes = 13;

 A collection of id of other events which have in some way
 caused this event to be sent.
 

Specified by:

getCausesOrBuilderList in interface NotificationType.NotificationOrBuilder

getCausesCount

public int getCausesCount()

repeated .rsb.protocol.EventId causes = 13;

 A collection of id of other events which have in some way
 caused this event to be sent.
 

Specified by:

getCausesCount in interface NotificationType.NotificationOrBuilder

getCauses

public EventIdType.EventId getCauses(int index)

repeated .rsb.protocol.EventId causes = 13;

 A collection of id of other events which have in some way
 caused this event to be sent.
 

Specified by:

getCauses in interface NotificationType.NotificationOrBuilder

getCausesOrBuilder

public EventIdType.EventIdOrBuilder getCausesOrBuilder(int index)

repeated .rsb.protocol.EventId causes = 13;

 A collection of id of other events which have in some way
 caused this event to be sent.
 

Specified by:

getCausesOrBuilder in interface NotificationType.NotificationOrBuilder

hasMetaData

public boolean hasMetaData()

optional .rsb.protocol.EventMetaData meta_data = 15;

 meta-data storage
 

Specified by:

hasMetaData in interface NotificationType.NotificationOrBuilder

getMetaData

public EventMetaDataType.EventMetaData getMetaData()

optional .rsb.protocol.EventMetaData meta_data = 15;

 meta-data storage
 

Specified by:

getMetaData in interface NotificationType.NotificationOrBuilder

getMetaDataOrBuilder

public EventMetaDataType.EventMetaDataOrBuilder getMetaDataOrBuilder()

optional .rsb.protocol.EventMetaData meta_data = 15;

 meta-data storage
 

Specified by:

getMetaDataOrBuilder in interface NotificationType.NotificationOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.AbstractMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.AbstractMessage

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Overrides:

writeReplace in class com.google.protobuf.GeneratedMessage

Throws:

ObjectStreamException

parseFrom

public static NotificationType.Notification parseFrom(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static NotificationType.Notification parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static NotificationType.Notification parseFrom(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static NotificationType.Notification parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static NotificationType.Notification parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static NotificationType.Notification parseFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static NotificationType.Notification parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static NotificationType.Notification parseDelimitedFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseFrom

public static NotificationType.Notification parseFrom(com.google.protobuf.CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static NotificationType.Notification parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

newBuilder

public static NotificationType.Notification.Builder newBuilder()

newBuilderForType

public NotificationType.Notification.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static NotificationType.Notification.Builder newBuilder(NotificationType.Notification prototype)

toBuilder

public NotificationType.Notification.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected NotificationType.Notification.Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessage