Index (KeySquare API)

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

accept() - Static method in interface trading.keysquare.api.edit.EditResult: Return a reusable accepted result.
add(String, String, String) - Method in interface trading.keysquare.api.topic.TopicSet: Adds a flexible topic.
add(DirectBuffer, int) - Method in interface trading.keysquare.api.topic.TopicSet: Adds the topic carried by an encoded message envelope.
add(MessageEncoderFlyweight) - Method in interface trading.keysquare.api.topic.TopicSet: Adds the topic carried by an encoded message at offset zero of the encoder buffer.
add(Topic) - Method in interface trading.keysquare.api.topic.TopicSet: Adds a topic.
add(KeyDto) - Method in interface trading.keysquare.api.topic.TopicSet: Adds the topic identified by a DTO.
addFlag(String) - Method in class trading.keysquare.api.session.KeySessionContext: Adds an experimental feature flag.
Address Data - Search tag in Overview: Section
applicationCustomStatus(String, Status, String) - Method in interface trading.keysquare.api.session.KeySessionMonitoring: Indicate an arbitrary custom status for this application which will be captured by monitoring.
applicationId() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the publisher's application id.
applicationSequenceNumber() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the sequence number assigned by the publishing application.
ApplicationStateSubscriptionListener - Class in trading.keysquare.api.subscription: A simple SubscriptionListener implementation.
ApplicationStateSubscriptionListener(KeySession, String) - Constructor for class trading.keysquare.api.subscription.ApplicationStateSubscriptionListener: Creates a listener for the supplied session and monitoring label.
applyChanges() - Method in interface trading.keysquare.api.topic.TopicSet: Publishes staged changes atomically to the platform.
AUTO - Enum constant in enum class trading.keysquare.api.clock.NanoClockFactory

B

BACK_PRESSURED - Static variable in class trading.keysquare.api.session.Result: Operation failed because the session could not send immediately.
buffer() - Method in class trading.keysquare.api.message.RawPayload: Returns the payload buffer.
BUFFER_CAPACITY_EXCEEDED - Static variable in class trading.keysquare.api.session.Result: Operation failed because the encoded message exceeded buffer capacity.
Built-in Policies - Search tag in package trading.keysquare.api.recovery: Section

C

cacheMode() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the cache behavior requested by the publisher.
cacheMode(CacheMode) - Method in interface trading.keysquare.api.message.MutableKeyHeader: Sets the caching behaviour for this publication.
causeSequenceNumber() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the sequence number that caused this message or the protocol default when no cause was supplied.
causeSequenceNumber(long) - Method in interface trading.keysquare.api.message.MutableKeyHeader: Sets the sequence number that caused this message to be published.
CLOSED - Static variable in class trading.keysquare.api.session.Result: Operation failed because the session can no longer send the message.
Codec - Interface in trading.keysquare.api.codec: Provides support for custom serialization formats.
Codec.Decoder - Interface in trading.keysquare.api.codec: Decodes custom messages for a given type.
Codec.Encoder - Interface in trading.keysquare.api.codec: Encodes custom messages for a given type.
Codec.Encoder.Writer - Interface in trading.keysquare.api.codec: Receives the encoded payload produced by Codec.Encoder.encode(Object, Writer).
Codec.Type - Record Class in trading.keysquare.api.codec: A tuple of schema id and template id, this is used to uniquely identify a type on the platform.
complete(long) - Method in interface trading.keysquare.api.subscription.TopicSetSubscriptionListener: Notification that the topic set subscription is in place.
ConcurrencyMode - Enum Class in trading.keysquare.api.session: Defines how the session may be accessed by application code.
CONCURRENT - Enum constant in enum class trading.keysquare.api.session.ConcurrencyMode: The session API may be invoked by threads other than the session agent thread, including concurrent callers.
Connect - Search tag in Overview: Section
connected(boolean) - Method in interface trading.keysquare.api.session.KeySessionListener: Callback to indicate that the connection to the platform has been established.
copyFrom(KeyMessage<?>) - Method in interface trading.keysquare.api.message.CustomMessage: Copies the message fields from the given source message and assigns the source payload reference directly.
copyFrom(KeyMessage<?>) - Method in interface trading.keysquare.api.message.DtoMessage: Copies the message fields from the given source message and clones the DTO payload.
copyFrom(KeyMessage<?>) - Method in interface trading.keysquare.api.message.FlexibleMessage: Copies the message fields from the given source message and assigns the source payload reference directly.
copyFrom(KeyMessage<?>) - Method in interface trading.keysquare.api.message.RawMessage: Copies the message fields, raw payload bytes and payload schema/template ids from the given source message into this message.
copyFrom(KeyMessage<? extends MessageFlyweight>) - Method in interface trading.keysquare.api.message.SbeMessage: Copies the message fields and SBE payload from the given source message into this message.
Counter - Interface in trading.keysquare.api.monitoring: Counter metric created with session.monitoring().createCounter(name).
create() - Method in enum class trading.keysquare.api.clock.NanoClockFactory: Creates a new NanoClock instance based on this provider strategy.
create(int, int, String, String, String) - Static method in class trading.keysquare.api.topic.Topics: Create a topic where the schema id and template id is known.
create(Class<? extends MessageFlyweight>, String, String, String) - Static method in class trading.keysquare.api.topic.Topics: Create a topic for the provided SBE or DTO class.
create(String, String, String) - Static method in class trading.keysquare.api.topic.Topics: Create a topic for flexible data type subscriptions, e.g.
create(NanoClock, KeySessionContext, KeySessionListener) - Static method in class trading.keysquare.api.session.KeySessionFactory: Create a session with the provided listener and clock.
create(KeySessionContext) - Static method in class trading.keysquare.api.session.KeySessionFactory: Create a session.
create(KeySessionContext, KeySessionListener) - Static method in class trading.keysquare.api.session.KeySessionFactory: Create a session with the provided listener.
createCounter(String) - Method in interface trading.keysquare.api.session.KeySessionMonitoring: Create a counter which will be captured by monitoring.
createHistogram(String) - Method in interface trading.keysquare.api.session.KeySessionMonitoring: Create a histogram which will be captured by monitoring.
createTopicSet(Topic) - Method in interface trading.keysquare.api.session.KeySessionExperimental
custom(long, KeyMessage<T>, T, EditListener, Duration) - Method in interface trading.keysquare.api.session.KeySessionEdit: Submit an edit request for a Custom message.
custom(Class<T>) - Static method in class trading.keysquare.api.message.Messages: Creates a Custom message for user-provided codecs.
custom(Class<T>, EditProcessor<T>) - Method in interface trading.keysquare.api.session.KeySessionEditRouting: Register an edit processor for Custom messages.
custom(Class<T>, MessageProcessor<T>, Optional<MessageProcessor<T>>) - Method in interface trading.keysquare.api.session.KeySessionRouting: Register a message processor for Custom messages.
CustomMessage<T> - Interface in trading.keysquare.api.message: A message whose payload is serialized and deserialized by a user-provided Codec.
Custom Policies - Search tag in package trading.keysquare.api.recovery: Section

