Index
All Classes and Interfaces|All Packages
A
- active() - Method in interface com.iantapply.relay.api.Subscription
-
Reports whether this subscription can still receive messages.
- activeHandlers() - Method in record class com.iantapply.relay.api.MessagingStatus
-
Returns the value of the
activeHandlersrecord component.
B
- broadcast() - Static method in record class com.iantapply.relay.api.Destination
-
Creates a destination containing every Relay node.
- BROADCAST - Enum constant in enum class com.iantapply.relay.api.Destination.Kind
-
Every Relay node.
- bytes() - Static method in class com.iantapply.relay.api.Codecs
-
Returns a codec that defensively copies binary payloads.
C
- close() - Method in interface com.iantapply.relay.api.Subscription
-
Removes the handler; repeated calls have no effect.
- codec() - Method in record class com.iantapply.relay.api.Topic
-
Returns the value of the
codecrecord component. - Codecs - Class in com.iantapply.relay.api
-
Factory methods for the codecs supplied with Relay.
- com.iantapply.relay.api - package com.iantapply.relay.api
-
Public contracts for typed, transient Relay messaging.
- connected() - Method in record class com.iantapply.relay.api.MessagingStatus
-
Reports whether both sides of the transport are connected.
- contentType() - Method in interface com.iantapply.relay.api.MessageCodec
-
Identifies the encoded representation so subscribers can reject incompatible codecs.
- correlationId() - Method in record class com.iantapply.relay.api.Message
-
Returns the value of the
correlationIdrecord component. - correlationId() - Method in record class com.iantapply.relay.api.PublishOptions
-
Returns the value of the
correlationIdrecord component. - createdAt() - Method in record class com.iantapply.relay.api.Message
-
Returns the value of the
createdAtrecord component.
D
- decode(byte[]) - Method in interface com.iantapply.relay.api.MessageCodec
-
Decodes a transported payload.
- defaults() - Static method in record class com.iantapply.relay.api.PublishOptions
-
Returns options with no correlation identifier or application headers.
- destination() - Method in record class com.iantapply.relay.api.Message
-
Returns the value of the
destinationrecord component. - Destination - Record Class in com.iantapply.relay.api
-
Selects the Relay nodes that should receive a message.
- Destination(Destination.Kind, String) - Constructor for record class com.iantapply.relay.api.Destination
-
Validates a destination's category and optional node identifier.
- Destination.Kind - Enum Class in com.iantapply.relay.api
-
Categories of message destination.
E
- encode(T) - Method in interface com.iantapply.relay.api.MessageCodec
-
Encodes a value for transport.
- equals(Object) - Method in record class com.iantapply.relay.api.Destination
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.iantapply.relay.api.Message
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.iantapply.relay.api.MessageId
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.iantapply.relay.api.MessagingStatus
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.iantapply.relay.api.PublishOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.iantapply.relay.api.Topic
-
Indicates whether some other object is "equal to" this one.
H
- handle(Message) - Method in interface com.iantapply.relay.api.MessageHandler
-
Processes one decoded message.
- hashCode() - Method in record class com.iantapply.relay.api.Destination
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.iantapply.relay.api.Message
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.iantapply.relay.api.MessageId
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.iantapply.relay.api.MessagingStatus
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.iantapply.relay.api.PublishOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.iantapply.relay.api.Topic
-
Returns a hash code value for this object.
- headers() - Method in record class com.iantapply.relay.api.Message
-
Returns the value of the
headersrecord component. - headers() - Method in record class com.iantapply.relay.api.PublishOptions
-
Returns the value of the
headersrecord component.
I
- id() - Method in record class com.iantapply.relay.api.Message
-
Returns the value of the
idrecord component. - isValidName(String) - Static method in record class com.iantapply.relay.api.Topic
-
Tests whether a name can be used as a Relay topic.
J
- json(Class) - Static method in class com.iantapply.relay.api.Codecs
-
Returns a Gson-backed JSON codec for a concrete value type.
K
- kind() - Method in record class com.iantapply.relay.api.Destination
-
Returns the value of the
kindrecord component.
M
- maximumHandlers() - Method in record class com.iantapply.relay.api.MessagingStatus
-
Returns the value of the
maximumHandlersrecord component. - Message<T> - Record Class in com.iantapply.relay.api
-
A decoded message delivered to a topic subscriber.
- Message(MessageId, Topic, T, String, Destination, Instant, MessageId, Map) - Constructor for record class com.iantapply.relay.api.Message
-
Creates a message and defensively copies its headers.
- MessageCodec<T> - Interface in com.iantapply.relay.api
-
Explicit, safe conversion between a plugin value and its wire representation.
- MessageHandler<T> - Interface in com.iantapply.relay.api
-
Runs on Relay's dispatch executor, never on Paper's server thread.
- MessageId - Record Class in com.iantapply.relay.api
-
Strongly typed identifier for a Relay message.
- MessageId(UUID) - Constructor for record class com.iantapply.relay.api.MessageId
-
Creates an identifier from a UUID.
- MessagingService - Interface in com.iantapply.relay.api
-
Transient, at-most-once messaging.
- MessagingStatus - Record Class in com.iantapply.relay.api
-
Point-in-time operational status of a messaging service.
- MessagingStatus(boolean, boolean, String, int, int, int, int) - Constructor for record class com.iantapply.relay.api.MessagingStatus
-
Creates an instance of a
MessagingStatusrecord class. - MessagingStatus(boolean, String, int, int, int, int) - Constructor for record class com.iantapply.relay.api.MessagingStatus
-
Creates a status for transports that expose only aggregate connectivity.
N
- name() - Method in record class com.iantapply.relay.api.Topic
-
Returns the value of the
namerecord component. - node() - Method in record class com.iantapply.relay.api.MessagingStatus
-
Returns the value of the
noderecord component. - node(String) - Static method in record class com.iantapply.relay.api.Destination
-
Creates a destination for one Relay node.
- NODE - Enum constant in enum class com.iantapply.relay.api.Destination.Kind
-
One specifically identified node.
- nodeId() - Method in record class com.iantapply.relay.api.Destination
-
Returns the value of the
nodeIdrecord component.
O
- of(String, MessageCodec) - Static method in record class com.iantapply.relay.api.Topic
-
Creates and validates a topic.
- origin() - Method in record class com.iantapply.relay.api.Message
-
Returns the value of the
originrecord component.
P
- PAPER - Enum constant in enum class com.iantapply.relay.api.Destination.Kind
-
Every Paper server.
- paperServers() - Static method in record class com.iantapply.relay.api.Destination
-
Creates a destination containing every Paper server.
- parse(String) - Static method in record class com.iantapply.relay.api.MessageId
-
Parses a standard UUID string.
- payload() - Method in record class com.iantapply.relay.api.Message
-
Returns the value of the
payloadrecord component. - publish(Topic, Destination, T) - Method in interface com.iantapply.relay.api.MessagingService
-
Publishes a payload asynchronously.
- publish(Topic, Destination, T, PublishOptions) - Method in interface com.iantapply.relay.api.MessagingService
-
Publishes a payload with correlation and application metadata.
- publisherConnected() - Method in record class com.iantapply.relay.api.MessagingStatus
-
Returns the value of the
publisherConnectedrecord component. - PublishOptions - Record Class in com.iantapply.relay.api
-
Optional metadata attached to a published message.
- PublishOptions(MessageId, Map) - Constructor for record class com.iantapply.relay.api.PublishOptions
-
Creates options and defensively copies application headers.
Q
- queuedHandlers() - Method in record class com.iantapply.relay.api.MessagingStatus
-
Returns the value of the
queuedHandlersrecord component.
R
- random() - Static method in record class com.iantapply.relay.api.MessageId
-
Generates a new random identifier.
S
- status() - Method in interface com.iantapply.relay.api.MessagingService
-
Returns a point-in-time view of messaging health and dispatch capacity.
- subscribe(Topic, MessageHandler) - Method in interface com.iantapply.relay.api.MessagingService
-
Registers a handler for a topic.
- subscriberConnected() - Method in record class com.iantapply.relay.api.MessagingStatus
-
Returns the value of the
subscriberConnectedrecord component. - Subscription - Interface in com.iantapply.relay.api
-
A removable topic subscription.
- subscriptions() - Method in record class com.iantapply.relay.api.MessagingStatus
-
Returns the value of the
subscriptionsrecord component.
T
- topic() - Method in record class com.iantapply.relay.api.Message
-
Returns the value of the
topicrecord component. - Topic<T> - Record Class in com.iantapply.relay.api
-
A named messaging route paired with the codec for its payload type.
- Topic(String, MessageCodec) - Constructor for record class com.iantapply.relay.api.Topic
-
Validates a topic name and codec.
- toString() - Method in record class com.iantapply.relay.api.Destination
-
Returns a string representation of this record class.
- toString() - Method in record class com.iantapply.relay.api.Message
-
Returns a string representation of this record class.
- toString() - Method in record class com.iantapply.relay.api.MessageId
-
Returns a string representation of this record class.
- toString() - Method in record class com.iantapply.relay.api.MessagingStatus
-
Returns a string representation of this record class.
- toString() - Method in record class com.iantapply.relay.api.PublishOptions
-
Returns a string representation of this record class.
- toString() - Method in record class com.iantapply.relay.api.Topic
-
Returns a string representation of this record class.
U
V
- value() - Method in record class com.iantapply.relay.api.MessageId
-
Returns the value of the
valuerecord component. - valueOf(String) - Static method in enum class com.iantapply.relay.api.Destination.Kind
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.iantapply.relay.api.Destination.Kind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VELOCITY - Enum constant in enum class com.iantapply.relay.api.Destination.Kind
-
Every Velocity proxy.
- velocityProxies() - Static method in record class com.iantapply.relay.api.Destination
-
Creates a destination containing every Velocity proxy.
W
- wireName() - Method in record class com.iantapply.relay.api.Destination
-
Returns the stable representation used in Relay envelopes.
All Classes and Interfaces|All Packages