Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- About efs - Search tag in Overview
- Section
- Access Control - Search tag in class org.efs.io.EfsFileConnection
- Section
- accessMask() - Method in enum class org.efs.io.EfsFile.AccessMode
-
Returns connect mode mask.
- accessMode() - Method in class org.efs.io.EfsFileConnection
-
Returns connect mode for this event file.
- acquireLock(AffinityLock, ThreadAffinityConfig) - Static method in class org.efs.dispatcher.config.ThreadAffinity
-
Returns an OpenHFT thread affinity lock based on an existing lock and CPU strategy configuration.
- acquireLock(ThreadAffinityConfig) - Static method in class org.efs.dispatcher.config.ThreadAffinity
-
Returns an OpenHFT thread affinity lock.
- activate() - Method in interface org.efs.activator.IEfsActivateAgent
- ACTIVATING - Enum constant in enum class org.efs.activator.EfsAgentState
-
Agent is in this temporary state while transitioning from
EfsAgentState.STAND_BYtoEfsAgentState.ACTIVE. - ActivatorEvent - Class in org.efs.activator.event
-
As
EfsActivatorsteps through its workflow, its publishes twoActivatorEvents for each step: Anin-progresstransition with a zero transition duration. - ActivatorEvent.Builder - Class in org.efs.activator.event
-
Builder class used to create an activator event.
- ActivatorEvent.StepState - Enum Class in org.efs.activator.event
-
Workflow step states are in-progress, completed (success), and completed (failed).
- Activator Execution - Search tag in package org.efs.activator
- Section
- ACTIVE - Enum constant in enum class org.efs.activator.EfsAgentState
-
Agent is both successfully started and active.
- activePublishers() - Method in class org.efs.bus.EfsPublishStatus
-
Returns number of publishers actively publishing events on
topic key. - activePublishers(int) - Method in class org.efs.bus.EfsPublishStatus.Builder
-
Sets active publisher count to given value.
- activeSubscribers() - Method in class org.efs.bus.EfsSubscribeStatus
-
Returns active subscribers count.
- activeSubscribers(int) - Method in class org.efs.bus.EfsSubscribeStatus.Builder
-
Sets active subscriber count to given value.
- Actor Model - Search tag in package org.efs.dispatcher
- Section
- add(E) - Method in class org.efs.io.EfsFileConnection
- add(Set<Integer>, E) - Method in class org.efs.io.EfsFileConnection
- addAccess(EfsTopicKey<?>) - Method in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
If this wildcard advertisement is open, then creates a new advertisement for given concrete topic matching wildcard topic.
- addAccess(EfsTopicKey<?>) - Method in class org.efs.bus.EfsEventBus.WildcardSubscription
-
If this wildcard subscription is open, then creates a new subscription for given concrete topic matching wildcard topic.
- addDelta(long) - Method in class org.efs.util.LatencyTracker
-
Adds given latency delta to collected deltas array and updates appropriate bucket tally.
- addTopic(EfsTopicKey<E>) - Method in class org.efs.bus.EfsEventBus
-
Reports a event topic key to bus independent of an advertisement or subscription.
- addTopics(Class<E>, List<String>) - Method in class org.efs.bus.EfsEventBus
-
Reports multiple topics for a given event class independent of an advertisement or subscription.
- advertise(EfsTopicKey<E>, Consumer<EfsSubscribeStatus<E>>, IEfsAgent) - Method in class org.efs.bus.EfsEventBus
-
Advertises an event class, topic published by an agent, returning a closeable instance used to retract this advertisement when closed.
- advertiseAll(Class<E>, String, Consumer<EfsSubscribeStatus<E>>, Consumer<EfsTopicKey<E>>, IEfsAgent) - Method in class org.efs.bus.EfsEventBus
-
Advertises an event class with a wildcard topic pattern, allows a publisher to publish events to all topics matching the pattern.
- advertisedPublishers() - Method in class org.efs.bus.EfsPublishStatus
-
Returns number of publishers currently advertised on
topic key. - advertisedPublishers(int) - Method in class org.efs.bus.EfsPublishStatus.Builder
-
Sets advertised publisher count to given value.
- advertisement(EfsTopicKey<E>) - Method in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Returns concrete advertisement associated with given topic key.
- ADVERTISEMENT_CLOSED - Static variable in class org.efs.bus.EfsEventBus
-
Attempting to interact with a closed advertisement results in an
IllegalStateExceptionwith the message "advertisement is closed". - advertisementCreationCount() - Method in class org.efs.bus.EfsEventBus
-
Returns current number of advertisements successfully created on this event bus.
- advertisementKeys() - Method in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Returns an immutable list containing the concrete topic keys to which this wildcard advertisement is advertised.
- advertisementTopics() - Method in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Returns an immutable list containing the concrete topics to which this wildcard advertisement is advertised.
- affinity() - Method in class org.efs.dispatcher.EfsDispatcherThread
-
Returns thread affinity configuration.
- AFFINITY_NAME_KEY - Static variable in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Key "affinityName" contain unique affinity name.
- AFFINITY_TYPE_KEY - Static variable in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Key "affinityType" contains an
ThreadAffinityConfig.AffinityTypevalue. - agent() - Method in class org.efs.dispatcher.EfsDispatchTarget
-
Returns targeted agent.
- agent() - Method in class org.efs.io.EfsFileConnection
-
Returns underlying agent owning this connection.
- agent() - Method in class org.efs.io.EfsFileConnection.Retrieval
-
Returns agent retrieving rows.
- agent(String) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Returns efs agent instance with the given name.
- AGENT_NAME_KEY - Static variable in class org.efs.activator.config.WorkflowStepConfig
-
Key "agent" contains unique activate agent name.
- Agent Activation - Search tag in Overview
- Section
- agentEventStats() - Method in class org.efs.dispatcher.EfsDispatcher.DispatcherStats
-
Returns aggregated dispatcher thread statistics for agent event count (number of events processed per run).
- agentEventStats() - Method in class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadStats
-
Returns agent statistics with respect to how many events agents processed per run.
- agentName() - Method in class org.efs.activator.WorkflowStep
-
Returns step's agent name.
- agentName() - Method in class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadStats
-
Returns currently executing agent's name.
- agentName(String) - Method in class org.efs.activator.event.ActivatorEvent.Builder
-
Sets
IEfsActivateAgentunique name. - agentName(String) - Method in class org.efs.activator.WorkflowStep.Builder
-
Sets
agentname. - Agent Processing Events - Search tag in package org.efs.dispatcher
- Section
- agentReadyTimeStats() - Method in class org.efs.dispatcher.EfsDispatcher.DispatcherStats
-
Returns aggregated dispatcher thread statistics for agent ready time (time spent on dispatcher ready queue).
- agentReadyTimeStats() - Method in class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadStats
-
Returns agent statistics with respect to how long agents spent on dispatcher ready queue before running.
- Agent Registration - Search tag in package org.efs.dispatcher
- Section
- agentRunCount() - Method in class org.efs.dispatcher.EfsDispatcher.AgentStats
-
Returns number of agents run on this thread.
- agentRunCount() - Method in class org.efs.dispatcher.EfsDispatcherThread.AgentStats
-
Returns number of agents run on this thread.
- agentRunCount() - Method in class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadStats
-
Returns total number of agents run.
- agentRunTimeStats() - Method in class org.efs.dispatcher.EfsDispatcher.DispatcherStats
-
Returns aggregated dispatcher thread statistics for agent run time (time spent processing events).
- agentRunTimeStats() - Method in class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadStats
-
Returns agent statistics with respect to how long agents spent processing events.
- Agents - Search tag in Overview
- Section
- agentState(String) - Method in class org.efs.activator.EfsActivator
-
Returns named agent's current state.
- agentState(String, EfsAgentState) - Method in class org.efs.activator.EfsActivator
-
Forcibly sets named agent's state.
- ALLOWED_TRANSITION_TIME_KEY - Static variable in class org.efs.activator.config.WorkflowStepConfig
-
Key "allowedTransitionTime" contains allowed agent transition time.
- allowedTransitionTime() - Method in class org.efs.activator.WorkflowStep
-
Returns agent's allowed time to execute this transition.
- allowedTransitionTime(Duration) - Method in class org.efs.activator.WorkflowStep.Builder
-
Sets time agent is allowed to complete the transition from begin to end state.
- ANY_CORE - Enum constant in enum class org.efs.dispatcher.config.ThreadAffinityConfig.AffinityType
-
Use
AffinityLock.acquireCore()to assign any free core to thread. - ANY_CPU - Enum constant in enum class org.efs.dispatcher.config.ThreadAffinityConfig.AffinityType
-
Use
AffinityLock.acquireLock()to assign any free CPU to thread. - ASCEND - Enum constant in enum class org.efs.activator.WorkflowDirection
-
Move agents up from a lower to a higher (or possible same) agent state.
- AsyncLogger - Class in org.efs.logging
-
This class implements
Loggerinterface with the goal of performing the actual logging asynchronously on an efs dispatcher thread. - AsyncLoggerFactory - Class in org.efs.logging
-
Utility class for creating
AsyncLoggerinstances for a given class or name. - attribute() - Element in annotation interface org.efs.io.CQAttribute
-
Returns
CQEngine attributetype used for apublic getXXX()method. - attribute(String) - Method in class org.efs.io.EfsFile
-
Returns cqengine attribute associated with given field name.
- attributeClass() - Method in enum class org.efs.io.CQAttributeType
-
Returns cqengine attribute class.
- average() - Method in class org.efs.dispatcher.EfsDispatcher.AgentStats
-
Returns average value for all stats.
- averageDelta() - Method in class org.efs.util.LatencyTracker
-
Returns current latency delta average.
B
- Basic Usage Example - Search tag in class org.efs.bus.EfsSubscribeStatus.Builder
- Section
- BEGIN_STATE_KEY - Static variable in class org.efs.activator.config.WorkflowStepConfig
-
Key "beginState" contains transition begin state.
- beginning() - Method in class org.efs.io.EfsInterval
-
Returns interval begin endpoint.
- beginning(EfsIntervalEndpoint) - Method in class org.efs.io.EfsInterval.Builder
-
Sets interval beginning endpoint.
- BEGINNING - Enum constant in enum class org.efs.io.EfsIntervalEndpoint.IntervalSide
-
Endpoint is the interval beginning endpoint.
- BEGINNING_ENDPOINT_NULL - Static variable in class org.efs.io.EfsInterval.Builder
-
When attempting to set interval's beginning endpoint to
null, thenNullPointerExceptioncontains message "beginning endpoint is null". - BEGINNING_GREATER_THAN_ENDING - Static variable in class org.efs.io.EfsInterval.Builder
-
When attempting to set interval with a beginning endpoint > ending endpoint, then
ValidationExceptioncontains message "beginning > ending". - beginState() - Method in class org.efs.activator.WorkflowStep
-
Returns agent expected begin state.
- beginState(EfsAgentState) - Method in class org.efs.activator.WorkflowStep.Builder
-
Sets expected agent begin state.
- beginSymbol() - Method in enum class org.efs.io.EfsIntervalEndpoint.Clusivity
-
Returns clusivity begin symbol.
- beginTime() - Method in class org.efs.util.LatencyTracker.Bucket
-
Returns bucket interval inclusive begin time.
- BIND_KEY - Static variable in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Key "bind" contains the bind-thread-to-affinity lock flag.
- BLOCKING - Enum constant in enum class org.efs.dispatcher.config.ThreadType
-
The thread blocks while waiting for the desired event to occur.
- bucket(int) - Method in class org.efs.util.LatencyTracker
-
Returns bucket for the given index.
- BUCKET_INDEX_OUT_OF_BOUNDS - Static variable in class org.efs.util.LatencyTracker
-
Invalid bucket index results in an
ArrayIndexOutOfBoundswith message formatted as "bucket index out-of-bounds, index=%,d, bounds=[0, %,d)". - bucketCount() - Method in class org.efs.util.LatencyTracker
-
Returns number of collected latency buckets.
- bucketIntervalSize() - Method in class org.efs.util.LatencyTracker
-
Returns bucket nanosecond interval size.
- bucketIntervalSize(long) - Method in class org.efs.util.LatencyTracker.Builder
-
Sets bucket nanosecond size.
- bucketMaximum(long) - Method in class org.efs.util.LatencyTracker.Builder
-
A final bucket used to track number of deltas ≥ given value.
- build() - Method in class org.efs.activator.EfsActivator.Builder
-
Returns a new activator based on this builder's settings.
- build() - Method in class org.efs.activator.event.ActivatorEvent.Builder
-
Returns a newly created activator event based on this builder's properties.
- build() - Method in class org.efs.activator.Workflow.Builder
-
Returns new workflow based on this builder's settings.
- build() - Method in class org.efs.activator.WorkflowStage.Builder
-
Returns new workflow stage based on this builder's settings.
- build() - Method in class org.efs.activator.WorkflowStep.Builder
-
Returns new workflow step based on this builder's settings.
- build() - Method in class org.efs.bus.EfsPublishStatus.Builder
-
Returns a new
EfsPublishStatusevent based on this builder's settings. - build() - Method in class org.efs.bus.EfsSubscribeStatus.Builder
-
Returns a new
EfsSubscribeStatusevent based on this builder's settings. - build() - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Returns a new
IEfsDispatcherinstance based on this builder's settings. - build() - Method in interface org.efs.event.IEfsEventBuilder
-
Returns a new event instance based on the builder settings.
- build() - Method in class org.efs.io.EfsInterval.Builder
-
Returns a new interval instance based on this builder's settings.
- build() - Method in class org.efs.io.EfsIntervalEndpoint.EndpointBuilder
-
Returns a new endpoint constructed from this builder's settings.
- build() - Method in class org.efs.util.LatencyTracker.Builder
-
Returns a new latency tracker instance based on this builder's settings.
- builder() - Static method in class org.efs.activator.EfsActivator
-
Returns a new
Builderinstance. - builder() - Static method in class org.efs.activator.event.ActivatorEvent
-
Returns a new activator event builder instance.
- builder() - Static method in class org.efs.activator.Workflow
-
Returns a new
Builderinstance. - builder() - Static method in class org.efs.activator.WorkflowStage
-
Returns a new
Builderinstance. - builder() - Static method in class org.efs.activator.WorkflowStep
-
Returns a new
Builderinstance. - builder() - Static method in class org.efs.bus.EfsPublishStatus
-
Returns a new
EfsPublishStatusbuilder instance. - builder() - Static method in class org.efs.bus.EfsSubscribeStatus
-
Returns a new
EfsSubscribeStatusbuilder instance. - builder() - Static method in class org.efs.io.EfsDurationEndpoint
-
Returns a new
EfsDurationEndpointbuilder instance used to create anEfsDurationEndpointobject. - builder() - Static method in class org.efs.io.EfsIndexEndpoint
-
Returns a new
EfsIndexEndpointbuilder instance used to create anEfsIndexEndpointobject. - builder() - Static method in class org.efs.io.EfsInterval
-
Returns a new
EfsIntervalbuilder instance which is used to create anEfsIntervalobject. - builder() - Static method in class org.efs.io.EfsTimeEndpoint
-
Returns a new
EfsTimeEndpointbuilder instance used to create anEfsTimeEndpointobject. - builder() - Static method in class org.efs.util.LatencyTracker
-
Returns a new
LatencyTracker.Builderinstance. - builder(String) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Returns a new dispatcher configuration builder.
- builderMethod() - Method in class org.efs.event.type.EfsEventLayout
-
Returns event
public static builder()method handle. - buildImpl() - Method in class org.efs.io.EfsDurationEndpoint.Builder
-
Returns a new
EfsDurationEndpointinstance based on this builder's settings. - buildImpl() - Method in class org.efs.io.EfsIndexEndpoint.Builder
-
Returns a new
EfsIndexEndpointinstance based on this builder's settings. - buildImpl() - Method in class org.efs.io.EfsIntervalEndpoint.EndpointBuilder
-
Returns a newly constructed endpoint.
- buildImpl() - Method in class org.efs.io.EfsTimeEndpoint.Builder
-
Returns a new
EfsTimeEndpointinstance based on this builder's settings. - buildMethod() - Method in class org.efs.event.type.EfsEventLayout
-
Returns efs event builder class required
build()method handle. - busName() - Method in class org.efs.bus.EfsEventBus
-
Returns efs event bus name which is unique within JVM.
- BUSY - Enum constant in enum class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadState
-
Dispatcher thread is busy running efs agent events.
C
- callback() - Method in class org.efs.dispatcher.EfsDispatchTarget
-
Returns callback target.
- Cancellation - Search tag in class org.efs.io.EfsFileConnection.Retrieval
- Section
- CAPACITY_TOO_BIG - Static variable in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Exception message for a queue capacity exceeds allowed size is "capacity next power of 2 exceeds 2^31".
- CAPACITY_TOO_SMALL - Static variable in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Exception message for a queue capacity less than allowed size is "capacity < 2".
- charset() - Element in annotation interface org.efs.event.EfsStringInfo
-
Returns character set name used to encode/decode
Stringfield. - CLASSES_KEY - Static variable in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Key "classes" contains
efs agentclass names supported by this dispatcher. - close() - Method in class org.efs.bus.EfsEventBus.Advertisement
-
Closes this advertisement.
- close() - Method in class org.efs.bus.EfsEventBus.Subscription
-
Closes this subscription.
- close() - Method in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Closes wildcard access point if currently open.
- close() - Method in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Closes wildcard access point if currently open.
- close() - Method in class org.efs.io.EfsFile
-
Closes this efs event file asynchronously on dispatcher thread.
- close() - Method in class org.efs.io.EfsFileConnection
-
Closes all active retrieval requests.
- close() - Method in class org.efs.io.EfsFileConnection.Retrieval
-
Reports to
EfsFilethat this retrieval request is now canceled and should be removed from request list. - CLOSED_CONNECTION - Static variable in class org.efs.io.EfsFileConnection
-
Attempting to use event file connection when closed results in an
IllegalArgumentExceptionwith message "\"%s\" event file connection is closed". - CLOSED_FILE - Static variable in class org.efs.io.EfsFile
-
Attempting to connect to event file when closed results in an
IllegalArgumentExceptionwith message "\"%s\" is closed". - CLOSED_FILE - Static variable in class org.efs.io.EfsFileConnection
-
Attempting to connect event file when closed results in an
IllegalArgumentExceptionwith message "\"%s\" event file is closed". - clusivity() - Method in class org.efs.io.EfsIntervalEndpoint
-
Returns endpoint clusivity.
- CLUSIVITY_NULL - Static variable in class org.efs.io.EfsIntervalEndpoint.EndpointBuilder
-
When attempting to set endpoint clusivity to
null, thenNullPointerExceptioncontains message "clusivity is null". - Code Example Comparison - Search tag in package org.efs.dispatcher
- Section
- compare(EfsIntervalEndpoint.IntervalLocation, EfsIntervalEndpoint.IntervalLocation) - Static method in enum class org.efs.io.EfsIntervalEndpoint.IntervalLocation
-
Returns an integer value <, equal to, or > zero if
l0is <, equal to, or >l1. - compareEndpoints(EfsIntervalEndpoint, EfsIntervalEndpoint) - Method in class org.efs.io.EfsInterval.Builder
-
Returns integer value <, equal to, or > zero if
beginis <, equal to, >end. - compareEndpoints(EfsIntervalEndpoint, EfsIntervalEndpoint) - Static method in class org.efs.io.EfsIntervalEndpoint
-
Returns integer value <, equal to, or > zero if
ep0is <, equal to, >ep1. - compareTo(EfsDurationEndpoint) - Method in class org.efs.io.EfsDurationEndpoint
- compareTo(EfsIndexEndpoint) - Method in class org.efs.io.EfsIndexEndpoint
-
Returns integer value <, equal to, or > zero if
this EfsIndexEndpointis <, equal to, or > given time endpoint argument. - compareTo(EfsTimeEndpoint) - Method in class org.efs.io.EfsTimeEndpoint
-
Returns integer value <, equal to, or > zero if
this EfsTimeEndpointis <, equal to, or > given time endpoint argument. - Comparing efs with Existing Concurrency Frameworks - Search tag in Overview
- Section
- Comparison with Existing Concurrency Frameworks - Search tag in package org.efs.dispatcher
- Section
- COMPLETED_FAILED - Enum constant in enum class org.efs.activator.event.ActivatorEvent.StepState
-
Workflow step execution failed.
- COMPLETED_SUCCESS - Enum constant in enum class org.efs.activator.event.ActivatorEvent.StepState
-
Workflow step successfully completed.
- completionTime() - Method in class org.efs.io.RetrievalCompleteEvent
-
Returns timestamp when efs event retrieval completed.
- completionType() - Method in class org.efs.io.EfsFileConnection.Retrieval
-
Returns retrieval's completion type.
- completionType() - Method in class org.efs.io.RetrievalCompleteEvent
-
Returns reason for retrieval completion.
- ConflationEvent<E> - Class in org.efs.event
-
This mutable event allows changing the encapsulated event instance even when this
ConflationEventis posted to an agent event queue. - ConflationEvent() - Constructor for class org.efs.event.ConflationEvent
-
Creates a new conflation event with no encapsulated event.
- connect(EfsFile.AccessMode, IEfsAgent) - Method in class org.efs.io.EfsFile
-
Returns an
EfsFileConnectioninstance for given connection mode and agent. - CONNECTION_CLOSED - Enum constant in enum class org.efs.io.RetrievalCompleteEvent.CompletionType
-
Retrieve terminated due to connection closing.
- contains(Class<?>) - Method in class org.efs.event.ConflationEvent
-
Return
trueif this conflation event is not empty and the contained event is a class which is assignable from the given class. - containsField(String) - Method in class org.efs.event.type.EfsEventLayout
-
Returns
trueif given name is an event field andfalseotherwise. - Core Components - Search tag in package org.efs.event
- Section
- Core Components - Search tag in package org.efs.io
- Section
- Core Operations - Search tag in class org.efs.io.EfsFileConnection
- Section
- CPU_ID - Enum constant in enum class org.efs.dispatcher.config.ThreadAffinityConfig.AffinityType
-
Use
AffinityLock.acquireLock(int cpuIdto assign a CPU with specified identifier to thread. - CPU_ID_KEY - Static variable in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Key "cpuId" contains CPU identifier used when
ThreadAffinityConfig.AFFINITY_TYPE_KEYis set toThreadAffinityConfig.AffinityType.CPU_ID. - CPU_LAST_MINUS - Enum constant in enum class org.efs.dispatcher.config.ThreadAffinityConfig.AffinityType
-
Use
AffinityLock.acquireLockLastMinus(int nto allocate a CPU from the end of the core set based on the given positive number. - CPU_OFFSET_KEY - Static variable in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Key "cpuOffset" contains CPU offset used when
ThreadAffinityConfig.AFFINITY_TYPE_KEYis set toThreadAffinityConfig.AffinityType.CPU_LAST_MINUS. - CPU_STRATEGIES - Enum constant in enum class org.efs.dispatcher.config.ThreadAffinityConfig.AffinityType
-
Use
AffinityLock.acquireLock(AffinityStrategies...)to assign a CPU for thread affinity. - CQAttribute - Annotation Interface in org.efs.io
-
Method-level, run-time annotation defining two attributes:
attribute: defines CQEngine attribute type associated with get method. - CQAttributeType - Enum Class in org.efs.io
-
Defines CQEngine
attributessupported by efs which are:SimpleAttributeSimpleNullableAttributeMultiValueAttributeMultiValueNullableAttribute - CQIndexType - Enum Class in org.efs.io
-
Defines CQEngine
attribute indextypes supported by efs which are:HashIndexNavigableIndexRadixTreeIndexReversedRadixTreeIndexSuffixTreeIndexSuffixTreeIndex - createEventFile(EfsTopicKey<E>, String) - Static method in class org.efs.io.EfsFile
-
Returns a newly created efs event file for given type+topic key and assigning the file to the given dispatcher.
- Creating an EfsScheduledTimer - Search tag in class org.efs.timer.EfsScheduledExecutor
- Section
- Creating a Retrieval Query - Search tag in package org.efs.io
- Section
- Creating Dispatchers - Search tag in class org.efs.dispatcher.EfsDispatcher
- Section
- Creating efs Scheduled Executors - Search tag in package org.efs.timer
- Section
- currentMissedEventCount() - Method in class org.efs.event.ConflationEvent
-
Returns number of missed events between initial
ConflationEvent.offer(IEfsEvent)and beforeConflationEvent.poll().
D
- dataType() - Method in class org.efs.event.type.EfsEventLayout.EfsEventField
-
Returns field Java type.
- datum() - Method in class org.efs.timer.EfsTimerEvent
-
Returns optional user-provided datum forwarded in this timer.
- deactivate() - Method in interface org.efs.activator.IEfsActivateAgent
- DEACTIVATING - Enum constant in enum class org.efs.activator.EfsAgentState
-
Agent is in this temporary state while transitioning from
EfsAgentState.ACTIVEtoEfsAgentState.STAND_BY. - debug(String) - Method in class org.efs.logging.AsyncLogger
- debug(String, Object) - Method in class org.efs.logging.AsyncLogger
- debug(String, Object...) - Method in class org.efs.logging.AsyncLogger
- debug(String, Object, Object) - Method in class org.efs.logging.AsyncLogger
- debug(String, Throwable) - Method in class org.efs.logging.AsyncLogger
- debug(Marker, String) - Method in class org.efs.logging.AsyncLogger
- debug(Marker, String, Object) - Method in class org.efs.logging.AsyncLogger
- debug(Marker, String, Object...) - Method in class org.efs.logging.AsyncLogger
- debug(Marker, String, Object, Object) - Method in class org.efs.logging.AsyncLogger
- debug(Marker, String, Throwable) - Method in class org.efs.logging.AsyncLogger
- DEFAULT_EVENT_QUEUE_CAPACITY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Default dispatcher event queue capacity is 1024.
- DEFAULT_EXECUTOR_PRIORITY - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Default scheduled service thread has
Thread.NORM_PRIORITYpriority. - DEFAULT_MAX_EVENTS - Static variable in class org.efs.dispatcher.EfsDispatcher
-
The default maximum events per call out is 4.
- DEFAULT_MAX_EVENTS - Static variable in class org.efs.dispatcher.EfsDispatcherThread
-
The default run maximum events is 4.
- DEFAULT_PARK_TIME - Static variable in class org.efs.dispatcher.EfsDispatcher
-
The default park time after spinning is 1 microsecond.
- DEFAULT_PRIORITY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Default dispatcher has
Thread.NORM_PRIORITYpriority. - DEFAULT_RUN_QUEUE_CAPACITY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Default dispatcher run queue capacity is 64.
- DEFAULT_SPIN_LIMIT - Static variable in class org.efs.dispatcher.EfsDispatcher
-
The default spin limit is 2500000 calls to
Queue.poll()before parking or yielding. - DEFAULT_THREAD_TYPE - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Default dispatcher thread type is
ThreadType.BLOCKING. - DEFAULT_THREAD_TYPE - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Default scheduled service thread type is
ThreadType.BLOCKING. - Definitions - Search tag in package org.efs.dispatcher
- Section
- delayedExecution(Duration, Runnable) - Static method in class org.efs.util.DelayedExecution
-
Executes given task after waiting specified millisecond delay.
- DelayedExecution - Class in org.efs.util
-
This class provides static methods which perform a
Runnabletask after a specified delay. - deltaCount() - Method in class org.efs.util.LatencyTracker.Bucket
-
Returns bucket interval's latency delta count.
- deltaCount() - Method in class org.efs.util.LatencyTracker
-
Returns number of latency deltas collected.
- deltaCount(int) - Method in class org.efs.util.LatencyTracker.Builder
-
Sets total number of deltas collected by latency tracker.
- deregister(IEfsAgent) - Static method in class org.efs.dispatcher.EfsDispatcher
-
De-registers agent from its dispatcher.
- deregisterListener(IEfsAgent) - Method in class org.efs.activator.EfsActivator
-
Retracts registered agent from activator state listening.
- DESCEND - Enum constant in enum class org.efs.activator.WorkflowDirection
-
Move agents down from a higher to a lower (or possible same) agent state.
- Design Goals - Search tag in package org.efs.dispatcher
- Section
- Direct Event Forwarding - Search tag in Overview
- Section
- dispatch(E) - Method in class org.efs.dispatcher.EfsDispatchTarget
-
Dispatches given event to the configured callback and agent.
- dispatch(Runnable, IEfsAgent) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Executes given task in agent dispatcher inline with dispatched tasks.
- dispatch(Consumer<E>, E, IEfsAgent) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Forwards event to agent using given callback.
- dispatch(EfsAgent) - Method in class org.efs.dispatcher.EfsDispatcher
-
Enqueues given agent to this dispatcher's run queue.
- dispatch(EfsAgent) - Method in interface org.efs.dispatcher.IEfsDispatcher
-
Enqueues given agent to dispatcher run queue.
- dispatch(EfsDispatchTarget<E>, E) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Forwards event to agent and callback contained in dispatch target.
- DISPATCH_FAILURE - Static variable in class org.efs.io.EfsFileConnection
-
If attempt to postRow event to an
EfsFile, then anIllegalStateExceptionis thrown with message "failed to dispatch %s event to \"%s\"". - dispatcher(Consumer<Runnable>) - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Sets dispatcher method used to post efs agent to dispatcher run queue for a
special dispatcheronly. - dispatcher(IEfsAgent) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Returns agent's assigned dispatcher's name.
- DISPATCHER_KEY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Key "dispatcher" sets dispatcher method.
- DISPATCHER_NAME_KEY - Static variable in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Key "dispatcherName" contains a unique dispatcher name.
- DISPATCHER_NAME_KEY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Key "dispatcherName" sets dispatcher thread name prefix.
- DISPATCHER_TYPE_KEY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Key "dispatcherType" sets dispatcher thread type.
- Dispatcher Coding example - Search tag in package org.efs.dispatcher
- Section
- dispatcherName() - Method in class org.efs.dispatcher.EfsDispatcher.DispatcherStats
-
Returns dispatcher name.
- dispatcherName() - Method in exception class org.efs.dispatcher.ThreadStartException
-
Returns failed dispatcher's name.
- dispatcherNames() - Static method in class org.efs.dispatcher.EfsDispatcher
-
Returns an immutable copy of dispatcher names.
- Dispatchers - Search tag in Overview
- Section
- DISPATCHERS_KEY - Static variable in class org.efs.dispatcher.config.EfsDispatchersConfig
-
Key "dispatchers" contains
dispatcherslist. - dispatcherState() - Method in class org.efs.dispatcher.EfsDispatcher
-
Returns current dispatcher agentState.
- dispatcherThreadStats() - Method in class org.efs.dispatcher.EfsDispatcher.DispatcherStats
-
Returns a copy of the dispatcher thread stats array.
- dispatcherType(EfsDispatcher.DispatcherType) - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Sets dispatcher type.
- Dispatching an Event to an Agent - Search tag in package org.efs.dispatcher
- Section
- Dispatching Events - Search tag in package org.efs.dispatcher
- Section
- dispatchTimestamp() - Method in class org.efs.timer.EfsTimerEvent
-
Returns when timer event dispatched to agent in Java nanoseconds (see
System.nanoTime()). - doClose() - Method in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Closes all advertisements created when this wildcard advertisement matched a concrete topic.
- doClose() - Method in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Closes all subscriptions created when this wildcard subscription matched a concrete topic.
- duration(Duration) - Method in class org.efs.activator.event.ActivatorEvent.Builder
-
Sets transition duration. if step state is
ActivatorEvent.StepState.IN_PROGRESS, then duration is automatically set toDuration.ZERO.
E
- 1. Event Reply - Search tag in class org.efs.dispatcher.EfsDispatchTarget
- Section
- 2. Event Bus Routing - Search tag in class org.efs.dispatcher.EfsDispatchTarget
- Section
- EFS - Enum constant in enum class org.efs.dispatcher.EfsDispatcher.DispatcherType
-
Default efs dispatcher type.
- EfsActivator - Class in org.efs.activator
- EfsActivator.Builder - Class in org.efs.activator
-
Builder class used to create an activator.
- EfsActivatorConfig - Class in org.efs.activator.config
-
A typesafe bean configuration used to define a named workflow traveling in a given direction across a given set of steps.
- EfsActivatorConfig() - Constructor for class org.efs.activator.config.EfsActivatorConfig
-
Default constructor required for a typesafe bean class.
- EfsAgentState - Enum Class in org.efs.activator
-
Lists the possible efs agent states.
- efs Background - Search tag in Overview
- Section
- EfsCollectionInfo - Annotation Interface in org.efs.event
-
Method-level, run-time annotation defining maximum number of elements allowed in a collection or array.
- EfsDispatcher - Class in org.efs.dispatcher
- EfsDispatcher.AgentStats - Class in org.efs.dispatcher
-
Immutable class containing aggregated
EfsDispatcherThread.AgentStatsproviding a snapshot of efs dispatcher's performance. - EfsDispatcher.Builder - Class in org.efs.dispatcher
-
Builder for constructing
EfsDispatcherinstance. - EfsDispatcher.DispatcherState - Enum Class in org.efs.dispatcher
-
A dispatcher is either stopped, started, or failed to start.
- EfsDispatcher.DispatcherStats - Class in org.efs.dispatcher
-
Contains
EfsDispatcherThread.DispatcherThreadStatsfor each dispatcher thread. - EfsDispatcher.DispatcherType - Enum Class in org.efs.dispatcher
-
Enumerates the supported efs dispatcher thread types.
- EfsDispatcherConfig - Class in org.efs.dispatcher.config
-
EfsDispatcherconfiguration definition. - EfsDispatcherConfig() - Constructor for class org.efs.dispatcher.config.EfsDispatcherConfig
-
Default constructor required for typesafe config bean.
- EfsDispatchersConfig - Class in org.efs.dispatcher.config
-
Contains list of
EfsDispatcherConfiginstances. - EfsDispatchersConfig() - Constructor for class org.efs.dispatcher.config.EfsDispatchersConfig
-
Default constructor required for typesafe config bean.
- EfsDispatcherThread - Class in org.efs.dispatcher
-
A dispatcher thread watches a given
run queueforEfsAgentinstances ready to run, attempting to acquire the next ready agent. - EfsDispatcherThread.AgentStats - Class in org.efs.dispatcher
-
This class is used to track agent performance for a variety of statistics: time spent on dispatcher ready queue, time spent processing events, and number of event processed per run.
- EfsDispatcherThread.DispatcherThreadState - Enum Class in org.efs.dispatcher
-
A dispatcher thread is either not running, idle (waiting for an available efs agent) or busy (running an efs agent).
- EfsDispatcherThread.DispatcherThreadStats - Class in org.efs.dispatcher
-
Contains the following dispatcher thread measurements (all times are in nanoseconds): dispatcher thread start time, name of agent currently executing events (set to
EfsDispatcherThread.NO_EFS_AGENTif no there is no executing agent), number of agents run by this thread, amount of time those agents spent on dispatcher ready queue, amount of time agents spend processing events, and number of events agents processed per run. - EfsDispatchTarget<E> - Class in org.efs.dispatcher
-
This immutable class combines and
IEfsAgentandConsumerinto a event delivery target byEfsDispatcher.dispatch(EfsDispatchTarget, IEfsEvent). - EfsDispatchTarget(Consumer<E>, IEfsAgent) - Constructor for class org.efs.dispatcher.EfsDispatchTarget
-
Creates a new dispatch target for given callback and efs agent.
- EfsDurationEndpoint - Class in org.efs.io
-
An interval endpoint based on event time offset.
- EfsDurationEndpoint.Builder - Class in org.efs.io
-
Builder class for
EfsDurationEndpoint. - EfsEventBus - Class in org.efs.bus
-
A publish-subscribe event bus implementation that manages type+topic-based event distribution between publishers (advertisers) and subscribers within a single JVM.
- EfsEventBus.Advertisement<E> - Class in org.efs.bus
-
An advertisement is an publishing agent's access point to a event class+topic feed.
- EfsEventBus.Subscription<E> - Class in org.efs.bus
-
Abstract base class for concrete, inbox, and router subscriptions.
- EfsEventBus.WildcardAdvertisement<E> - Class in org.efs.bus
-
Track concrete advertisements created when new topics for given event class are introduced to event bus.
- EfsEventBus.WildcardSubscription<E> - Class in org.efs.bus
-
Tracks concrete subscriptions created when new topics for given event class are introduced to event bus.
- EfsEventLayout<E> - Class in org.efs.event.type
-
Contains "getter" field names for a given efs event class.
- EfsEventLayout.EfsEventField - Class in org.efs.event.type
-
Final class containing a event field's name, getter method handle, setter method handle, and data type.
- EfsFile<E> - Class in org.efs.io
-
In-memory event file for a single event type + topic.
- EfsFile.AccessMode - Enum Class in org.efs.io
-
Defines how an agent may connect an
EfsFile: read-only, write-only, or read+write. - EfsFileConnection<E> - Class in org.efs.io
-
Provides read and/or write access to events in an
EfsFile. - EfsFileConnection.Retrieval<E> - Class in org.efs.io
-
Represents an active or completed event retrieval subscription from an
EfsFileConnection. - EfsIndexEndpoint - Class in org.efs.io
-
An interval endpoint based on event index offset.
- EfsIndexEndpoint.Builder - Class in org.efs.io
-
Builder class for
EfsIndexEndpoint. - EfsInterval - Class in org.efs.io
-
An interval consists of a beginning and ending endpoint.
- EfsInterval.Builder - Class in org.efs.io
-
EfsIntervalinstances may be created only by using aBuilderinstance. - EfsIntervalEndpoint - Class in org.efs.io
-
An
EfsIntervalconsists of two endpoints: beginning and ending. - EfsIntervalEndpoint(EfsIntervalEndpoint.EndpointBuilder<?>) - Constructor for class org.efs.io.EfsIntervalEndpoint
-
Creates a new interval endpoint with the given clusivity and interval location.
- EfsIntervalEndpoint.Clusivity - Enum Class in org.efs.io
-
Specifies whether an end point is inclusive or exclusive.
- EfsIntervalEndpoint.EndpointBuilder<T> - Class in org.efs.io
-
Base class for all endpoint builders.
- EfsIntervalEndpoint.EndpointType - Enum Class in org.efs.io
-
An endpoint is based either on fixed time, time offset, or index offset.
- EfsIntervalEndpoint.IntervalLocation - Enum Class in org.efs.io
-
Denotes if endpoint denotes past, current time, future, or future on-going.
- EfsIntervalEndpoint.IntervalSide - Enum Class in org.efs.io
-
Specifies on which interval side this endpoint is placed.
- EfsPublishStatus<E> - Class in org.efs.bus
-
Reports a given topic's publish status.
- EfsPublishStatus.Builder<E> - Class in org.efs.bus
-
Builder class used to create
EfsPublishStatusinstances. - EfsRow<E> - Class in org.efs.io
-
Contains event publish timestamp and row index for a given event.
- EfsScheduledExecutor - Class in org.efs.timer
-
Executes given timer,
IEfsAgentpairs at a specified time. - EfsScheduledExecutor(ScheduledExecutorService) - Constructor for class org.efs.timer.EfsScheduledExecutor
-
Creates a new efs scheduled service instance for the given Java scheduled service.
- EfsStringInfo - Annotation Interface in org.efs.event
-
Method-level, run-time annotation defining two attributes:
charset: definesCharsetused to encode/decode associatedStringtype. - EfsSubscribeStatus<E> - Class in org.efs.bus
-
This event is sent to publishing agents to inform on number of in-place subscribers for a given topic.
- EfsSubscribeStatus.Builder<E> - Class in org.efs.bus
-
Builder for constructing
EfsSubscribeStatusevents. - EfsTimeEndpoint - Class in org.efs.io
-
An interval endpoint based on time.
- EfsTimeEndpoint.Builder - Class in org.efs.io
-
Builder class for
EfsTimeEndpoint. - EfsTimerEvent - Class in org.efs.timer
-
Event reporting a timer expiration.
- EfsTopicKey<E> - Class in org.efs.event
-
Immutable key containing efs event class and topic uniquely defining an efs bus feed instance.
- END_STATE_KEY - Static variable in class org.efs.activator.config.WorkflowStepConfig
-
Key "endState" contains transition end state.
- ending() - Method in class org.efs.io.EfsInterval
-
Returns interval ending endpoint.
- ending(EfsIntervalEndpoint) - Method in class org.efs.io.EfsInterval.Builder
-
Sets interval ending endpoint.
- ENDING - Enum constant in enum class org.efs.io.EfsIntervalEndpoint.IntervalSide
-
Endpoint is the interval ending endpoint.
- ENDING_ENDPOINT_NULL - Static variable in class org.efs.io.EfsInterval.Builder
-
When attempting to set interval's ending endpoint to
null, thenNullPointerExceptioncontains message "ending endpoint is null". - endNever() - Method in class org.efs.io.EfsDurationEndpoint.Builder
-
Sets time offset to
ChronoUnit.FOREVER, interval location toEfsIntervalEndpoint.IntervalLocation.FUTURE, and clusivity toEfsIntervalEndpoint.Clusivity.EXCLUSIVE. - endNever() - Method in class org.efs.io.EfsIndexEndpoint.Builder
-
Sets index offset to
Integer.MAX_VALUE, interval location toEfsIntervalEndpoint.IntervalLocation.FUTURE, and clusivity toEfsIntervalEndpoint.Clusivity.EXCLUSIVE. - endNever() - Method in class org.efs.io.EfsTimeEndpoint.Builder
-
Sets endpoint to
Instant.MAX, interval location toEfsIntervalEndpoint.IntervalLocation.FUTURE, and clusivity toEfsIntervalEndpoint.Clusivity.EXCLUSIVE. - EndpointBuilder(EfsIntervalEndpoint.EndpointType) - Constructor for class org.efs.io.EfsIntervalEndpoint.EndpointBuilder
-
Creates an endpoint builder for given endpoint type.
- endpointType() - Method in class org.efs.io.EfsIntervalEndpoint
-
Returns endpoint type.
- endState() - Method in class org.efs.activator.WorkflowStep
-
Returns agent target end state.
- endState(EfsAgentState) - Method in class org.efs.activator.WorkflowStep.Builder
-
Sets target agent end state.
- endSymbol() - Method in enum class org.efs.io.EfsIntervalEndpoint.Clusivity
-
Returns clusivity end symbol.
- endTime() - Method in class org.efs.util.LatencyTracker.Bucket
-
Returns bucket interval exclusive end time.
- equals(Object) - Method in class org.efs.activator.event.ActivatorEvent
-
Returns
trueifois a non-null ActivorEventinstance whose agent name, step name, step state, initial and final states are equal. - equals(Object) - Method in class org.efs.bus.EfsPublishStatus
- equals(Object) - Method in class org.efs.bus.EfsSubscribeStatus
- equals(Object) - Method in class org.efs.event.EfsTopicKey
-
Returns
trueifois sameEfsTopicKeyinstance asthis EfsTopicKeyinstance. - equals(Object) - Method in class org.efs.io.EfsDurationEndpoint
-
Returns
trueifois anEfsDurationEndpointinstance with the same duration, clusivity, and interval location asthis EfsDurationEndpointinstance. - equals(Object) - Method in class org.efs.io.EfsIndexEndpoint
-
Returns
trueifois anEfsIndexEndpointinstance with the same index offset, clusivity, and interval location asthis EfsIndexEndpointinstance. - equals(Object) - Method in class org.efs.io.EfsInterval
-
:
Returns trueif:ois the sameEfsIntervalinstance asthisinterval orois a non-null EfsIntervalinstance with the same end points and clusivities asthis EfsIntervalinstance. - equals(Object) - Method in class org.efs.io.EfsIntervalEndpoint
-
Returns
trueifois anEfsIntervalEndpointinstance with equalEfsIntervalEndpoint.ClusivityandEfsIntervalEndpoint.IntervalLocationasthis EfsIntervalEndpointinstance. - equals(Object) - Method in class org.efs.io.EfsTimeEndpoint
-
Returns
trueifois anEfsTimeEndpointinstance with the same time, clusivity, and interval location asthis EfsTimeEndpointinstance. - equals(Object) - Method in class org.efs.timer.EfsTimerEvent
-
Returns
trueifois a non-nulltimer event with the same name and dispatcher timestamp as this timer event. - error(String) - Method in class org.efs.logging.AsyncLogger
- error(String, Object) - Method in class org.efs.logging.AsyncLogger
- error(String, Object...) - Method in class org.efs.logging.AsyncLogger
- error(String, Object, Object) - Method in class org.efs.logging.AsyncLogger
- error(String, Throwable) - Method in class org.efs.logging.AsyncLogger
- error(Marker, String) - Method in class org.efs.logging.AsyncLogger
- error(Marker, String, Object) - Method in class org.efs.logging.AsyncLogger
- error(Marker, String, Object...) - Method in class org.efs.logging.AsyncLogger
- error(Marker, String, Object, Object) - Method in class org.efs.logging.AsyncLogger
- error(Marker, String, Throwable) - Method in class org.efs.logging.AsyncLogger
- Error Handling - Search tag in class org.efs.io.EfsFileConnection.Retrieval
- Section
- Errors and exceptional states - Search tag in class org.efs.io.EfsFile
- Section
- EVENT_QUEUE_CAPACITY_KEY - Static variable in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Key "eventQueueCapacity" contains
efs agentevent queue capacity. - EVENT_QUEUE_CAPACITY_KEY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Key "eventQueueCapacity" sets efs agent maximum event queue capacity.
- Event Bus Forwarding - Search tag in Overview
- Section
- eventClass() - Method in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Returns event class.
- eventClass() - Method in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Returns event class.
- eventClass() - Method in class org.efs.event.EfsTopicKey
-
Returns feed key's efs event class.
- eventClass() - Method in class org.efs.event.type.EfsEventLayout
-
Returns efs event class.
- eventClassName() - Method in class org.efs.event.EfsTopicKey
-
Returns feed key's efs event class name.
- Event Contract - Search tag in package org.efs.event
- Section
- eventCount() - Method in class org.efs.bus.EfsEventBus.Advertisement
-
Returns total number of events posted/received by this advertisement/subscription since opening.
- eventCount() - Method in class org.efs.bus.EfsEventBus.Subscription
-
Returns total number of events posted/received by this advertisement/subscription since opening.
- Event De-duplication - Search tag in package org.efs.event
- Section
- Event Delivery - Search tag in class org.efs.io.EfsFileConnection.Retrieval
- Section
- eventFile() - Method in class org.efs.io.EfsFileConnection
-
Returns underlying efs event file.
- Event File System - Search tag in Overview
- Section
- Event File System I/O Package - Search tag in package org.efs.io
- Section
- eventQueueCapacity() - Method in class org.efs.dispatcher.EfsDispatcher
-
Returns configured agent event queue maximum capacity.
- eventQueueCapacity() - Method in interface org.efs.dispatcher.IEfsDispatcher
-
Returns configured agent event queue maximum capacity.
- eventQueueCapacity(int) - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Sets efs agent event queue capacity.
- Event Retrieval Pattern - Search tag in package org.efs.io
- Section
- Events - Search tag in Overview
- Section
- Events, Agents, and Dispatchers - Search tag in Overview
- Section
- Example: Future Subscription - Search tag in class org.efs.io.EfsFileConnection.Retrieval
- Section
- Example: Historical Retrieval with Cancellation - Search tag in class org.efs.io.EfsFileConnection.Retrieval
- Section
- Example (simplified) - Search tag in class org.efs.io.EfsFile
- Section
- Example 1: Basic Concrete Topic Publishing and Subscription - Search tag in package org.efs.bus
- Section
- Example 1: Priority-Based Routing - Search tag in interface org.efs.bus.IEventRouter
- Section
- Example 2: Content-Based Filtering and Routing - Search tag in interface org.efs.bus.IEventRouter
- Section
- Example 2: Inbox (Conflated) Subscription for Market Data - Search tag in package org.efs.bus
- Section
- Example 3: Event Router for Distributing High-Volume Events - Search tag in package org.efs.bus
- Section
- Example 3: Geographic or Customer-Based Routing - Search tag in interface org.efs.bus.IEventRouter
- Section
- Example 4: Stateful Routing Logic - Search tag in interface org.efs.bus.IEventRouter
- Section
- Example 4: Wildcard Advertising and Subscription for Market Data - Search tag in package org.efs.bus
- Section
- Example 5: Complete Order Processing Pipeline - Search tag in package org.efs.bus
- Section
- Example 5: Delegating Router - Search tag in interface org.efs.bus.IEventRouter
- Section
- Example Building EfsDispatcher - Search tag in class org.efs.dispatcher.EfsDispatcher.Builder
- Section
- Example EfsDispatcherConfig File Enty - Search tag in class org.efs.dispatcher.config.EfsDispatcherConfig
- Section
- Example EfsDispatchersConfig File Entry - Search tag in class org.efs.dispatcher.config.EfsDispatchersConfig
- Section
- Example IEfsAgent Implementation - Search tag in interface org.efs.dispatcher.IEfsAgent
- Section
- Example Typesafe Configuration Entry - Search tag in class org.efs.activator.config.EfsActivatorConfig
- Section
- Example Typesafe Configuration Entry - Search tag in class org.efs.activator.config.WorkflowStageConfig
- Section
- Example Typesafe Configuration Entry - Search tag in class org.efs.activator.config.WorkflowStepConfig
- Section
- Example Workflows - Search tag in package org.efs.activator
- Section
- exception(Throwable) - Method in class org.efs.activator.event.ActivatorEvent.Builder
-
Sets getException associated with a failed step execution.
- Exception Handling - Search tag in class org.efs.io.EfsFileConnection
- Section
- Exception Handling - Search tag in package org.efs.io
- Section
- EXCESSIVE_DELAY - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Invalid delay exceeding long size message is "delay > Long.MAX_VALUE".
- EXCESSIVE_INIT_DELAY - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Invalid initial delay exceeding long size message is "initial delay > Long.MAX_VALUE".
- EXCESSIVE_PERIOD - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Invalid period exceeding long size message is "period > Long.MAX_VALUE".
- EXCLUSIVE - Enum constant in enum class org.efs.io.EfsIntervalEndpoint.Clusivity
-
The end point time is excluded from the interval.
- execute(String, EfsAgentState, EfsAgentState, Duration) - Method in class org.efs.activator.EfsActivator
-
Executes a single explicit step on a given agent.
- executeNextStage() - Method in class org.efs.activator.EfsActivator
-
Executes next stage in workflow.
- executeNextStep() - Method in class org.efs.activator.EfsActivator
-
Executes next step in workflow.
- executeWorkflow() - Method in class org.efs.activator.EfsActivator
-
Executes all remaining stages and steps in this workflow.
- exists(EfsTopicKey<E>) - Static method in class org.efs.io.EfsFile
-
Returns
trueif efs event file exists for given topic key andfalseotherwise.
F
- Feed Management - Search tag in package org.efs.event
- Section
- field(String) - Method in class org.efs.event.type.EfsEventLayout
-
Returns event field's type.
- fields() - Method in class org.efs.event.type.EfsEventLayout
-
Returns an immutable list of event class field names.
- FILE_CLOSED - Enum constant in enum class org.efs.io.RetrievalCompleteEvent.CompletionType
-
Retrieve terminated due to file closing.
- FILE_PREVIOUSLY_CREATED - Static variable in class org.efs.io.EfsFile
-
Attempt to create an already existing efs event file results in an
IllegalStateExceptionwith message "\"%s\" previously created". - finalState(EfsAgentState) - Method in class org.efs.activator.event.ActivatorEvent.Builder
-
Sets transition final state.
- find(String) - Static method in enum class org.efs.dispatcher.config.ThreadType
-
Returns the thread type with a text name equaling
s, ignoring case. - findOrCreateBus(String) - Static method in class org.efs.bus.EfsEventBus
-
Returns efs event bus associated with the given name.
- FIXED_TIME - Enum constant in enum class org.efs.io.EfsIntervalEndpoint.EndpointType
-
A fixed time endpoint specifies a specific wall clock date/time.
- forwardEvent(E) - Method in class org.efs.bus.EfsEventBus.Subscription
-
Performs work of dispatching given event to subscribing agent and callback.
- forwardPublishStatus(EfsPublishStatus<E>) - Method in class org.efs.bus.EfsEventBus.Subscription
-
Dispatches publish status event to subscriber.
- FUTURE - Enum constant in enum class org.efs.io.EfsIntervalEndpoint.IntervalLocation
-
Interval endpoint is in the future.
G
- getAdjacent(WorkflowDirection) - Method in enum class org.efs.activator.EfsAgentState
-
Returns next state from
thisagent state in the given direction. - getAffinity() - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Returns core affinity for underlying threads.
- getAffinityType() - Method in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Returns affinity type used for creating thread affinity to selected CPU_ID.
- getAgent() - Method in class org.efs.activator.config.WorkflowStepConfig
-
Returns unique
agentname returned byIEfsAgent.name(). - getAgentName() - Method in class org.efs.activator.event.ActivatorEvent
-
Returns efs agent name.
- getAllowedTransitionTime() - Method in class org.efs.activator.config.WorkflowStepConfig
-
Returns time agent is allowed to complete transition from begin to end state.
- getBeginState() - Method in class org.efs.activator.config.WorkflowStepConfig
-
Returns agent's expected begin state.
- getBindFlag() - Method in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Returns the bind-thread-to-affinity lock setting.
- getCpuId() - Method in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Returns CPU_ID identifier used for
ThreadAffinityConfig.AffinityType.CPU_IDaffinity type. - getDispatcher(String) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Returns dispatcher associated with the given name.
- getDispatcherName() - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Returns unique dispatcher name.
- getDispatchers() - Method in class org.efs.dispatcher.config.EfsDispatchersConfig
-
Returns immutable
EfsDispatcherConfiglist. - getDuration() - Method in class org.efs.activator.event.ActivatorEvent
-
Returns allowed transition time.
- getEndState() - Method in class org.efs.activator.config.WorkflowStepConfig
-
Returns agent's target end state.
- getEvent() - Method in class org.efs.io.EfsRow
-
Returns event stored in
EfsFile. - getEventFile(EfsTopicKey<E>) - Static method in class org.efs.io.EfsFile
-
Returns a previously created efs event file.
- getEventQueueCapacity() - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Returns agent event queue capacity.
- getException() - Method in class org.efs.activator.event.ActivatorEvent
-
Returns optional getException associated with a failed step.
- getFinalState() - Method in class org.efs.activator.event.ActivatorEvent
-
Returns target agent final state.
- getInitialState() - Method in class org.efs.activator.event.ActivatorEvent
-
Returns agent initial state.
- getKey(Class<E>, String) - Static method in class org.efs.event.EfsTopicKey
-
Returns a unique efs feed key instance for given efs event class and feed topic.
- getLastMinusOffset() - Method in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Returns CPU offset used for
ThreadAffinityConfig.AffinityType.CPU_LAST_MINUSaffinity type. - getLayout(Class<E>) - Static method in class org.efs.event.type.EfsEventLayout
-
Returns layout for the given efs event class.
- getLogger(Class<?>) - Static method in class org.efs.logging.AsyncLoggerFactory
-
Returns
asynchronous loggerfor given class. - getLogger(String) - Static method in class org.efs.logging.AsyncLoggerFactory
-
Returns
asynchronous loggerfor given name. - getMaxEvents() - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Returns maximum number of events an
IEfsAgentmay process at a time. - getName() - Method in class org.efs.activator.config.WorkflowConfig
-
Returns unique workflow name.
- getName() - Method in class org.efs.logging.AsyncLogger
-
Returns logger instance's name.
- getNumThreads() - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Returns number of underlying threads.
- getParkTime() - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Returns park time used by spin+park underlying thread(s).
- getPriority() - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Returns priority of underlying threads.
- getPublishTimestamp() - Method in class org.efs.io.EfsRow
-
Returns timestamp when event was published to
EfsFile. - getRowIndex() - Method in class org.efs.io.EfsRow
-
Returns event index within
EfsFile. - getRunQueueCapacity() - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Returns dispatcher agent run queue capacity (> zero).
- getSpinLimit() - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Returns priority of underlying threads.
- getStages() - Method in class org.efs.activator.config.WorkflowConfig
-
Returns workflow stages as an immutable list.
- getStepName() - Method in class org.efs.activator.event.ActivatorEvent
-
Returns workflow step name.
- getSteps() - Method in class org.efs.activator.config.WorkflowStageConfig
-
Returns steps contained within this workflow stage.
- getStepState() - Method in class org.efs.activator.event.ActivatorEvent
-
Returns workflow step's state.
- getStrategies() - Method in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Returns immutable list of CPU_ID selection strategies used for
ThreadAffinityConfig.AffinityType.CPU_STRATEGIESaffinity type. - getSystemClock() - Static method in class org.efs.io.EfsFile
-
Returns currently configured system clock.
- getTags() - Method in class org.efs.io.EfsRow
-
Returns user-define tags immutable set.
- getter() - Method in class org.efs.event.type.EfsEventLayout.EfsEventField
-
Returns field getter method handle.
- getThreadType() - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Returns thread type for underlying thread(s).
- Getting Events to Agents - Search tag in Overview
- Section
- getWholeCoreFlag() - Method in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Returns whole core reservation bind settings.
- getWorkflows() - Method in class org.efs.activator.config.EfsActivatorConfig
-
Returns activator workflows.
H
- HASH_INDEX - Enum constant in enum class org.efs.io.CQIndexType
-
Create a
HashIndexfor attribute. - hashCode() - Method in class org.efs.activator.event.ActivatorEvent
-
Activator event hash code based on unique agent name, workflow step name, workflow step state, agent current state, and agent target final state.
- hashCode() - Method in class org.efs.bus.EfsPublishStatus
- hashCode() - Method in class org.efs.bus.EfsSubscribeStatus
- hashCode() - Method in class org.efs.event.EfsTopicKey
-
Returns efs topic key hash code based on efs event class and topic.
- hashCode() - Method in class org.efs.io.EfsDurationEndpoint
-
Returns a hash value based on endpoint duration, clusivity, and interval location.
- hashCode() - Method in class org.efs.io.EfsIndexEndpoint
-
Returns a hash value based on endpoint offset, clusivity, and interval location.
- hashCode() - Method in class org.efs.io.EfsInterval
-
Returns hash code based on end point times and clusivities.
- hashCode() - Method in class org.efs.io.EfsIntervalEndpoint
-
Returns a hash value based on endpoint clusivity and interval location.
- hashCode() - Method in class org.efs.io.EfsTimeEndpoint
-
Returns a hash value based on endpoint time, clusivity, and interval location.
- hashCode() - Method in class org.efs.timer.EfsTimerEvent
-
Returns hash code based on timer name and dispatch timestamp.
- hasSubscribers() - Method in class org.efs.bus.EfsEventBus.Advertisement
-
Returns
trueif there is at least one subscriber to this topic andfalseif there are none.
I
- id() - Method in class org.efs.io.EfsFileConnection.Retrieval
-
Returns unique retrieval identifier.
- IDLE - Enum constant in enum class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadState
-
Dispatcher thread is waiting for the next available efs agent to run.
- IEfsActivateAgent - Interface in org.efs.activator
-
Extends
IEfsAgentwith methods supporting activation. - IEfsAgent - Interface in org.efs.dispatcher
-
This interface solves the problem of start up and shutting down from a non-efs thread.
- IEfsDispatcher - Interface in org.efs.dispatcher
-
Dispatcher behavior interface.
- IEfsEvent - Interface in org.efs.event
-
Marker interface denoting that a class is an efs event.
- IEfsEventBuilder<E> - Interface in org.efs.event
-
Interface defines an efs event builder class used to create an
IEfsEventinstance. - IEventRouter<E> - Interface in org.efs.bus
-
A dynamic event router determines target agent and callback for event delivery based on event content.
- IN_PROGRESS - Enum constant in enum class org.efs.activator.event.ActivatorEvent.StepState
-
Workflow step is in-progress.
- Inbox Subscriptions - Search tag in package org.efs.bus
- Section
- INCLUSIVE - Enum constant in enum class org.efs.io.EfsIntervalEndpoint.Clusivity
-
The end point time is included in the interval.
- index() - Element in annotation interface org.efs.io.CQAttribute
-
Returns
CQEngine attribute indextype associated with the get method attribute. - INDEX_OFFSET - Enum constant in enum class org.efs.io.EfsIntervalEndpoint.EndpointType
-
An index offset endpoint is relative to feed's current index.
- indexOffset() - Method in class org.efs.io.EfsIndexEndpoint
-
Returns event store index offset.
- indexOffset(long, EfsIntervalEndpoint.Clusivity) - Method in class org.efs.io.EfsIndexEndpoint.Builder
-
Sets index offset to given value and clusivity.
- info(String) - Method in class org.efs.logging.AsyncLogger
- info(String, Object) - Method in class org.efs.logging.AsyncLogger
- info(String, Object...) - Method in class org.efs.logging.AsyncLogger
- info(String, Object, Object) - Method in class org.efs.logging.AsyncLogger
- info(String, Throwable) - Method in class org.efs.logging.AsyncLogger
- info(Marker, String) - Method in class org.efs.logging.AsyncLogger
- info(Marker, String, Object) - Method in class org.efs.logging.AsyncLogger
- info(Marker, String, Object...) - Method in class org.efs.logging.AsyncLogger
- info(Marker, String, Object, Object) - Method in class org.efs.logging.AsyncLogger
- info(Marker, String, Throwable) - Method in class org.efs.logging.AsyncLogger
- initializeWorkflow(String) - Method in class org.efs.activator.EfsActivator
-
Sets workflow to be executed.
- initialState(EfsAgentState) - Method in class org.efs.activator.event.ActivatorEvent.Builder
-
Sets transition initial state.
- instant() - Method in class org.efs.io.EfsFile
-
Returns current instant as per the current
Clock. - instant() - Method in class org.efs.io.EfsFileConnection
-
Returns current instant as per the current
Clock. - Integration with EfsFile - Search tag in class org.efs.io.EfsFileConnection.Retrieval
- Section
- interval() - Method in class org.efs.io.EfsFileConnection.Retrieval
-
Returns retrieval interval.
- Introduction - Search tag in Overview
- Section
- INVALID_ACTIVE_COUNT - Static variable in class org.efs.bus.EfsPublishStatus
-
An active publisher count < zero results in an
IllegalArgumentExceptionwith message "active publisher count < 0". - INVALID_ADVERTISED_COUNT - Static variable in class org.efs.bus.EfsPublishStatus
-
An advertised publisher count < zero results in an
IllegalArgumentExceptionwith message "advertised publisher count < 0". - INVALID_AGENT_NAME - Static variable in class org.efs.activator.EfsActivator
-
IllegalArgumentExceptionmessage when an invalid agent name is provided is "agent name is either null, an empty string, or blank". - INVALID_BUCKET_MAX - Static variable in class org.efs.util.LatencyTracker
-
Invalid maximum bucket nanosecond range results in an
IllegalArgumentExceptionwith message "bucketMaximum <= 0". - INVALID_BUCKET_SIZE - Static variable in class org.efs.util.LatencyTracker
-
Invalid nanosecond bucket interval size results in an
IllegalArgumentExceptionwith message "bucketIntervalSize <= 0". - INVALID_BUS_NAME - Static variable in class org.efs.bus.EfsEventBus
-
An invalid bus name results in an
IllegalArgumentExceptionwith message "busName is either null, an empty string, or blank". - INVALID_DELTA_COUNT - Static variable in class org.efs.util.LatencyTracker
-
Invalid delta deltaCount results in an
IllegalArgumentExceptionwith message "count <= zero". - INVALID_DISPATCHER - Static variable in class org.efs.io.EfsFile
-
An
EfsDispatchername which is eithernull, an empty string, or blanks only results in anIllegalArgumentExceptionwith message "dispatcher is either null, an empty string, or blanks". - INVALID_EVENT_QUEUE_CAPACITY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Event queue capacity <
EfsDispatcher.MIN_QUEUE_SIZEIllegalArgumentExceptionmessage is "capacity < 2". - INVALID_EXECUTOR - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Invalid executor service message is "executor is shutdown".
- INVALID_FIELD - Static variable in class org.efs.io.EfsFile
-
A field name which is either
null, an empty string, or blanks only results in anIllegalArgumentExceptionwith message "field is either null, an empty string, or blanks". - INVALID_MAX_EVENTS - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Maximum allowed events ≤ zero
IllegalArgumentExceptionmessage is "maxEvents <= zero". - INVALID_NAME - Static variable in enum class org.efs.dispatcher.config.ThreadType
-
ThreadType.find(String)invalid argument results in anIllegalArgumentExceptionwith message "name is either null, an empty string, or blank". - INVALID_NAME - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Invalid name
IllegalArgumentExceptionmessage is "name is either null, empty, or blank string". - INVALID_NAME - Static variable in class org.efs.logging.AsyncLoggerFactory
-
Invalid logger name is reported as "name is either null, an empty string, or blank".
- INVALID_NUM_THREADS - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Invalid thread count
IllegalArgumentExceptionmessage is "numThreads <= zero". - INVALID_PRIORITY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Out-of-bounds thread priority
IllegalArgumentExceptionmessage is "priority out of bounds". - INVALID_REGEX - Static variable in class org.efs.bus.EfsEventBus
-
An invalid regular expression results in an
IllegalArgumentExceptionwith message "invalid regular expression \"%s\"" containing the invalid regular expression. - INVALID_RUN_QUEUE_CAPACITY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Run queue capacity ≤ zero
IllegalArgumentExceptionmessage is "capacity <= zero". - INVALID_SPIN_LIMIT - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Spin limit ≤ zero
IllegalArgumentExceptionmessage is "limit <= zero". - INVALID_SUBSCRIBERS_COUNT - Static variable in class org.efs.bus.EfsSubscribeStatus
-
A subscriber count < zero results in an
IllegalArgumentExceptionwith message "subscriber count < 0". - INVALID_THREAD_NAME - Static variable in class org.efs.dispatcher.EfsDispatcher
-
IllegalArgumentExceptionfor an invalid thread name has message "threadName is either null, an empty string, or blank". - INVALID_TIME - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Park time ≤ zero
IllegalArgumentExceptionmessage is "time <= zero". - INVALID_TOPIC - Static variable in class org.efs.bus.EfsEventBus
-
An invalid topic results in an
IllegalArgumentExceptionwith message "topic is either null, an empty string, or blank". - INVALID_TOPIC - Static variable in class org.efs.event.EfsTopicKey
-
An invalid topic is reported with an
IllegalArgumentExceptioncontaining the message "topic is either null, an empty string, or blank". - INVALID_WORKFLOW_NAME - Static variable in class org.efs.activator.EfsActivator
-
IllegalArgumentExceptionmessage when an invalid workflow name is provided is "workflowName is either null or an empty string". - INVALID_WORKFLOW_NAME - Static variable in class org.efs.activator.Workflow
-
When an invalid workflow name is passed to
Workflow.Builder.name(String), anIllegalArgumentExceptionis thrown with message "name is either null, an empty string, or blank". - InvalidEventException - Exception Class in org.efs.event.type
-
Exception associated with failure to generate a layout for an
IEfsEvent. - InvalidEventException(Class<? extends IEfsEvent>, String) - Constructor for exception class org.efs.event.type.InvalidEventException
-
Creates a new instance of
InvalidEventExceptioncontaining invalid efs event class and detail message. - InvalidEventException(Class<? extends IEfsEvent>, String, Throwable) - Constructor for exception class org.efs.event.type.InvalidEventException
-
Constructs an instance of
InvalidEventExceptionwith the specified efs event class, detail message, and cause. - isAdjacent(EfsAgentState) - Method in enum class org.efs.activator.EfsAgentState
-
Returns
trueif given state is adjacent to this state either ascending or descending direction; otherwise returnsfalse. - isCompatible(EfsFile.AccessMode) - Method in enum class org.efs.io.EfsFile.AccessMode
-
Returns
trueif given connect mode is compatible with this connect mode andfalseotherwise. - isCompleted() - Method in class org.efs.io.EfsFileConnection.Retrieval
-
Returns
trueif retrieval request has reached completion and should now be removed from request list;falseif request is still active. - isDebugEnabled() - Method in class org.efs.logging.AsyncLogger
- isDebugEnabled(Marker) - Method in class org.efs.logging.AsyncLogger
- isDispatcher(String) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Returns
trueif given name is a known dispatcher andfalseotherwise. - isEmpty() - Method in class org.efs.event.ConflationEvent
-
Returns
trueif this conflation event does not contain an encapsulated event andfalseif it does. - isErrorEnabled() - Method in class org.efs.logging.AsyncLogger
- isErrorEnabled(Marker) - Method in class org.efs.logging.AsyncLogger
- isFuture() - Method in enum class org.efs.io.EfsIntervalEndpoint.IntervalLocation
-
Returns
trueif time is located in future. - isFuture(Instant) - Method in class org.efs.io.EfsDurationEndpoint
- isFuture(Instant) - Method in class org.efs.io.EfsIndexEndpoint
- isFuture(Instant) - Method in class org.efs.io.EfsIntervalEndpoint
-
Returns
trueif this endpoint references future events andfalseif past events only. - isFuture(Instant) - Method in class org.efs.io.EfsTimeEndpoint
- isFutureInterval(Instant) - Method in class org.efs.io.EfsInterval
-
Returns
trueif this interval references future events andfalseif references past events only. - isInbox() - Method in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Returns
trueif this wildcard subscription is an inbox subscription. - isInfoEnabled() - Method in class org.efs.logging.AsyncLogger
- isInfoEnabled(Marker) - Method in class org.efs.logging.AsyncLogger
- isInProgress() - Method in class org.efs.activator.EfsActivator
-
Returns
trueif there is a workflow activation in progress andfalseotherwise. - isMultiValue() - Method in enum class org.efs.io.CQAttributeType
-
Returns
trueif this is a multi-value attribute. - isOpen() - Method in class org.efs.bus.EfsEventBus.Advertisement
-
Returns
trueif this access point is open andfalseif closed. - isOpen() - Method in class org.efs.bus.EfsEventBus.Subscription
-
Returns
trueif this access point is open andfalseif closed. - isOpen() - Method in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Returns
trueif wildcard access point is open andfalseif closed. - isOpen() - Method in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Returns
trueif wildcard access point is open andfalseif closed. - isOpen() - Method in class org.efs.io.EfsFile
-
Returns
trueif this efs event file is open andfalseotherwise. - isOpen() - Method in class org.efs.io.EfsFileConnection
-
Returns
trueif efs event file connection is open andclosedif not. - isPast() - Method in enum class org.efs.io.EfsIntervalEndpoint.IntervalLocation
-
Returns
trueif time is located in past. - isPublished() - Method in class org.efs.bus.EfsEventBus.Advertisement
-
Returned value interpretation depends on whether this is an advertisement or a subscription: Advertisement:
truemeans that publisher is able to post events to topic andfalseif unable to post. - isPublished() - Method in class org.efs.bus.EfsEventBus.Subscription
-
Returned value interpretation depends on whether this is an advertisement or a subscription: Advertisement:
truemeans that publisher is able to post events to topic andfalseif unable to post. - isRegistered(IEfsAgent) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Returns
trueif given agent is currently registered with an efs dispatcher andfalseif not registered. - isRegisteredListener(IEfsAgent) - Method in class org.efs.activator.EfsActivator
-
Returns
trueif agent is a registered activator listener andfalseotherwise. - isSpecial() - Method in enum class org.efs.dispatcher.EfsDispatcher.DispatcherType
-
Returns
trueif this dispatcher type is a special, non-configurable dispatcher. - isTraceEnabled() - Method in class org.efs.logging.AsyncLogger
- isTraceEnabled(Marker) - Method in class org.efs.logging.AsyncLogger
- isTransition() - Method in enum class org.efs.activator.EfsAgentState
-
Returns
trueif this is a transition state andfalseif this is a persistent state. - isWarnEnabled() - Method in class org.efs.logging.AsyncLogger
- isWarnEnabled(Marker) - Method in class org.efs.logging.AsyncLogger
K
- KEY_FORMAT - Static variable in class org.efs.event.EfsTopicKey
-
Event key string format is "%s%c%s".
- KEY_IFS - Static variable in class org.efs.event.EfsTopicKey
-
Use '|' as event class and topic separator.
- Key Differences - Search tag in package org.efs.dispatcher
- Section
- Key Features - Search tag in package org.efs.io
- Section
- Key Points - Search tag in class org.efs.io.EfsFileConnection
- Section
L
- LatencyTracker - Class in org.efs.util
-
Measures and tracks latency metrics for performance analysis of timed operations.
- LatencyTracker.Bucket - Class in org.efs.util
-
Histogram bucket that tracks the count of latency measurements within a specific nanosecond time interval.
- LatencyTracker.Builder - Class in org.efs.util
-
Builder for constructing
LatencyTrackerinstances with configurable latency measurement parameters. - latestEventTimestamp() - Method in class org.efs.bus.EfsEventBus.Advertisement
-
Returns millisecond timestamp of latest event posted/received by this advertisement/subscription.
- latestEventTimestamp() - Method in class org.efs.bus.EfsEventBus.Subscription
-
Returns millisecond timestamp of latest event posted/received by this advertisement/subscription.
- Lifecycle - Search tag in class org.efs.io.EfsFile
- Section
- Lifecycle - Search tag in class org.efs.io.EfsFileConnection.Retrieval
- Section
- LMAX Disruptor - Search tag in package org.efs.dispatcher
- Section
- loadActivator(String) - Static method in class org.efs.activator.EfsActivator
-
Returns activator based on configuration loaded from given file name.
- loadDispatchers(EfsDispatchersConfig) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Loads dispatcher definitions from named file and then creates and starts dispatchers based on those definitions.
- loadDispatchersConfigFile(File) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Loads dispatcher definitions from named file and then creates and starts dispatchers based on those definitions.
- location() - Method in class org.efs.io.EfsIntervalEndpoint
-
Returns endpoint interval location.
- LOCATION_NULL - Static variable in class org.efs.io.EfsIntervalEndpoint.EndpointBuilder
-
When attempting to set endpoint location to
null, thenNullPointerExceptioncontains message "location is null". - LOGGER_DISPATCHER_NAME - Static variable in class org.efs.logging.AsyncLogger
-
Asynchronous logging is performed on dispatcher "AsyncLoggerDispatcher".
M
- mActive - Variable in class org.efs.bus.EfsEventBus.Advertisement
-
Set to
trueif access point is active andfalseotherwise. - mActive - Variable in class org.efs.bus.EfsEventBus.Subscription
-
Set to
trueif access point is active andfalseotherwise. - mAgent - Variable in class org.efs.bus.EfsEventBus.Advertisement
-
Publishing or subscribing agent.
- mAgent - Variable in class org.efs.bus.EfsEventBus.Subscription
-
Publishing or subscribing agent.
- mAgent - Variable in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Dispatch event to this agent.
- mAgent - Variable in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Dispatch event to this agent.
- MAX_AGENT_STATS - Static variable in class org.efs.dispatcher.EfsDispatcherThread
-
Collect at most 1024 agent statistics.
- MAX_ALLOWED_TRANSITION_TIME - Static variable in class org.efs.activator.WorkflowStep
-
Maximum allowed agent transition time is one hour.
- MAX_EVENTS_KEY - Static variable in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Key "maxEvents" contains maximum number of events an efs agent may process at any one time.
- MAX_EVENTS_KEY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Key "maxEvents" set agent maximum events per call out.
- MAX_REGEX_SIZE - Static variable in class org.efs.bus.EfsEventBus
-
Wildcard advertisement and subscription regular expressions must be ≤ 500 characters.
- maxEvents() - Method in class org.efs.dispatcher.EfsDispatcher.DispatcherStats
-
Returns maximum events per agent call out.
- maxEvents() - Method in class org.efs.dispatcher.EfsDispatcher
-
Returns maximum number of events an agent is allowed to process per callback.
- maxEvents() - Method in class org.efs.dispatcher.EfsDispatcherThread
-
Returns thread maximum events per agent call out.
- maxEvents() - Method in interface org.efs.dispatcher.IEfsDispatcher
-
Returns maximum number of events an agent is allowed to process per callback.
- maxEvents(int) - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Sets maximum number of events agent is allowed to process per call out.
- maximumBucketTime() - Method in class org.efs.util.LatencyTracker
-
Returns overflow bucket's maximum nanosecond time.
- maximumDelta() - Method in class org.efs.util.LatencyTracker
-
Returns maximum latency delta.
- maximumSize() - Element in annotation interface org.efs.event.EfsCollectionInfo
-
Returns maximum number of elements allowed in collection.
- maximumSize() - Element in annotation interface org.efs.event.EfsStringInfo
-
Returns
Stringmaximum size in bytes. - mClusivity - Variable in class org.efs.io.EfsIntervalEndpoint.EndpointBuilder
-
Endpoint is either inclusive or exclusive.
- mClusivity - Variable in class org.efs.io.EfsIntervalEndpoint
-
Endpoint is either inclusive or exclusive.
- Metadata Annotations - Search tag in package org.efs.event
- Section
- mEventClass - Variable in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Accessing this event class.
- mEventClass - Variable in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Accessing this event class.
- mEventCount - Variable in class org.efs.bus.EfsEventBus.Advertisement
-
Total number of events posted/received on this advertisement/subscription.
- mEventCount - Variable in class org.efs.bus.EfsEventBus.Subscription
-
Total number of events posted/received on this advertisement/subscription.
- MIN_QUEUE_SIZE - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Event queue minimum allowed size is 2.
- minimumDelta() - Method in class org.efs.util.LatencyTracker
-
Returns minimum latency delta.
- missedEventCount() - Method in class org.efs.event.ConflationEvent
-
Returns missed count set after the most recent
poll. - MISSING_AGENT_NAME - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Missing agent name message is "agent name is either null, empty, or blank string".
- mLatestEvent - Variable in class org.efs.bus.EfsEventBus.Advertisement
-
Timestamp of latest event posted/received on this topic.
- mLatestEvent - Variable in class org.efs.bus.EfsEventBus.Subscription
-
Timestamp of latest event posted/received on this topic.
- mLocation - Variable in class org.efs.io.EfsIntervalEndpoint.EndpointBuilder
-
Endpoint is either in the past, now, or in the future.
- mLocation - Variable in class org.efs.io.EfsIntervalEndpoint
-
Endpoint location within interval.
- Monitor EfsActivator - Search tag in package org.efs.activator
- Section
- movingAverage() - Method in class org.efs.dispatcher.EfsDispatcherThread.AgentStats
-
Returns current moving average.
- mPattern - Variable in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Compiled
EfsEventBus.WildcardAccessPoint.mWildcardTopic. - mPattern - Variable in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Compiled
EfsEventBus.WildcardAccessPoint.mWildcardTopic. - mPubStatus - Variable in class org.efs.bus.EfsEventBus.Advertisement
-
Set to
trueif there is a publisher actively posting events to this topic andfalseif not. - mPubStatus - Variable in class org.efs.bus.EfsEventBus.Subscription
-
Set to
trueif there is a publisher actively posting events to this topic andfalseif not. - mTopic - Variable in class org.efs.bus.EfsEventBus.Advertisement
-
Accesses this topic feed.
- mTopic - Variable in class org.efs.bus.EfsEventBus.Subscription
-
Accesses this topic feed.
- mTopicUpdate - Variable in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Report newly discovered topic keys to agent via this callback.
- mTopicUpdate - Variable in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Report newly discovered topic keys to agent via this callback.
- mType - Variable in class org.efs.io.EfsIntervalEndpoint.EndpointBuilder
-
Specified endpoint type: fixed time, time offset, or index offset.
- mType - Variable in class org.efs.io.EfsIntervalEndpoint
-
Endpoint type.
- MULTIVALUE - Enum constant in enum class org.efs.io.CQAttributeType
-
Create a
MultiValueAttributefor event field. - MULTIVALUE_NULLABLE - Enum constant in enum class org.efs.io.CQAttributeType
-
Create a
MultiValueNullableAttributefor event field. - mWildcardTopic - Variable in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Regular expression topic matched against concrete topics.
- mWildcardTopic - Variable in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Regular expression topic matched against concrete topics.
N
- name() - Method in class org.efs.activator.Workflow
-
Returns workflow name.
- name() - Method in class org.efs.dispatcher.EfsDispatcher
-
Returns dispatcher name.
- name() - Method in interface org.efs.dispatcher.IEfsAgent
-
Returns unique efs agent name.
- name() - Method in interface org.efs.dispatcher.IEfsDispatcher
-
Returns dispatcher's unique name.
- name() - Method in class org.efs.event.type.EfsEventLayout.EfsEventField
-
Returns field name.
- name() - Method in class org.efs.io.EfsFile
-
Returns uniquely identifying file name.
- name(String) - Method in class org.efs.activator.Workflow.Builder
-
Sets workflow name which must be unique within activator.
- NAME_KEY - Static variable in class org.efs.activator.config.WorkflowConfig
-
Key "name" contains unique workflow name.
- NAVIGABLE_INDEX - Enum constant in enum class org.efs.io.CQIndexType
-
Create a
NavigableIndexfor attribute. - NEGATIVE_DELAY - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Invalid negative delay message is "delay < zero".
- NEGATIVE_DELAY - Static variable in class org.efs.util.DelayedExecution
-
When delay is < zero, an
IllegalArgumentExceptionis thrown with message "delay < zero". - NEGATIVE_DELTA - Static variable in class org.efs.util.LatencyTracker
-
Invalid nanosecond latency delta results in an
IllegalArgumentExceptionwith message "delta < zero". - NEGATIVE_INIT_DELAY - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Invalid negative initial delay message is "initial delay < zero".
- NEGATIVE_PERIOD - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Invalid negative period message is "period <= zero".
- NEGATIVE_REPEAT_DELAY - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Negative repeat delay message is "delay <= zero".
- nestedLogger() - Method in class org.efs.logging.AsyncLogger
-
Returns nested logger.
- NO_EFS_AGENT - Static variable in class org.efs.dispatcher.EfsDispatcherThread
-
Set efs agent name to "(idle)" when dispatcher thread is idle.
- NO_INDEX - Enum constant in enum class org.efs.io.CQIndexType
-
Do not create an index for attribute.
- NO_MESSAGE - Static variable in class org.efs.activator.event.ActivatorEvent
-
Exception did not contain a message.
- NO_SUBSCRIBERS - Static variable in class org.efs.bus.EfsEventBus
-
Attempting to publish an event while there are no subscribers to the topic results in an
IllegalStateExceptionwith the message "no subscribers". - NO_SUCH_FILE - Static variable in class org.efs.io.EfsFile
-
Attempt to obtain an efs event file that does not exist results in an
IllegalStateExceptionwith message "\"%s\" does not exist". - NO_TAGS - Static variable in class org.efs.io.EfsFile
-
Empty immutable set of user defined tags.
- NO_WORKFLOW_IN_PROGRESS - Static variable in class org.efs.activator.EfsActivator
-
IllegalStateExceptionmessage when execution is called but there is not workflow in progress (""no workflow in-progress""). - NOT_STARTED - Enum constant in enum class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadState
-
Dispatcher thread is not running due to it not yet being started.
- now(EfsIntervalEndpoint.Clusivity) - Method in class org.efs.io.EfsDurationEndpoint.Builder
-
Sets time offset to zero with the given clusivity.
- now(EfsIntervalEndpoint.Clusivity) - Method in class org.efs.io.EfsIndexEndpoint.Builder
-
Sets index offset to zero with the given clusivity.
- now(EfsIntervalEndpoint.Clusivity) - Method in class org.efs.io.EfsTimeEndpoint.Builder
-
Sets endpoint time to current time, interval location to
EfsIntervalEndpoint.IntervalLocation.NOW, and clusivity to given value. - NOW - Enum constant in enum class org.efs.io.EfsIntervalEndpoint.IntervalLocation
-
Interval endpoint is the current time.
- NULL_ACCESS_MODE - Static variable in class org.efs.io.EfsFile
-
A
nullconnect mode results in aNullPointerExceptionwith message "accessMode is null". - NULL_AGENT - Static variable in class org.efs.activator.EfsActivator
-
NullPointerExceptionmessage for a null agent is "agent is null". - NULL_AGENT - Static variable in class org.efs.bus.EfsEventBus
-
A null agent argument results in a
NullPointerExceptionwith message "agent is null". - NULL_AGENT - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Invalid efs agent
NullPointerExceptionmessage is "agent is null". - NULL_AGENT - Static variable in class org.efs.io.EfsFile
-
A
nullagent results in aNullPointerExceptionwith message "agent is null". - NULL_AGENT - Static variable in class org.efs.timer.EfsScheduledExecutor
-
nullefs agent message is "agent is null". - NULL_CALLBACK - Static variable in class org.efs.activator.EfsActivator
-
NullPointerExceptionmessage for a null callback is "callback is null". - NULL_CALLBACK - Static variable in class org.efs.bus.EfsEventBus
-
A null callback results in a
NullPointerExceptionwith message "callback is null". - NULL_CALLBACK - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Invalid callback
NullPointerExceptionmessage is "callback is null". - NULL_CALLBACK - Static variable in class org.efs.timer.EfsScheduledExecutor
-
nullcallback lambda message is "callback is null". - NULL_CLASS - Static variable in class org.efs.logging.AsyncLoggerFactory
-
Null logger class is reported as "class is null".
- NULL_CLOCK - Static variable in class org.efs.io.EfsFile
-
A
nullclock results in aNullPointerExceptionwith message "clock is null". - NULL_CONFIG - Static variable in class org.efs.dispatcher.config.ThreadAffinity
-
A
null ThreadAffinityConfigis reported as "config is null". - NULL_CONFIG_FILE - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Invalid dispatcher configuration file
NullPointExceptionmessage is "configFile is null". - NULL_DELAY - Static variable in class org.efs.timer.EfsScheduledExecutor
-
nulldelay message is "delay is null". - NULL_DELAY - Static variable in class org.efs.util.DelayedExecution
-
When delay is
null, aNullPointerExceptionis thrown with message "delay is null". - NULL_DISPATCH_TARGET - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Invalid dispatch target
NullPointerExceptionmessage is "target is null". - NULL_DISPATCHER - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Null dispatcher
NullPointerExceptionmessage is "dispatcher is null". - NULL_DISPATCHERS - Static variable in class org.efs.dispatcher.config.EfsDispatchersConfig
-
If
EfsDispatchersConfig.setDispatchers(List)is passed anulllist, then throwNullPointerExceptionhas message "dispatchers is null". - NULL_DONE_CALLBACK - Static variable in class org.efs.io.EfsFileConnection
-
A
nullretrieval complete callback results in aNullPointerExceptionwith message "completion callback is null". - NULL_EVENT - Static variable in class org.efs.bus.EfsEventBus
-
A null event argument results in a
NullPointerExceptionwith message "event is null". - NULL_EVENT - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Invalid event
NullPointerExceptionmessage is "event is null". - NULL_EVENT - Static variable in class org.efs.io.EfsFileConnection
-
A
nullevent results in aNullPointerExceptionwith message "event is null". - NULL_EVENT_CALLBACK - Static variable in class org.efs.io.EfsFileConnection
-
A
nullevent retrieval callback results in aNullPointerExceptionwith message "event callback is null". - NULL_EVENT_CLASS - Static variable in class org.efs.bus.EfsEventBus
-
A null event class results in a
NullPointerExceptionwith message "eventClass is null". - NULL_EXECUTOR - Static variable in class org.efs.timer.EfsScheduledExecutor
-
nullscheduled service message is "executor is null". - NULL_INIT_DELAY - Static variable in class org.efs.timer.EfsScheduledExecutor
-
nullinitial delay message is "initial delay is null". - NULL_INTERVAL - Static variable in class org.efs.io.EfsFileConnection
-
A
nullinterval results in aNullPointerExceptionwith message "interval is null". - NULL_LOCK - Static variable in class org.efs.dispatcher.config.ThreadAffinity
-
A
null AffinityLockis reported as "lock is null". - NULL_PERIOD - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Invalid
nullperiod message is "period is null". - NULL_QUERY - Static variable in class org.efs.io.EfsFileConnection
-
A
nullretrieval condition results in aNullPointerExceptionwith message "query is null". - NULL_ROUTER - Static variable in class org.efs.bus.EfsEventBus
-
A null event router argument results in a
NullPointerExceptionwith message "event router is null". - NULL_RUN_QUEUE - Static variable in class org.efs.dispatcher.EfsDispatcher
-
NullPointerExceptionfor a null run queue has message "queue is null". - NULL_STATE - Static variable in class org.efs.activator.event.ActivatorEvent
-
Common failure reason.
- NULL_TAGS - Static variable in class org.efs.io.EfsFileConnection
-
A
nullevents tags set results in aNullPointerExceptionwith message "tags is null". - NULL_TASK - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Invalid dispatch task
NullPointerExceptionmessage is "task is null". - NULL_TASK - Static variable in class org.efs.util.DelayedExecution
-
When task is
null, aNullPointerExceptionis thrown with message "task is null". - NULL_THREAD_TYPE - Static variable in class org.efs.dispatcher.EfsDispatcher
-
NullPointerExceptionfor a null thread type has message "threadType is null". - NULL_TIME - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Null park time
NullPointerExceptionmessage is "time is null". - NULL_TIMESTAMP - Static variable in class org.efs.util.LatencyTracker
-
A
nulltimestamp results in aNullPointerExceptionwith message "timestamp is null". - NULL_TOPIC_KEY - Static variable in class org.efs.bus.EfsEventBus
-
A null topic key results in a
NullPointerExceptionwith message "topicKey is null". - NULL_TOPIC_KEY - Static variable in class org.efs.io.EfsFile
-
A
null EfsTopicKeyargument results in aNullPointerExceptionwith message "key is null". - NULL_TOPICS - Static variable in class org.efs.bus.EfsEventBus
-
A null topics list argument results in a
NullPointerExceptionwith message "topics is null". - NULL_TYPE - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Invalid dispatcher type
NullPointerExceptionmessage is "type is null". - NULL_TYPE - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Invalid thread type message is "type is null".
- nullValues() - Element in annotation interface org.efs.io.CQAttribute
-
Returns
trueif a multi-value field containsnullvalues; otherwise returnsfalse. - NUM_THREADS_KEY - Static variable in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Key "numThreads" contains number of underlying dispatcher threads.
- NUM_THREADS_KEY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Key "numThreads" sets dispatcher thread count;
- numThreads(int) - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Sets dispatcher thread count.
O
- offer(E) - Method in class org.efs.event.ConflationEvent
-
Sets encapsulate event and returns
trueif encapsulated event was initiallynullandfalseotherwise. - Ordering and guarantees - Search tag in class org.efs.io.EfsFile
- Section
- org.efs.activator - package org.efs.activator
-
Provides ability to transition efs agents between stopped, stand by, and active states according to user-defined workflow.
- org.efs.activator.config - package org.efs.activator.config
-
This package provides typesafe configuration bean classes which may be loaded from a file as follows:
- org.efs.activator.event - package org.efs.activator.event
- org.efs.bus - package org.efs.bus
-
EfsEventBusprovides a loosely-coupled interface betweenefs agents. - org.efs.dispatcher - package org.efs.dispatcher
- org.efs.dispatcher.config - package org.efs.dispatcher.config
-
This package provides typesafe configuration bean classes which may be loaded from a file as follows:
- org.efs.event - package org.efs.event
-
Provides core event framework infrastructure for the efs system.
- org.efs.event.type - package org.efs.event.type
-
Contains
EfsEventLayoutclass which provides a reflective definition of anIEfsEventclass. - org.efs.io - package org.efs.io
-
Event File System I/O Package
- org.efs.logging - package org.efs.logging
-
This package extends slf4j package with an asynchronous logger.
- org.efs.timer - package org.efs.timer
-
efs timer package provides
EfsScheduledExecutorwhich encapsulates aScheduledExecutorService. - org.efs.util - package org.efs.util
P
- Package-Private Implementation Details - Search tag in class org.efs.io.EfsFileConnection.Retrieval
- Section
- PARK_TIME_KEY - Static variable in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Key "parkTime" contains park time for spin+park thread type.
- PARK_TIME_KEY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Key "parkTime" sets park time for
spin+parkdispatcher thread. - parkTime() - Method in class org.efs.dispatcher.EfsDispatcherThread
-
Returns nanosecond park time for spin+park thread type.
- parkTime(Duration) - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Sets
spin+parkpark time limit. - PAST - Enum constant in enum class org.efs.io.EfsIntervalEndpoint.IntervalLocation
-
Interval endpoint is in the past.
- Pattern 1: Basic Concrete Topic Publishing and Subscription - Search tag in class org.efs.bus.EfsEventBus
- Section
- Pattern 2: Inbox (Conflated) Subscription - Search tag in class org.efs.bus.EfsEventBus
- Section
- Pattern 3: Wildcard Topic Subscriptions - Search tag in class org.efs.bus.EfsEventBus
- Section
- Pattern 4: Wildcard Topic Advertisement - Search tag in class org.efs.bus.EfsEventBus
- Section
- Pattern 5: Event Router Subscription - Search tag in class org.efs.bus.EfsEventBus
- Section
- Pattern 6: Managing Multiple Topics - Search tag in class org.efs.bus.EfsEventBus
- Section
- peek() - Method in class org.efs.event.ConflationEvent
-
Returns latest event contained in this conflation event without removing this latest event.
- performanceStats() - Method in class org.efs.dispatcher.EfsDispatcherThread
-
Returns this dispatcher thread's performance statistics.
- performanceStats(String) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Returns named dispatcher's performance statistics snapshot.
- poll() - Method in class org.efs.event.ConflationEvent
-
Returns latest event contained in this conflation event.
- previousSubscribers() - Method in class org.efs.bus.EfsSubscribeStatus
-
Returns previous subscriber count.
- previousSubscribers(int) - Method in class org.efs.bus.EfsSubscribeStatus.Builder
-
Sets previous subscriber count to given value.
- priority() - Method in class org.efs.dispatcher.EfsDispatcher
-
Returns priority of dispatcher threads.
- priority(int) - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Sets the thread priority.
- PRIORITY_KEY - Static variable in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Key "priority" contains underlying dispatcher thread priority.
- PRIORITY_KEY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Key "priority" sets dispatcher thread priority.
- publish(E) - Method in class org.efs.bus.EfsEventBus.Advertisement
-
Publishes given event to all extant subscribers.
- PUBLISH_STATUS_DOWN - Static variable in class org.efs.bus.EfsEventBus
-
Attempting to publish an event while publish status is set to
falseresults in anIllegalStateExceptionwith the message "publish status is down". - PUBLISH_TIMESTAMP_ATTRIBUTE - Static variable in class org.efs.io.EfsFile
-
EfsRow.getPublishTimestamp()attribute named "publishTimestamp". - Publishing Events - Search tag in package org.efs.bus
- Section
- publishStatus(boolean) - Method in class org.efs.bus.EfsEventBus.Advertisement
-
Sets publisher's active publishing status to given value where
truemeans publisher can post event andfalsemeans publisher cannot do so.
Q
- Querying - Search tag in class org.efs.io.EfsFile
- Section
R
- RADIX_TREE_INDEX - Enum constant in enum class org.efs.io.CQIndexType
-
Create a
RadixTreeIndexfor attribute. - READ_ONLY - Enum constant in enum class org.efs.io.EfsFile.AccessMode
-
Used to access efs event file in read-only mode.
- READ_ONLY_ACCESS - Static variable in class org.efs.io.EfsFileConnection
-
If agent attempts to add an event with read-only connect results in a
IllegalStateExceptionwith message "{} opened with read-only access, cannot add events". - READ_WRITE - Enum constant in enum class org.efs.io.EfsFile.AccessMode
-
Used to access efs event file in both read and write modes.
- register(IEfsAgent, String) - Static method in class org.efs.dispatcher.EfsDispatcher
-
Registers agent with named dispatcher.
- registerListener(Consumer<ActivatorEvent>, IEfsAgent) - Method in class org.efs.activator.EfsActivator
-
Registers agent for listening to activator state changes.
- retrieval() - Method in class org.efs.io.RetrievalCompleteEvent
-
Returns now completed retrieval request; returns
nullif this is a tag retrieval request. - RETRIEVAL_COMPLETED - Enum constant in enum class org.efs.io.RetrievalCompleteEvent.CompletionType
-
Retrieval successfully reached its termination
endpoint. - RetrievalCompleteEvent<E> - Class in org.efs.io
-
EfsFileposts this event to target agent signifying a retrieval reached its termination. - RetrievalCompleteEvent.CompletionType - Enum Class in org.efs.io
-
A retrieval request ends either due to it reaching its ending point, user cancellation,
EfsFileConnectionclosing, orEfsFileclosing. - retrieve(int, Consumer<EfsRow<E>>, Consumer<RetrievalCompleteEvent<E>>) - Method in class org.efs.io.EfsFileConnection
-
TODO
- retrieve(EfsInterval, Query<EfsRow<E>>, Consumer<EfsRow<E>>, Consumer<RetrievalCompleteEvent<E>>) - Method in class org.efs.io.EfsFileConnection
-
Initiates a retrieval of events from the underlying
EfsFilematching the specified interval and CQEngine query, with optional subscription to future matching events. - REVERSED_RADIX_INDEX - Enum constant in enum class org.efs.io.CQIndexType
-
Create a
ReversedRadixTreeIndexfor attribute. - routeTo(E) - Method in interface org.efs.bus.IEventRouter
-
Returns targeted
IEfsAgentandConsumer<E>callback to which given event should be dispatched. - ROW_INDEX_ATTRIBUTE - Static variable in class org.efs.io.EfsFile
-
EfsRow.getRowIndex()attribute named "rowIndex". - rowCount() - Method in class org.efs.io.EfsFile
-
Returns approximate number of rows in efs file.
- run() - Method in class org.efs.dispatcher.EfsDispatcherThread
-
A dispatcher thread continues processing ready efs clients until the JVM exits.
- RUN_QUEUE_CAPACITY_KEY - Static variable in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Key "runQueueCapacity" contains dispatcher run queue capacity.
- RUN_QUEUE_CAPACITY_KEY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Key "runQueueCapacity" sets run queue maximum size.
- runQueueCapacity(int) - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Sets efs dispatcher agent queue capacity.
S
- Sample Event Bus Code - Search tag in package org.efs.bus
- Section
- schedule(String, Object, Consumer<EfsTimerEvent>, IEfsAgent, Duration) - Method in class org.efs.timer.EfsScheduledExecutor
-
Submits a single-shot timer which expires after the given delay.
- scheduleAtFixedRate(String, Object, Consumer<EfsTimerEvent>, IEfsAgent, Duration, Duration) - Method in class org.efs.timer.EfsScheduledExecutor
-
Submits a periodic action that becomes enabled first after initial delay, and subsequently with the given period; that is, executions will commence after initialDelay, then initialDelay + period, then initialDelay + 2 * period, and so on.
- scheduleWithFixedDelay(String, Object, Consumer<EfsTimerEvent>, IEfsAgent, Duration, Duration) - Method in class org.efs.timer.EfsScheduledExecutor
-
Submits a periodic task which expires for the first time after the initial delay and then repeatedly with the given delay between the termination of the previous expiration and the commencement of the next.
- Scheduling Timers - Search tag in package org.efs.timer
- Section
- service() - Method in class org.efs.timer.EfsScheduledExecutor
-
Returns encapsulated Java scheduled executor service.
- set(EfsActivatorConfig) - Method in class org.efs.activator.EfsActivator.Builder
-
Sets activator properties according to given activator configuration.
- set(WorkflowConfig) - Method in class org.efs.activator.Workflow.Builder
-
Sets workflow properties according to given workflow configuration.
- set(WorkflowStageConfig) - Method in class org.efs.activator.WorkflowStage.Builder
-
Sets stage properties according to given workflow stage configuration.
- set(WorkflowStepConfig) - Method in class org.efs.activator.WorkflowStep.Builder
-
Fills in builder with given workflow step configuration.
- set(EfsDispatcherConfig) - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Configures efs dispatcher as per given configuration.
- setAffinity(ThreadAffinityConfig) - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Sets core affinity applied to underlying threads.
- setAffinityType(ThreadAffinityConfig.AffinityType) - Method in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Sets affinity type to the given value.
- setAgent(String) - Method in class org.efs.activator.config.WorkflowStepConfig
-
Sets agent name.
- setAllowedTransitionTime(Duration) - Method in class org.efs.activator.config.WorkflowStepConfig
-
Sets time allowed to agent to complete transition from begin to end state.
- setBeginState(EfsAgentState) - Method in class org.efs.activator.config.WorkflowStepConfig
-
Sets agent begin state.
- setBindFlag(boolean) - Method in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Sets flag for binding thread to affinity lock.
- setCpuId(int) - Method in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Sets CPU_ID identifier used by
ThreadAffinityConfig.AffinityType.CPU_IDaffinity type. - setDispatcherName(String) - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Sets unique dispatcher name.
- setDispatchers(List<EfsDispatcherConfig>) - Method in class org.efs.dispatcher.config.EfsDispatchersConfig
-
Sets efs dispatchers list.
- setEndState(EfsAgentState) - Method in class org.efs.activator.config.WorkflowStepConfig
-
Sets agent end state.
- setEventQueueCapacity(int) - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Sets efs agent event queue capacity.
- setLastMinusOffset(int) - Method in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Sets positive integer offset used by
ThreadAffinityConfig.AffinityType.CPU_LAST_MINUSaffinity type. - setMaxEvents(int) - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Sets maximum number of events an efs agent associated with this dispatcher may process when dispatched.
- setName(String) - Method in class org.efs.activator.config.WorkflowConfig
-
Sets unique workflow name.
- setNumThreads(int) - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Sets number of underlying dispatcher threads.
- setParkTime(Duration) - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Sets park time for spin+park underlying dispatcher threads.
- setPriority(int) - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Sets priority for all underlying dispatcher threads.
- setRunQueueCapacity(int) - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Set efs dispatcher agent queue capacity.
- setSpinLimit(long) - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Sets spin limit for spin+park and spin+yield underlying threads.
- setStages(List<WorkflowStageConfig>) - Method in class org.efs.activator.config.WorkflowConfig
-
Stages defining this workflow.
- setSteps(List<WorkflowStepConfig>) - Method in class org.efs.activator.config.WorkflowStageConfig
-
Sets workflow stage steps to given list.
- setStrategies(List<AffinityStrategies>) - Method in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Sets CPU selection strategies used by
ThreadAffinityConfig.AffinityType.CPU_STRATEGIESaffinity type. - setSystemClock(Clock) - Static method in class org.efs.io.EfsFile
-
Sets system clock used to obtain
Instantvalues, returning replaced system clock. - setter() - Method in class org.efs.event.type.EfsEventLayout.EfsEventField
-
Returns field setter method handle.
- setThreadType(ThreadType) - Method in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Sets dispatcher underlying thread type.
- setWholeCoreFlag(boolean) - Method in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Sets flag reserving the entire core and not allowing hyper-threading on that core.
- setWorkflows(List<WorkflowConfig>) - Method in class org.efs.activator.config.EfsActivatorConfig
-
Sets activator workflows.
- setWorkflowStage(int, int) - Method in class org.efs.activator.EfsActivator
-
Sets workflow position to given stage and step index.
- Similarities - Search tag in package org.efs.dispatcher
- Section
- SIMPLE - Enum constant in enum class org.efs.io.CQAttributeType
-
Create a
SimpleAttributefor event field. - SIMPLE_NULLABLE - Enum constant in enum class org.efs.io.CQAttributeType
-
Create a
SimpleNullableAttributefor event field. - SPECIAL - Enum constant in enum class org.efs.dispatcher.EfsDispatcher.DispatcherType
-
Means that a user-defined dispatcher is being used.
- SPIN_LIMIT_KEY - Static variable in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Key "spinLimit" contains spin limit for spin+park and spin+yield thread types.
- SPIN_LIMIT_KEY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Key "spinLimit" sets thread spin limit for
spin+parkorThreadType.SPINYIELDthread types. - spinLimit() - Method in class org.efs.dispatcher.EfsDispatcherThread
-
Returns spin limit for spin+park/spin+yield thread type.
- spinLimit(long) - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Sets
ThreadType.SPINPARKorThreadType.SPINYIELDspin limit. - SPINNING - Enum constant in enum class org.efs.dispatcher.config.ThreadType
-
The thread repeatedly checks if the event has arrived using a non-blocking call without pausing in between checks.
- SPINPARK - Enum constant in enum class org.efs.dispatcher.config.ThreadType
-
This thread repeatedly checks for the event using a non-blocking call but only for a fixed number of times (the spin limit).
- SPINYIELD - Enum constant in enum class org.efs.dispatcher.config.ThreadType
-
This thread repeatedly check for the event using a non-blocking call but only for a fixed number of times (the spin limit).
- stageCount() - Method in class org.efs.activator.Workflow
-
Returns number of stages within this workflow.
- Staged Event-Driven Architecture (SEDA) - Search tag in package org.efs.dispatcher
- Section
- stageIndex() - Method in class org.efs.activator.WorkflowStage
-
Returns this stage's index within the workflow.
- stageIndex(int) - Method in class org.efs.activator.WorkflowStage.Builder
-
Sets stage index within parent workflow.
- stages(List<WorkflowStage>) - Method in class org.efs.activator.Workflow.Builder
-
Sets stages defining workflow.
- STAGES_KEY - Static variable in class org.efs.activator.config.WorkflowConfig
-
Key "stages" contains workflow stages.
- STAND_ALONE_STEP - Static variable in class org.efs.activator.EfsActivator
-
Stand-alone executed steps are named "standalone-step".
- STAND_BY - Enum constant in enum class org.efs.activator.EfsAgentState
-
Agent is successfully started but not yet active.
- START_FAILED - Enum constant in enum class org.efs.dispatcher.EfsDispatcher.DispatcherState
-
Dispatcher failed to start and may not be re-started.
- STARTED - Enum constant in enum class org.efs.dispatcher.EfsDispatcher.DispatcherState
-
Dispatcher is successfully started and its subordinate threads are running, and may be stopped.
- STARTING - Enum constant in enum class org.efs.activator.EfsAgentState
-
Agent is in this temporary state while transitioning from
EfsAgentState.STOPPEDtoEfsAgentState.STAND_BY. - startTime() - Method in class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadStats
-
Returns dispatcher thread start time.
- startTime() - Method in class org.efs.util.LatencyTracker
-
Returns test run start time.
- startTime(Instant) - Method in class org.efs.util.LatencyTracker
-
Sets test run start time.
- startup() - Method in interface org.efs.activator.IEfsActivateAgent
- stats() - Method in class org.efs.dispatcher.EfsDispatcher.AgentStats
-
Returns copy of the collected agent statistics collected by all subordinate dispatcher threads.
- stats() - Method in class org.efs.dispatcher.EfsDispatcherThread.AgentStats
-
Returns copy of the collected agent statistics containing only those data points collected so far.
- statsName() - Method in class org.efs.dispatcher.EfsDispatcher.AgentStats
-
Returns agent statistic's name.
- statsName() - Method in class org.efs.dispatcher.EfsDispatcherThread.AgentStats
-
Returns agent statistic's name.
- Status and Information - Search tag in class org.efs.io.EfsFileConnection.Retrieval
- Section
- stepCount() - Method in class org.efs.activator.WorkflowStage
-
Returns number of steps in this workflow stage.
- stepName(String) - Method in class org.efs.activator.event.ActivatorEvent.Builder
-
Sets workflow step name.
- steps(List<WorkflowStep>) - Method in class org.efs.activator.WorkflowStage.Builder
-
Sets steps defining workflow stage.
- STEPS_KEY - Static variable in class org.efs.activator.config.WorkflowStageConfig
-
Key "steps" contains workflow steps list.
- stepState(ActivatorEvent.StepState) - Method in class org.efs.activator.event.ActivatorEvent.Builder
-
Sets workflow step state.
- stop() - Method in interface org.efs.activator.IEfsActivateAgent
-
This method transitions an agent from
EfsAgentState.STAND_BYtoEfsAgentState.STOPPED. - STOPPED - Enum constant in enum class org.efs.activator.EfsAgentState
-
Agent is fully stopped.
- STOPPED - Enum constant in enum class org.efs.dispatcher.EfsDispatcher.DispatcherState
-
Dispatcher is stopped, has no subordinate threads, and may be started.
- STOPPING - Enum constant in enum class org.efs.activator.EfsAgentState
-
Agent is in this temporary state while transitioning from
EfsAgentState.STAND_BYtoEfsAgentState.STOPPED. - stopTime() - Method in class org.efs.util.LatencyTracker
-
Returns test run stop time.
- stopTime(Instant) - Method in class org.efs.util.LatencyTracker
-
Sets test run stop time.
- STRATEGIES_KEY - Static variable in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Key "cpuStrategies" contains CPU selection strategies array used when
ThreadAffinityConfig.AFFINITY_TYPE_KEYis set toThreadAffinityConfig.AffinityType.CPU_STRATEGIES. - subscribe(EfsTopicKey<E>, Consumer<EfsPublishStatus<E>>, Consumer<E>, IEfsAgent) - Method in class org.efs.bus.EfsEventBus
-
Subscribes to a concrete event class and topic, returning a closeable subscription instance.
- subscribeAll(Class<E>, String, Consumer<EfsPublishStatus<E>>, Consumer<E>, Consumer<EfsTopicKey<E>>, IEfsAgent) - Method in class org.efs.bus.EfsEventBus
-
Subscribes to an event class with a wildcard topic pattern, returning a closeable wildcard subscription instance.
- subscribeAllInbox(Class<E>, String, Consumer<EfsPublishStatus<E>>, Consumer<E>, Consumer<EfsTopicKey<E>>, IEfsAgent) - Method in class org.efs.bus.EfsEventBus
-
Subscribes to an event class with a wildcard topic pattern, returns a closeable wildcard subscription instance.
- subscribeInbox(EfsTopicKey<E>, Consumer<EfsPublishStatus<E>>, Consumer<E>, IEfsAgent) - Method in class org.efs.bus.EfsEventBus
-
Subscribes to a concrete event class and topic, returning a closeable subscription instance.
- subscribeRouter(EfsTopicKey<E>, Consumer<EfsPublishStatus<E>>, IEventRouter<E>, IEfsAgent) - Method in class org.efs.bus.EfsEventBus
-
Subscribes to a concrete event class and topic using a dynamic event router, returning a closeable subscription instance.
- Subscribing to Events - Search tag in package org.efs.bus
- Section
- Subscription(EfsEventBus.TopicFeed<E>, IEfsAgent) - Constructor for class org.efs.bus.EfsEventBus.Subscription
-
Creates subscription for given topic feed and subscribing agent.
- subscriptionCreationCount() - Method in class org.efs.bus.EfsEventBus
-
Returns current number of subscriptions successfully created on this event bus.
- subscriptionKeys() - Method in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Returns an immutable list containing the concrete topic keys to which this wildcard subscription is subscribed.
- Subscription Router - Search tag in package org.efs.bus
- Section
- subscriptionTopics() - Method in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Returns an immutable list containing the concrete topics to which this wildcard subscription is subscribed.
- SUFFIX_RADIX_INDEX - Enum constant in enum class org.efs.io.CQIndexType
-
Create a
SuffixTreeIndexfor attribute. - Summary - Search tag in package org.efs.dispatcher
- Section
T
- TAGS_ATTRIBUTE - Static variable in class org.efs.io.EfsFile
-
EfsRow.getTags()attribute named "tags". - TAGS_CONTAINS_NULL - Static variable in class org.efs.io.EfsFileConnection
-
An event tags set containing a
nullvalue results in anIllegalArgumentExceptionwith message "tags contains a null value". - terminateWorkflow() - Method in class org.efs.activator.EfsActivator
-
Terminates an in-progress workflow.
- textName() - Method in enum class org.efs.dispatcher.config.ThreadType
-
Returns the thread type text name.
- THREAD_TYPE_KEY - Static variable in class org.efs.dispatcher.config.EfsDispatcherConfig
-
Key "threadType" contains dispatcher
thread type. - THREAD_TYPE_KEY - Static variable in class org.efs.dispatcher.EfsDispatcher
-
Key "threadType" sets dispatcher thread type.
- threadAffinity(ThreadAffinityConfig) - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Sets optional thread affinity to the given configuration list.
- ThreadAffinity - Class in org.efs.dispatcher.config
-
Provides interface to OpenHFT Thread Affinity Library based on a given
ThreadAffinityConfig. - ThreadAffinityConfig - Class in org.efs.dispatcher.config
-
A typesafe configuration bean class containing necessary information needed to create an affinity between a thread and a core using OpenHFT Thread Affinity Library.
- ThreadAffinityConfig() - Constructor for class org.efs.dispatcher.config.ThreadAffinityConfig
-
Default constructor sets fields to invalid values.
- ThreadAffinityConfig.AffinityType - Enum Class in org.efs.dispatcher.config
-
These affinity types map to a specific
AffinityLock staticmethod used to acquire an affinity lock. - threadCount() - Method in class org.efs.dispatcher.EfsDispatcher
-
Returns dispatcher's subordinate thread count.
- threadCount() - Method in interface org.efs.dispatcher.IEfsDispatcher
-
Returns dispatcher's subordinate thread count.
- Threading and Dispatch - Search tag in class org.efs.io.EfsFileConnection
- Section
- Threading and postRow - Search tag in class org.efs.io.EfsFile
- Section
- Threading Model - Search tag in class org.efs.io.EfsFileConnection.Retrieval
- Section
- threadName() - Method in class org.efs.dispatcher.EfsDispatcherThread.AgentStats
-
Returns dispatcher thread's name.
- threadName() - Method in class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadStats
-
Returns dispatcher thread name.
- threadName() - Method in exception class org.efs.dispatcher.ThreadStartException
-
Returns failed thread's name.
- ThreadStartException - Exception Class in org.efs.dispatcher
-
Exception thrown when a
dispatcher threadfails to start. - ThreadStartException(String, String) - Constructor for exception class org.efs.dispatcher.ThreadStartException
-
Creates new
ThreadStartExceptioninstance without detail message. - ThreadStartException(String, String, String) - Constructor for exception class org.efs.dispatcher.ThreadStartException
-
Creates new
ThreadStartExceptioninstance with a detail message. - ThreadStartException(String, String, String, Throwable) - Constructor for exception class org.efs.dispatcher.ThreadStartException
-
Create new
ThreadStartExceptioninstance with detail message and cause. - threadState() - Method in class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadStats
-
Returns dispatcher thread current state.
- threadType() - Method in class org.efs.dispatcher.EfsDispatcher.DispatcherStats
-
Returns underlying dispatcher thread type.
- threadType() - Method in class org.efs.dispatcher.EfsDispatcher
-
Returns underlying thread type.
- threadType() - Method in class org.efs.dispatcher.EfsDispatcherThread
-
Returns dispatcher thread type.
- threadType(ThreadType) - Method in class org.efs.dispatcher.EfsDispatcher.Builder
-
Sets dispatcher thread type.
- ThreadType - Enum Class in org.efs.dispatcher.config
-
Lists thread types available to efs users when configuring efs dispatchers.
- time() - Method in class org.efs.io.EfsTimeEndpoint
-
Returns endpoint time.
- time(Instant, EfsIntervalEndpoint.Clusivity) - Method in class org.efs.io.EfsTimeEndpoint.Builder
-
Sets interval time and clusivity.
- TIME_NULL - Static variable in class org.efs.io.EfsTimeEndpoint.Builder
-
When attempting to set endpoint time to
null, thenNullPointerExceptioncontains message "time is null". - TIME_OFFSET - Enum constant in enum class org.efs.io.EfsIntervalEndpoint.EndpointType
-
A time offset endpoint is relative to the feed's current time.
- TIME_OFFSET_NULL - Static variable in class org.efs.io.EfsDurationEndpoint.Builder
-
When attempting to set time offset to
null, thenNullPointerExceptioncontains message "offset is null". - timeOffset() - Method in class org.efs.io.EfsDurationEndpoint
-
Returns time offset.
- timeOffset(Duration, EfsIntervalEndpoint.Clusivity) - Method in class org.efs.io.EfsDurationEndpoint.Builder
-
Sets time offset to given values and clusivity.
- timerName() - Method in class org.efs.timer.EfsTimerEvent
-
Returns expired timer's name as configured by agent.
- topic() - Method in class org.efs.event.EfsTopicKey
-
Returns feed key's topic.
- TOPIC_COMPLEXITY - Static variable in class org.efs.bus.EfsEventBus
-
An overly complex wildcard topic results in an
IllegalArgumentExceptionwith message "regexTopic is too complex". - topicKey() - Method in class org.efs.bus.EfsEventBus.Advertisement
-
Returns event class+topic key for this feed.
- topicKey() - Method in class org.efs.bus.EfsEventBus.Subscription
-
Returns event class+topic key for this feed.
- topicKey() - Method in class org.efs.bus.EfsPublishStatus
-
Returns topic key to which this publish status event applies.
- topicKey() - Method in class org.efs.bus.EfsSubscribeStatus
-
Returns topic key to which this subscribe status event applies.
- topicKey() - Method in class org.efs.io.EfsFile
-
Returns file topic key.
- topicKey(EfsTopicKey<E>) - Method in class org.efs.bus.EfsPublishStatus.Builder
-
Sets topic key to given value.
- topicKey(EfsTopicKey<E>) - Method in class org.efs.bus.EfsSubscribeStatus.Builder
-
Sets topic key to given value.
- toString() - Method in class org.efs.activator.config.EfsActivatorConfig
- toString() - Method in class org.efs.activator.config.WorkflowConfig
- toString() - Method in class org.efs.activator.config.WorkflowStageConfig
- toString() - Method in class org.efs.activator.config.WorkflowStepConfig
- toString() - Method in class org.efs.activator.event.ActivatorEvent
-
Returns a single text line containing agent name, initial state, and final state.
- toString() - Method in class org.efs.activator.Workflow
-
Returns text containing workflow name and its stages.
- toString() - Method in class org.efs.activator.WorkflowStage
-
Returns text containing workflow stage index and subordinate steps.
- toString() - Method in class org.efs.activator.WorkflowStep
-
Returns text containing agent name, transition begin and end states, and allowed transition time.
- toString() - Method in class org.efs.bus.EfsPublishStatus
- toString() - Method in class org.efs.bus.EfsSubscribeStatus
- toString() - Method in enum class org.efs.dispatcher.config.ThreadType
- toString() - Method in class org.efs.dispatcher.EfsDispatcher.AgentStats
- toString() - Method in class org.efs.dispatcher.EfsDispatcher.DispatcherStats
-
Returns dispatcher stats snapshot as text.
- toString() - Method in class org.efs.dispatcher.EfsDispatcher
-
Returns text containing efs dispatcher settings.
- toString() - Method in class org.efs.dispatcher.EfsDispatcherThread.AgentStats
- toString() - Method in class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadStats
-
Returns dispatcher thread information as text.
- toString() - Method in class org.efs.dispatcher.EfsDispatcherThread
- toString() - Method in class org.efs.event.EfsTopicKey
-
Returns efs event key textual representation.
- toString() - Method in class org.efs.event.type.EfsEventLayout.EfsEventField
- toString() - Method in class org.efs.event.type.EfsEventLayout
-
Returns textual representation of this efs event layout.
- toString() - Method in class org.efs.io.EfsDurationEndpoint
-
Returns time offset duration as text.
- toString() - Method in class org.efs.io.EfsFileConnection.Retrieval
- toString() - Method in class org.efs.io.EfsIndexEndpoint
-
Returns index offset only as text.
- toString() - Method in class org.efs.io.EfsInterval
-
Returns textual representation of end point times and clusivities.
- toString() - Method in enum class org.efs.io.EfsIntervalEndpoint.IntervalLocation
- toString() - Method in class org.efs.io.EfsRow
-
Returns text containing row index, publish timestamp, and event.
- toString() - Method in class org.efs.io.EfsTimeEndpoint
-
Returns time as text.
- toString() - Method in class org.efs.timer.EfsTimerEvent
-
Returns textual representation of timer event.
- toString() - Method in class org.efs.util.LatencyTracker.Bucket
- toString() - Method in class org.efs.util.LatencyTracker
-
Returns text reporting latency results based on collected deltas.
- toString(EfsIntervalEndpoint.IntervalSide) - Method in class org.efs.io.EfsIntervalEndpoint
-
Outputs this endpoint in format appropriate to which side of the interval the endpoint is on.
- totalAgentRunCount() - Method in class org.efs.dispatcher.EfsDispatcher.DispatcherStats
-
Returns total agent run count across all dispatcher threads.
- totalRunTime() - Method in class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadStats
-
Returns total dispatcher thread run time from its start time until now.
- trace(String) - Method in class org.efs.logging.AsyncLogger
- trace(String, Object) - Method in class org.efs.logging.AsyncLogger
- trace(String, Object...) - Method in class org.efs.logging.AsyncLogger
- trace(String, Object, Object) - Method in class org.efs.logging.AsyncLogger
- trace(String, Throwable) - Method in class org.efs.logging.AsyncLogger
- trace(Marker, String) - Method in class org.efs.logging.AsyncLogger
- trace(Marker, String, Object) - Method in class org.efs.logging.AsyncLogger
- trace(Marker, String, Object...) - Method in class org.efs.logging.AsyncLogger
- trace(Marker, String, Object, Object) - Method in class org.efs.logging.AsyncLogger
- trace(Marker, String, Throwable) - Method in class org.efs.logging.AsyncLogger
U
- Under the covers - Search tag in package org.efs.dispatcher
- Section
- UNIQUE_INDEX - Enum constant in enum class org.efs.io.CQIndexType
-
Create a
SuffixTreeIndexfor attribute. - unit() - Method in class org.efs.dispatcher.EfsDispatcher.AgentStats
-
Returns unit name for stored data.
- unit() - Method in class org.efs.dispatcher.EfsDispatcherThread.AgentStats
-
Returns unit name for stored data.
- UNKNOWN_DISPATCHER - Static variable in class org.efs.io.EfsFile
-
A dispatcher name which does not reference a known dispatcher results in an
IllegalArgumentExceptionwith message "\"%s\" is an unknown dispatcher". - UNKNOWN_FIELD - Static variable in class org.efs.io.EfsFile
-
A field name which is not in the event layout results in an
IllegalArgumentExceptionwith message "\"%s\" is an unknown event field". - UNREGISTERED_AGENT - Static variable in class org.efs.activator.EfsActivator
-
IllegalStateExceptionmessage for an agent not registered with a dispatcher is "agent not registered with dispatcher". - UNREGISTERED_AGENT - Static variable in class org.efs.bus.EfsEventBus
-
A publisher or subscriber not registered with a dispatcher results in an
IllegalStateExceptionwith message "%s is not registered with a dispatcher" containing agent name. - UNREGISTERED_AGENT - Static variable in class org.efs.dispatcher.EfsDispatcher
-
An agent not registered with a dispatcher results in an
IllegalStateExceptionwith message "%s is not registered with a dispatcher" containing agent name. - UNREGISTERED_AGENT - Static variable in class org.efs.io.EfsFile
-
An agent which is not registered with a dispatcher results in an
IllegalStateExceptionwith message "\"%s\" is not registered with a dispatcher". - UNREGISTERED_AGENT - Static variable in class org.efs.timer.EfsScheduledExecutor
-
Unregistered agent message is " is not registered with a dispatcher".
- Usage Example - Search tag in class org.efs.io.EfsFileConnection
- Section
- Usage Example - Search tag in class org.efs.timer.EfsScheduledExecutor
- Section
- Usage Example - Search tag in package org.efs.io
- Section
- Usage Pattern - Search tag in package org.efs.event
- Section
- Use Case 1: Tracking Growing Subscriber Interest - Search tag in class org.efs.bus.EfsSubscribeStatus.Builder
- Section
- Use Case 2: Event Bus Publishing Flow - Search tag in class org.efs.bus.EfsSubscribeStatus.Builder
- Section
- Use Case 3: Method Chaining Pattern - Search tag in class org.efs.bus.EfsSubscribeStatus.Builder
- Section
- USER_CANCEL - Enum constant in enum class org.efs.io.RetrievalCompleteEvent.CompletionType
-
Retrieval terminated due to user cancellation.
V
- validate(Validator) - Method in class org.efs.io.EfsDurationEndpoint.Builder
-
Verifies that time offset is set.
- validate(Validator) - Method in class org.efs.io.EfsIndexEndpoint.Builder
-
Verifies that index offset is set.
- validate(Validator) - Method in class org.efs.io.EfsIntervalEndpoint.EndpointBuilder
-
Verifies that clusivity and location are set.
- validate(Validator) - Method in class org.efs.io.EfsTimeEndpoint.Builder
-
Verifies that time is set.
- validate(ThreadAffinityConfig) - Static method in class org.efs.dispatcher.config.ThreadAffinity
-
Validates affinity configuration.
- valueOf(String) - Static method in enum class org.efs.activator.EfsAgentState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.activator.event.ActivatorEvent.StepState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.activator.WorkflowDirection
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.dispatcher.config.ThreadAffinityConfig.AffinityType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.dispatcher.config.ThreadType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.dispatcher.EfsDispatcher.DispatcherState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.dispatcher.EfsDispatcher.DispatcherType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.io.CQAttributeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.io.CQIndexType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.io.EfsFile.AccessMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.io.EfsIntervalEndpoint.Clusivity
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.io.EfsIntervalEndpoint.EndpointType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.io.EfsIntervalEndpoint.IntervalLocation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.io.EfsIntervalEndpoint.IntervalSide
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.efs.io.RetrievalCompleteEvent.CompletionType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.efs.activator.EfsAgentState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.activator.event.ActivatorEvent.StepState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.activator.WorkflowDirection
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.dispatcher.config.ThreadAffinityConfig.AffinityType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.dispatcher.config.ThreadType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.dispatcher.EfsDispatcher.DispatcherState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.dispatcher.EfsDispatcher.DispatcherType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.dispatcher.EfsDispatcherThread.DispatcherThreadState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.io.CQAttributeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.io.CQIndexType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.io.EfsFile.AccessMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.io.EfsIntervalEndpoint.Clusivity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.io.EfsIntervalEndpoint.EndpointType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.io.EfsIntervalEndpoint.IntervalLocation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.io.EfsIntervalEndpoint.IntervalSide
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.efs.io.RetrievalCompleteEvent.CompletionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- waitUntil(Duration) - Static method in class org.efs.util.DelayedExecution
-
Waits on the current thread until specified delay is reached.
- warn(String) - Method in class org.efs.logging.AsyncLogger
- warn(String, Object) - Method in class org.efs.logging.AsyncLogger
- warn(String, Object...) - Method in class org.efs.logging.AsyncLogger
- warn(String, Object, Object) - Method in class org.efs.logging.AsyncLogger
- warn(String, Throwable) - Method in class org.efs.logging.AsyncLogger
- warn(Marker, String) - Method in class org.efs.logging.AsyncLogger
- warn(Marker, String, Object) - Method in class org.efs.logging.AsyncLogger
- warn(Marker, String, Object...) - Method in class org.efs.logging.AsyncLogger
- warn(Marker, String, Object, Object) - Method in class org.efs.logging.AsyncLogger
- warn(Marker, String, Throwable) - Method in class org.efs.logging.AsyncLogger
- WHOLE_CORE_KEY - Static variable in class org.efs.dispatcher.config.ThreadAffinityConfig
-
Key "wholeCore" contains reserve-whole-core flag.
- Wildcard Advertising & Subscribing - Search tag in package org.efs.bus
- Section
- wildcardMatchCount() - Method in class org.efs.bus.EfsEventBus
-
Returns current number of topics successfully matched against all advertisement/subscription wildcards.
- wildcardTopic() - Method in class org.efs.bus.EfsEventBus.WildcardAdvertisement
-
Returns access point wildcard topic.
- wildcardTopic() - Method in class org.efs.bus.EfsEventBus.WildcardSubscription
-
Returns access point wildcard topic.
- workflow() - Method in class org.efs.activator.EfsActivator
-
Returns current, in-progress workflow name.
- Workflow - Class in org.efs.activator
-
A workflow contains one or more
workflow stageswhich takeagent(s) from a start state to an end state. - Workflow.Builder - Class in org.efs.activator
-
Provides ability to programmatically define a
Workflowinstance. - WorkflowConfig - Class in org.efs.activator.config
-
An activator work flow takes one or more agents from a given start state to a target end state.
- WorkflowConfig() - Constructor for class org.efs.activator.config.WorkflowConfig
-
Default constructor required for a typesafe bean class.
- WorkflowDirection - Enum Class in org.efs.activator
-
Workflow either advances agents from a lower to a higher state or descends agents from a higher to a lower state.
- workflows(List<Workflow>) - Method in class org.efs.activator.EfsActivator.Builder
-
Sets activator workflows.
- WORKFLOWS_KEY - Static variable in class org.efs.activator.config.EfsActivatorConfig
-
Key "workflows" contains activator workflow definitions.
- WorkflowStage - Class in org.efs.activator
-
A workflow stage contains one or more
stepswhich take agent(s) from a start state to end state. - WorkflowStage.Builder - Class in org.efs.activator
-
Provides ability to programmatically define a
WorkflowStageinstance. - WorkflowStageConfig - Class in org.efs.activator.config
-
A typesafe bean configuration used to define steps within a workflow stage.
- WorkflowStageConfig() - Constructor for class org.efs.activator.config.WorkflowStageConfig
-
Default constructor required for a typesafe bean class.
- WorkflowStep - Class in org.efs.activator
-
A workflow step takes a single
IEfsActivateAgentfrom an expected begin state to an adjacent next state. - WorkflowStep.Builder - Class in org.efs.activator
-
Provides ability to programmatically define a
WorkflowStepinstance. - WorkflowStepConfig - Class in org.efs.activator.config
-
A typesafe bean configuration used to define a workflow step within a workflow stage.
- WorkflowStepConfig() - Constructor for class org.efs.activator.config.WorkflowStepConfig
-
Default constructor required for a typesafe bean class.
- WRITE_ONLY - Enum constant in enum class org.efs.io.EfsFile.AccessMode
-
Used to access efs event file in write-only mode.
- WRITE_ONLY_ACCESS - Static variable in class org.efs.io.EfsFileConnection
-
If agent attempts to retrieve events with write-only connect results in a
IllegalStateExceptionwith message "{} opened with write-only access, cannot retrieve events".
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form