D

decode(DirectBuffer, int, int) - Method in interface trading.keysquare.api.codec.Codec.Decoder: Decode the provided transport buffer.
decoder(Class<?>) - Method in interface trading.keysquare.api.codec.Codec: Provides a reusable decoder for messages of the provided type or null if the type is not supported.
delete() - Method in interface trading.keysquare.api.topic.TopicSet: Deletes the topic set from the platform and clears local membership.
disconnected() - Method in interface trading.keysquare.api.session.KeySessionListener: Callback to indicate that the connection to the platform has been lost.
dto(long, KeyMessage<T>, T, EditListener, Duration) - Method in interface trading.keysquare.api.session.KeySessionEdit: Submit an edit request for a DTO message.
dto(Class<T>) - Static method in class trading.keysquare.api.message.Messages: Creates a DTO message.
dto(Class<T>, EditProcessor<T>) - Method in interface trading.keysquare.api.session.KeySessionEditRouting: Register an edit processor for DTO messages.
dto(Class<T>, MessageProcessor<T>, Optional<MessageProcessor<T>>) - Method in interface trading.keysquare.api.session.KeySessionRouting: Register a message processor for DTO messages.
DtoMessage<T> - Interface in trading.keysquare.api.message: DTO message for publication.

E

edit() - Method in interface trading.keysquare.api.session.KeySessionExperimental: Get the edit API for submitting edit requests.
editable() - Method in interface trading.keysquare.api.message.KeyHeader: Returns true when this message may be edited through the Edit API.
editable(boolean) - Method in interface trading.keysquare.api.message.MutableKeyHeader: Sets whether this message can be edited through the edit API.
EditListener - Interface in trading.keysquare.api.edit: Requester-side callback for edit requests.
EditProcessor<T> - Interface in trading.keysquare.api.edit: Responder-side callback for handling edit requests.
EditResult - Interface in trading.keysquare.api.edit: Decision returned by an EditProcessor.
EditResult.Accepted - Class in trading.keysquare.api.edit: Reusable accepted result returned by EditResult.accept().
EditResult.Failed - Class in trading.keysquare.api.edit: Reusable failed result returned by EditResult.fail() and EditResult.fail(String).
editRouting() - Method in interface trading.keysquare.api.session.KeySessionExperimental: Get the edit routing API for registering edit processors.
encode(Object, Codec.Encoder.Writer) - Method in interface trading.keysquare.api.codec.Codec.Encoder: Encode the provided payload into writer.
encoder(Class<?>) - Method in interface trading.keysquare.api.codec.Codec: Provides a reusable encoder for messages of the provided type or null if the type is not supported.
equals(Object) - Method in record class trading.keysquare.api.codec.Codec.Type: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class trading.keysquare.api.recovery.RecoveryContext: Indicates whether some other object is "equal to" this one.
Example - Search tag in interface trading.keysquare.api.session.KeySession: Section
Example - Search tag in interface trading.keysquare.api.topic.TopicSet: Section
Example - Search tag in package trading.keysquare.api.clock: Section
Example - Search tag in package trading.keysquare.api.edit: Section
Example - Search tag in package trading.keysquare.api.message: Section
Example - Search tag in package trading.keysquare.api.monitoring: Section
Example - Search tag in package trading.keysquare.api.subscription: Section
Examples - Search tag in package trading.keysquare.api.recovery: Section
Examples - Search tag in package trading.keysquare.api.topic: Section
EXCLUSIVE - Enum constant in enum class trading.keysquare.api.session.ConcurrencyMode: The session is owned by its agent thread.

F

fail() - Static method in interface trading.keysquare.api.edit.EditResult: Return a reusable failed result with no message.
fail(String) - Static method in interface trading.keysquare.api.edit.EditResult: Return a reusable failed result with a descriptive message.
flexible(long, KeyMessage<T>, T, EditListener, Duration) - Method in interface trading.keysquare.api.session.KeySessionEdit: Submit an edit request for a Flexible message.
flexible(Class<? super T>) - Static method in class trading.keysquare.api.message.Messages: Creates a Flexible message for Object, POJO, Map, etc. payloads.
flexible(Class<? super T>, EditProcessor<T>) - Method in interface trading.keysquare.api.session.KeySessionEditRouting: Register an edit processor for Flexible messages.
flexible(Class<? super T>, MessageProcessor<T>, Optional<MessageProcessor<T>>) - Method in interface trading.keysquare.api.session.KeySessionRouting: Register a message processor for Flexible messages.
FlexibleMessage<T> - Interface in trading.keysquare.api.message: Flexible message for Object, POJO, Map, etc. payloads.

G

get(long) - Static method in class trading.keysquare.api.session.Result: Resolve a numeric result value.
getApiKey() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the API key used for application registration.
getApiVersion() - Method in interface trading.keysquare.api.session.KeySession: Returns the keysquare api version.
getApplicationGroupId() - Method in interface trading.keysquare.api.session.KeySession: Get the application group id of the application.
getApplicationGroupName() - Method in interface trading.keysquare.api.session.KeySession: Get the application group name of the application.
getApplicationId() - Method in interface trading.keysquare.api.session.KeySession: Get the application id of the application.
getApplicationName() - Method in interface trading.keysquare.api.session.KeySession: Get the application name of the application.
getApplicationName() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the application name used for KeyAccess registration, session identity and default application-owned topics.
getApplicationVersion() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the application version string sent during registration.
getConcurrencyMode() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the concurrency mode for session API access.
getCpus() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the CPUs set for pinning the session thread.
getCustomCodec() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the codec used for custom message types.
getEventLimit() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the maximum number of messages processed by the session thread in one cycle.
getFlags() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the experimental feature flags that have been set.
getGroup() - Method in interface trading.keysquare.api.topic.Topic: Get the group of this topic.
getHealthDirectory() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the directory where readiness files are written.
getHeartbeatIntervalMillis() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the heartbeat interval in milliseconds.
getHeartbeatTimeoutMillis() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the heartbeat timeout in milliseconds.
getHostname() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the hostname captured when this context was created.
getId() - Method in interface trading.keysquare.api.topic.Topic: Get the id of this topic.
getIdleStrategySupplier() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the idle strategy supplier for the session thread.
getInstance() - Static method in interface trading.keysquare.api.clock.NanoClock: Returns a singleton instance of NanoClock obtained using AUTO.
getIpcUdpAdminTermBufferLength() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the IPC_UDP message buffer length used for session control and monitoring traffic.
getIpcUdpDir() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the directory path used by IPC_UDP transport.
getIpcUdpTermBufferLength() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the IPC_UDP message buffer length used for application traffic.
getKeyAccessUrl() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the KeyAccess URL used for application registration.
getLeadershipState() - Method in interface trading.keysquare.api.session.KeySession: Returns the leadership state of the application.
getMonitoringBufferSize() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the monitoring buffer size in bytes.
getMonitoringIdleStrategySupplier() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the idle strategy supplier for the monitoring thread.
getRecoveryPolicy() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the recovery policy used after reconnect or leadership change.
getRelayAffinityTag() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the relay affinity tag used when the platform selects a relay path for this session.
getSchemaId() - Method in interface trading.keysquare.api.topic.Topic: Get the schema id of this topic.
getSessionContext() - Method in interface trading.keysquare.api.session.KeySession: Returns a copy of the configuration captured when this session was created.
getSessionThreadName() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the session thread name.
getSource() - Method in interface trading.keysquare.api.topic.Topic: Get the source of this topic.
getTcpBufferSize() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the TCP transport buffer size in bytes.
getTemplateId() - Method in interface trading.keysquare.api.topic.Topic: Get the template id of this topic.
getTopicGroup() - Method in interface trading.keysquare.api.topic.TopicSet: Returns the topic group that names this topic set.
getTopicId() - Method in interface trading.keysquare.api.topic.TopicSet: Returns the topic id that names this topic set.
getTopicSource() - Method in interface trading.keysquare.api.topic.TopicSet: Returns the topic source that names this topic set.
getTransportAddress() - Method in interface trading.keysquare.api.session.KeySession: Returns the concrete local transport address resolved when this session was created.
getTransportInterface() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the network interface configured for use for transport.
getTransportMode() - Method in class trading.keysquare.api.session.KeySessionContext: Returns the transport mode used for communication with the platform.
getValue() - Method in class trading.keysquare.api.session.Result: Returns the numeric result value.
GROUP_WILDCARD - Static variable in interface trading.keysquare.api.topic.Topic: Wildcard for the group part of a topic.

H

hashCode() - Method in record class trading.keysquare.api.codec.Codec.Type: Returns a hash code value for this object.
hashCode() - Method in record class trading.keysquare.api.recovery.RecoveryContext: Returns a hash code value for this object.
Histogram - Interface in trading.keysquare.api.monitoring: Histogram metric created with session.monitoring().createHistogram(name).

I

ID_WILDCARD - Static variable in interface trading.keysquare.api.topic.Topic: Wildcard for the id part of a topic.
IGNORE - Static variable in interface trading.keysquare.api.recovery.RecoveryPolicy: Do nothing for recovery.
increment() - Method in interface trading.keysquare.api.monitoring.Counter: Increment the counter by one.
increment(long) - Method in interface trading.keysquare.api.monitoring.Counter: Increment the counter by the given amount.
INSTANT - Enum constant in enum class trading.keysquare.api.clock.NanoClockFactory
IPC_IDP_ADMIN_TERM_BUFFER_LENGTH_DEFAULT - Static variable in class trading.keysquare.api.session.KeySessionContext: Default IPC_UDP message buffer length used for session control and monitoring traffic.
IPC_IDP_TERM_BUFFER_LENGTH_DEFAULT - Static variable in class trading.keysquare.api.session.KeySessionContext: Default IPC_UDP message buffer length used for application traffic.
isAccepted() - Method in class trading.keysquare.api.edit.EditResult.Accepted
isAccepted() - Method in class trading.keysquare.api.edit.EditResult.Failed
isAccepted() - Method in interface trading.keysquare.api.edit.EditResult: Indicates whether the edit was accepted.
isAutoReconnect() - Method in class trading.keysquare.api.session.KeySessionContext: Returns whether automatic reconnection is enabled.
isAutoReconnectApplySubscriptions() - Method in class trading.keysquare.api.session.KeySessionContext: Returns whether application subscriptions are automatically re-applied on reconnect.
isBackPressured() - Method in class trading.keysquare.api.session.Result: Returns whether this result is Result.BACK_PRESSURED.
isClosed() - Method in class trading.keysquare.api.session.Result: Returns whether this result is Result.CLOSED.
isConnected() - Method in interface trading.keysquare.api.session.KeySession: Returns a boolean indicating if the session is connected to the platform.
isFailure() - Method in class trading.keysquare.api.session.Result: Returns whether this result is not Result.OK.
isNotAuthorised() - Method in class trading.keysquare.api.session.Result: Returns whether this result is Result.NOT_AUTHORISED.
isNotConnected() - Method in class trading.keysquare.api.session.Result: Returns whether this result is Result.NOT_CONNECTED.
isOk() - Method in class trading.keysquare.api.session.Result: Returns whether this result is Result.OK.
isPassthroughSelfHeartbeats() - Method in class trading.keysquare.api.session.KeySessionContext: Returns whether this session's own heartbeat messages are delivered to application message processors.
isPrimary() - Method in interface trading.keysquare.api.session.KeySession: Returns true if this application's leadership state is PRIMARY, false otherwise.
isSecondary() - Method in interface trading.keysquare.api.session.KeySession: Returns true if this application's leadership state is SECONDARY, false otherwise.
isShutdownHookEnabled() - Method in class trading.keysquare.api.session.KeySessionContext: Returns whether the JVM shutdown hook is enabled.

K

KeyHeader - Interface in trading.keysquare.api.message: Header containing platform metadata and topic identity.
KeyMessage<T> - Interface in trading.keysquare.api.message: Sequenced message received from the platform.
KeySession - Interface in trading.keysquare.api.session: KeySession connects an application to the platform and is used for routing, subscriptions, publication and monitoring.
KeySessionContext - Class in trading.keysquare.api.session: Configuration used when creating a KeySession.
KeySessionContext() - Constructor for class trading.keysquare.api.session.KeySessionContext: Creates a context with default transport, monitoring, recovery and concurrency settings.
KeySessionContext(KeySessionContext) - Constructor for class trading.keysquare.api.session.KeySessionContext: Creates a snapshot of another context.
KeySessionEdit - Interface in trading.keysquare.api.session: Methods to submit edit requests for published data.
KeySessionEditRouting - Interface in trading.keysquare.api.session: Methods to register edit processors for different types of messages.
KeySessionExperimental - Interface in trading.keysquare.api.session: Experimental features - these are subject to change.
KeySessionFactory - Class in trading.keysquare.api.session: Factory for creating KeySession instances.
KeySessionListener - Interface in trading.keysquare.api.session: Listener for session lifecycle, fallback message handling and session-level errors.
KeySessionMonitoring - Interface in trading.keysquare.api.session: Monitoring related methods for the session.
KeySessionRouting - Interface in trading.keysquare.api.session: Methods to register message processors for different types of messages.

L

leadershipChanged(LeadershipState) - Method in interface trading.keysquare.api.session.KeySessionListener: Callback for when leadership state changes.
leadershipState() - Method in record class trading.keysquare.api.recovery.RecoveryContext: Returns the value of the leadershipState record component.
length() - Method in class trading.keysquare.api.message.RawPayload: Returns the payload length in bytes.
LoggingSubscriptionListener - Class in trading.keysquare.api.subscription: A simple SubscriptionListener implementation that logs onSuccess / onFailure notifications.
LoggingSubscriptionListener(String) - Constructor for class trading.keysquare.api.subscription.LoggingSubscriptionListener: Creates a logging listener with the supplied label.
LoggingUnsubscriptionListener - Class in trading.keysquare.api.subscription: A simple UnsubscriptionListener implementation that logs onSuccess / onFailure notifications.
LoggingUnsubscriptionListener(String) - Constructor for class trading.keysquare.api.subscription.LoggingUnsubscriptionListener: Creates a logging listener with the supplied label.

M

message() - Method in class trading.keysquare.api.edit.EditResult.Accepted
message() - Method in class trading.keysquare.api.edit.EditResult.Failed
message() - Method in interface trading.keysquare.api.edit.EditResult: Return the optional failure message.
MessageProcessor<T> - Interface in trading.keysquare.api.message: Callback for handling sequenced messages received from the platform.
Messages - Class in trading.keysquare.api.message: Static factory for creating messages for publication.
messageType() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the message type, e.g.
METADATA_ERROR - Static variable in class trading.keysquare.api.session.Result: Operation failed because message metadata was invalid.
monitoring() - Method in interface trading.keysquare.api.session.KeySession: Get the monitoring API for this session.
MutableKeyHeader<T> - Interface in trading.keysquare.api.message
MutableKeyMessage<T,M> - Interface in trading.keysquare.api.message: Mutable message parent interface.

N

NanoClock - Interface in trading.keysquare.api.clock: A clock that returns time as nanoseconds since the Unix epoch.
NanoClockFactory - Enum Class in trading.keysquare.api.clock: Factory for creating NanoClock instances.
NANOS_IN_MICROSECOND - Static variable in interface trading.keysquare.api.clock.NanoClock: Nanoseconds in a microsecond.
NANOS_IN_MILLISECOND - Static variable in interface trading.keysquare.api.clock.NanoClock: Nanoseconds in a millisecond.
NANOS_IN_SECOND - Static variable in interface trading.keysquare.api.clock.NanoClock: Nanoseconds in a second.
nanoTimeSinceEpoch() - Method in interface trading.keysquare.api.clock.NanoClock: Returns the current time in nanoseconds relative to the Unix epoch.
NATIVE - Enum constant in enum class trading.keysquare.api.clock.NanoClockFactory
NOT_AUTHORISED - Static variable in class trading.keysquare.api.session.Result: Operation failed because the caller is not authorised.
NOT_CONNECTED - Static variable in class trading.keysquare.api.session.Result: Operation failed because the session is not connected.

O

Object lifetime and mutability - Search tag in interface trading.keysquare.api.edit.EditProcessor: Section
Object lifetime and mutability - Search tag in interface trading.keysquare.api.message.MessageProcessor: Section
offset() - Method in class trading.keysquare.api.message.RawPayload: Returns the first payload byte in RawPayload.buffer().
OK - Static variable in class trading.keysquare.api.session.Result: Successful result.
onError(Throwable) - Method in interface trading.keysquare.api.session.KeySessionListener: Error handler for unexpected errors.
onFailure(long, String) - Method in interface trading.keysquare.api.edit.EditListener: Called when the edit request fails.
onFailure(String) - Method in class trading.keysquare.api.subscription.LoggingSubscriptionListener: Logs subscription failure.
onFailure(String) - Method in class trading.keysquare.api.subscription.LoggingUnsubscriptionListener: Logs unsubscription failure.
onFailure(String) - Method in interface trading.keysquare.api.subscription.SubscriptionListener: Notification that a subscription has failed.
onFailure(String) - Method in interface trading.keysquare.api.subscription.UnsubscriptionListener: Notification that an unsubscription has failed.
onRecovery(RecoveryContext, RecoveryActions) - Method in interface trading.keysquare.api.recovery.RecoveryPolicy: Called when a recovery event occurs.
onSuccess() - Method in class trading.keysquare.api.subscription.LoggingUnsubscriptionListener: Logs successful unsubscription completion.
onSuccess() - Method in interface trading.keysquare.api.subscription.UnsubscriptionListener: Notification that an unsubscription has been completed.
onSuccess(long) - Method in interface trading.keysquare.api.edit.EditListener: Called when the data owner accepts the edit request.
onSuccess(long) - Method in class trading.keysquare.api.subscription.ApplicationStateSubscriptionListener: Logs successful subscription and publishes an OK custom application status.
onSuccess(long) - Method in class trading.keysquare.api.subscription.LoggingSubscriptionListener: Logs successful subscription completion.
onSuccess(long) - Method in interface trading.keysquare.api.subscription.SubscriptionListener: Notification that a subscription has been completed.

P

payload() - Method in interface trading.keysquare.api.message.KeyMessage: Returns the payload.
payload(DirectBuffer, int, int) - Method in interface trading.keysquare.api.message.RawMessage: Sets the raw payload bytes.
payload(T) - Method in interface trading.keysquare.api.message.CustomMessage: Sets the custom payload.
payload(T) - Method in interface trading.keysquare.api.message.DtoMessage: Sets the DTO payload.
payload(T) - Method in interface trading.keysquare.api.message.FlexibleMessage: Sets the Object, POJO, Map, etc. payload.
payloadDecoder() - Method in interface trading.keysquare.api.message.SbeMessage: Returns the decoder wrapped over the current encoder payload.
payloadEncoder() - Method in interface trading.keysquare.api.message.SbeMessage: Returns the encoder assigned by SbeMessage.payloadEncoder(MessageEncoderFlyweight).
payloadEncoder(E) - Method in interface trading.keysquare.api.message.SbeMessage: Sets the SBE payload encoder for this message.
payloadHeaderEncodedLength() - Method in interface trading.keysquare.api.message.SbeMessage: Returns the SBE message header encoded length used to locate payload bytes.
payloadHeaderEncodedLength(int) - Method in interface trading.keysquare.api.message.SbeMessage: Sets the message header encoded length for this message.
payloadSchemaId() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the payload schema id.
payloadSchemaId() - Method in interface trading.keysquare.api.message.RawMessage: Returns the raw payload schema id.
payloadSchemaId(int) - Method in interface trading.keysquare.api.message.RawMessage: Sets the raw payload schema id.
payloadTemplateId() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the payload template id.
payloadTemplateId() - Method in interface trading.keysquare.api.message.RawMessage: Returns the raw payload template id.
payloadTemplateId(int) - Method in interface trading.keysquare.api.message.RawMessage: Sets the raw payload template id.
postProcess(boolean) - Method in interface trading.keysquare.api.session.KeySessionListener: Callback for applications to perform post-processing - this is invoked periodically after each duty cycle.
postProcess(boolean) - Method in interface trading.keysquare.api.session.PostProcessor: Perform post-processing after a session duty cycle.
PostProcessor - Interface in trading.keysquare.api.session: Callback invoked periodically after a batch of messages has been processed.
prepareVariableLengthEncoder() - Method in interface trading.keysquare.api.message.SbeMessage: Resets the encoder position before encoding messages with repeating groups or variable length data fields.
process(T) - Method in interface trading.keysquare.api.message.SimpleMessageProcessor: Processes a received payload.
process(KeyMessage<T>) - Method in interface trading.keysquare.api.message.MessageProcessor: Processes a received message.
process(KeyMessage<T>) - Method in interface trading.keysquare.api.message.SimpleMessageProcessor: Extracts the payload and delegates to SimpleMessageProcessor.process(Object).
process(KeyMessage<RawPayload>) - Method in interface trading.keysquare.api.session.KeySessionListener: Callback to process messages where a typed message processor hasn't been registered.
Process Data - Search tag in Overview: Section
processEdit(KeyHeader, T, T, Audit) - Method in interface trading.keysquare.api.edit.EditProcessor: Process an edit request.
publicationNanoTime() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the publisher timestamp in nanoseconds since the Unix epoch.
publish(CustomMessage<T>) - Method in interface trading.keysquare.api.session.KeySession: Publish a Custom message using a registered codec.
publish(DtoMessage<T>) - Method in interface trading.keysquare.api.session.KeySession: Publish a DTO message.
publish(FlexibleMessage<T>) - Method in interface trading.keysquare.api.session.KeySession: Publish a Flexible message.
publish(RawMessage) - Method in interface trading.keysquare.api.session.KeySession: Publish a Raw message.
publish(SbeMessage<E, D>) - Method in interface trading.keysquare.api.session.KeySession: Publish an SBE message.

R

raw() - Static method in class trading.keysquare.api.message.Messages: Creates a Raw message for pre-serialized bytes.
raw(int, int, EditProcessor<RawPayload>) - Method in interface trading.keysquare.api.session.KeySessionEditRouting: Register an edit processor for raw messages.
raw(int, int, MessageProcessor<RawPayload>, Optional<MessageProcessor<RawPayload>>) - Method in interface trading.keysquare.api.session.KeySessionRouting: Register a message processor for raw messages identified by schema and template id.
raw(long, KeyMessage<RawPayload>, RawPayload, EditListener, Duration) - Method in interface trading.keysquare.api.session.KeySessionEdit: Submit an edit request for a Raw message.
RawMessage - Interface in trading.keysquare.api.message: Raw message for publishing raw bytes.
RawPayload - Class in trading.keysquare.api.message: View over a raw payload buffer.
RawPayload() - Constructor for class trading.keysquare.api.message.RawPayload: Creates an empty raw payload view.
readinessState(ReadinessState) - Method in interface trading.keysquare.api.session.KeySessionMonitoring: Indicate readiness for this application which will be captured by monitoring.
recordValue(long) - Method in interface trading.keysquare.api.monitoring.Histogram: Record a value.
RecoveryActions - Interface in trading.keysquare.api.recovery: Actions available to a RecoveryPolicy during recovery.
RecoveryContext - Record Class in trading.keysquare.api.recovery: Context provided to a RecoveryPolicy when a recovery event occurs.
RecoveryContext(LeadershipState) - Constructor for record class trading.keysquare.api.recovery.RecoveryContext: Creates an instance of a RecoveryContext record class.
RecoveryPolicy - Interface in trading.keysquare.api.recovery: Defines the policy for recovering application state after a disruption.
RecoveryPolicy.IGNORE - Search tag in package trading.keysquare.api.recovery: Section
RecoveryPolicy.REPUBLISH_ALL - Search tag in package trading.keysquare.api.recovery: Section
RecoveryPolicy.REPUBLISH_ALL_IF_PRIMARY - Search tag in package trading.keysquare.api.recovery: Section
relayNanoTime() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the timestamp in nanoseconds since the Unix epoch for when this message was passed through the relay.
remove(String, String, String) - Method in interface trading.keysquare.api.topic.TopicSet: Removes a flexible topic.
remove(DirectBuffer, int) - Method in interface trading.keysquare.api.topic.TopicSet: Removes the topic carried by an encoded message envelope.
remove(MessageEncoderFlyweight) - Method in interface trading.keysquare.api.topic.TopicSet: Removes the topic carried by an encoded message at offset zero of the encoder buffer.
remove(Topic) - Method in interface trading.keysquare.api.topic.TopicSet: Removes a topic.
remove(KeyDto) - Method in interface trading.keysquare.api.topic.TopicSet: Removes the topic identified by a DTO.
removeAll() - Method in interface trading.keysquare.api.topic.TopicSet: Stages removal of all topics currently in this topic set.
REPUBLISH_ALL - Static variable in interface trading.keysquare.api.recovery.RecoveryPolicy: Always republish all data on recovery.
REPUBLISH_ALL_IF_PRIMARY - Static variable in interface trading.keysquare.api.recovery.RecoveryPolicy: Republish all data only when this instance is the primary.
republishAll() - Method in interface trading.keysquare.api.recovery.RecoveryActions: Republish all cached data.
requiresPublicationCache() - Method in interface trading.keysquare.api.recovery.RecoveryPolicy: Whether the publication cache should retain all published messages.
resolveApplicationId(String) - Method in interface trading.keysquare.api.session.KeySession: Given an application name, resolve this back to an application id.
resolveApplicationName(int) - Method in interface trading.keysquare.api.session.KeySession: Given an application id, resolve this back to an application name.
resolveType(Class<?>) - Method in interface trading.keysquare.api.codec.Codec: Resolves the Type (a tuple of schema id and template id) for a given class type or null if the type is not supported.
Result - Class in trading.keysquare.api.session: Result returned by session operations.
routing() - Method in interface trading.keysquare.api.session.KeySession: Get the routing API for registering message processors.

S

sbe(long, KeyMessage<? extends MessageDecoderFlyweight>, T, EditListener, Duration) - Method in interface trading.keysquare.api.session.KeySessionEdit: Submit an edit request for an SBE message.
sbe(Class<E>) - Static method in class trading.keysquare.api.message.Messages: Creates an SBE message.
sbe(Class<T>, EditProcessor<T>) - Method in interface trading.keysquare.api.session.KeySessionEditRouting: Register an edit processor for SBE messages.
sbe(Class<T>, MessageProcessor<T>, Optional<MessageProcessor<T>>) - Method in interface trading.keysquare.api.session.KeySessionRouting: Register a message processor for SBE messages.
SbeMessage<E,D> - Interface in trading.keysquare.api.message: SBE message for publication.
SCHEMA_ID_WILDCARD - Static variable in interface trading.keysquare.api.topic.Topic: Wildcard for the schema id part of a topic.
schemaId() - Method in record class trading.keysquare.api.codec.Codec.Type: Returns the value of the schemaId record component.
sequenceNumber() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the sequence number for this message.
sequencerNanoTime() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the timestamp in nanoseconds since the Unix epoch for when this message was sequenced.
sessionCreated(KeySession) - Method in interface trading.keysquare.api.session.KeySessionListener: Callback to provide the KeySession to the listener.
setApiKey(String) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the API key used for application registration.
setApplicationName(String) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the application name used for KeyAccess registration, session identity and default application-owned topics.
setApplicationVersion(String) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the application version string sent during registration.
setAutoReconnect(boolean) - Method in class trading.keysquare.api.session.KeySessionContext: Sets whether the session should automatically reconnect after a disconnect.
setAutoReconnectApplySubscriptions(boolean) - Method in class trading.keysquare.api.session.KeySessionContext: Sets whether application subscriptions are automatically re-applied on reconnect.
setConcurrencyMode(ConcurrencyMode) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the concurrency mode for session API access.
setCpus(int[]) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the CPUs available for pinning the session thread.
setCpus(String) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the CPUs available for pinning the session thread from a comma-separated string.
setCustomCodec(Codec) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the codec used for encoding and decoding custom message types.
setEventLimit(int) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the maximum number of messages processed by the session thread in one cycle.
setFlags(List<String>) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the experimental feature flags.
setHealthDirectory(String) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the directory where readiness files are written.
setHeartbeatIntervalMillis(int) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the heartbeat interval in milliseconds.
setHeartbeatTimeoutMillis(int) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the heartbeat timeout in milliseconds.
setIdleStrategy(String) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the idle strategy for the session thread by class name.
setIdleStrategySupplier(Supplier<IdleStrategy>) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the idle strategy supplier for the session thread.
setIpcUdpAdminTermBufferLength(int) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the IPC_UDP message buffer length used for session control and monitoring traffic.
setIpcUdpDir(String) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the directory path used for IPC_UDP transport, this must be set with using IPC_UDP transport.
setIpcUdpTermBufferLength(int) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the IPC_UDP message buffer length used for application traffic.
setKeyAccessUrl(String) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the KeyAccess URL used for application registration.
setMonitoringBufferSize(int) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the monitoring buffer size.
setMonitoringIdleStrategy(String) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the monitoring idle strategy by class name.
setMonitoringIdleStrategySupplier(Supplier<IdleStrategy>) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the idle strategy supplier for the monitoring thread.
setPassthroughSelfHeartbeats(boolean) - Method in class trading.keysquare.api.session.KeySessionContext: Sets whether this session's own heartbeat messages are delivered to application message processors.
setRecoveryPolicy(RecoveryPolicy) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the recovery policy used after reconnect or leadership change.
setRelayAffinityTag(String) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the relay affinity tag which is used to determine which relay should action data requests from the application.
setSessionThreadName(String) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the session thread name.
setShutdownHookEnabled(boolean) - Method in class trading.keysquare.api.session.KeySessionContext: Sets whether the session registers a JVM shutdown hook.
setTcpBufferSize(int) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the TCP buffer size for TCP transport mode.
setTransportInterface(String) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the network interface used for transport.
setTransportMode(TransportMode) - Method in class trading.keysquare.api.session.KeySessionContext: Sets the transport mode for communication with the platform.
shutdown() - Method in interface trading.keysquare.api.session.KeySessionListener: Callback for applications to perform shutdown - this is invoked before the session is closed.
SimpleMessageProcessor<T> - Interface in trading.keysquare.api.message: Simple callback for handling sequenced messages received from the platform where only the payload of the message is needed.
SOURCE_WILDCARD - Static variable in interface trading.keysquare.api.topic.Topic: Wildcard for the source part of a topic.
start() - Method in interface trading.keysquare.api.session.KeySession: Start the session.
stop() - Method in interface trading.keysquare.api.session.KeySession: Stop the session.
subscribe(SubscriptionType, SubscriptionListener, Topic...) - Method in interface trading.keysquare.api.session.KeySession: Subscribe to data.
subscribeTopicSet(String, String, String, TopicSetSubscriptionListener) - Method in interface trading.keysquare.api.session.KeySessionExperimental
SubscriptionListener - Interface in trading.keysquare.api.subscription: Callback for subscription request completion.
SYSTEM_BUSY - Static variable in class trading.keysquare.api.session.Result: Operation failed because the system is busy.

T

TEMPLATE_ID_WILDCARD - Static variable in interface trading.keysquare.api.topic.Topic: Wildcard for the template id part of a topic.
templateId() - Method in record class trading.keysquare.api.codec.Codec.Type: Returns the value of the templateId record component.
topic(int, int, CharSequence, CharSequence, CharSequence) - Method in interface trading.keysquare.api.message.RawMessage: Sets payload type and topic fields.
topic(CharSequence, CharSequence, CharSequence) - Method in interface trading.keysquare.api.message.MutableKeyHeader: Sets topic source, group and id.
topic(Topic) - Method in interface trading.keysquare.api.message.MutableKeyHeader: Sets the topic.
Topic - Interface in trading.keysquare.api.topic: Immutable topic identity used for subscriptions and topic sets.
TOPIC_ERROR - Static variable in class trading.keysquare.api.session.Result: Operation failed because the topic was invalid.
topicGroup() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the topic group.
topicGroup(CharSequence) - Method in interface trading.keysquare.api.message.MutableKeyHeader: Sets the topic group.
topicId() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the topic id.
topicId(CharSequence) - Method in interface trading.keysquare.api.message.MutableKeyHeader: Sets the topic id.
Topics - Class in trading.keysquare.api.topic: Class that provides factory methods to create Topic instances.
topicSet(String, String, String) - Static method in class trading.keysquare.api.topic.Topics: Create a topic for a topic set.
TopicSet - Interface in trading.keysquare.api.topic: A TopicSet is a collection of topics.
TopicSetSubscriptionListener - Interface in trading.keysquare.api.subscription: Callback for topic set subscription completion.
topicSource() - Method in interface trading.keysquare.api.message.KeyHeader: Returns the topic source.
topicSource(CharSequence) - Method in interface trading.keysquare.api.message.MutableKeyHeader: Sets the topic source.
toString() - Method in record class trading.keysquare.api.codec.Codec.Type: Returns a string representation of this record class.
toString() - Method in class trading.keysquare.api.edit.EditResult.Accepted
toString() - Method in class trading.keysquare.api.edit.EditResult.Failed
toString() - Method in class trading.keysquare.api.message.RawPayload
toString() - Method in record class trading.keysquare.api.recovery.RecoveryContext: Returns a string representation of this record class.
toString() - Method in class trading.keysquare.api.session.KeySessionContext
toString() - Method in class trading.keysquare.api.session.Result
trading.keysquare.api.clock - package trading.keysquare.api.clock: Provides nanosecond-resolution wall-clock timestamps.
trading.keysquare.api.codec - package trading.keysquare.api.codec: Provides custom serialization support for messages.
trading.keysquare.api.edit - package trading.keysquare.api.edit: Provides experimental APIs for requesting and processing message edits.
trading.keysquare.api.message - package trading.keysquare.api.message: Defines reusable message types for publishing and receiving SBE, DTO, flexible, custom and raw messages.
trading.keysquare.api.monitoring - package trading.keysquare.api.monitoring: Provides application readiness, status and metric reporting APIs.
trading.keysquare.api.recovery - package trading.keysquare.api.recovery: Defines recovery policies for reconnecting sessions.
trading.keysquare.api.session - package trading.keysquare.api.session: Defines the session API used to connect applications to the platform.
trading.keysquare.api.subscription - package trading.keysquare.api.subscription: Provides callbacks and helpers for subscription and unsubscription requests.
trading.keysquare.api.topic - package trading.keysquare.api.topic: Defines topics and topic sets used to address messages.
truncateGroup(String) - Static method in class trading.keysquare.api.topic.Topics: Truncate a topic group to the maximum allowed length (20 characters).
truncateId(String) - Static method in class trading.keysquare.api.topic.Topics: Truncate a topic id to the maximum allowed length (36 characters).
truncateSource(String) - Static method in class trading.keysquare.api.topic.Topics: Truncate a topic source to the maximum allowed length (20 characters).
Type(int, int) - Constructor for record class trading.keysquare.api.codec.Codec.Type: Creates an instance of a Type record class.

U

unsubscribe(UnsubscriptionListener, Topic...) - Method in interface trading.keysquare.api.session.KeySession: Unsubscribe to data.
unsubscribeTopicSet(String, String, String, UnsubscriptionListener) - Method in interface trading.keysquare.api.session.KeySessionExperimental
UnsubscriptionListener - Interface in trading.keysquare.api.subscription: Callback for unsubscription request completion.

V

valueOf(String) - Static method in enum class trading.keysquare.api.clock.NanoClockFactory: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class trading.keysquare.api.session.ConcurrencyMode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class trading.keysquare.api.clock.NanoClockFactory: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class trading.keysquare.api.session.ConcurrencyMode: Returns an array containing the constants of this enum class, in the order they are declared.
voided() - Method in interface trading.keysquare.api.message.KeyHeader: Returns true when this message voids a previously published value.
voided(boolean) - Method in interface trading.keysquare.api.message.MutableKeyHeader: Sets whether this message voids a previous value.

W

wrap(DirectBuffer, int, int) - Method in class trading.keysquare.api.message.RawPayload: Wraps the payload view around the supplied buffer range.
write(int, int, DirectBuffer, int, int) - Method in interface trading.keysquare.api.codec.Codec.Encoder.Writer: Write the type information and payload.

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values