Package deltix.qsrv.hf.tickdb.pub

Class SelectionOptions

  • public class SelectionOptions
extends CommonOptions
    Options for selecting data from a stream.

    • Field Detail

      • ABORT_CURSOR

        public static final long ABORT_CURSOR
        A constant for shiftOffset field. Abort the cursor, when a truncation occurs.
        See Also:
        Constant Field Values

      • live

        public boolean live
        Instead of returning false from next () at the end of the stream, wait for live data to be added.

      • reversed

        public boolean reversed
        Specify cursor direction

      • allowLateOutOfOrder

        public boolean allowLateOutOfOrder
        Output out-of-order late messages. Time base consumers receive historical messages they requested strictly ordered by their time. For scenarios when new messages arrive in the middle of consumer's session (So called "live" mode) it is possible that newly arrived message has a timestamp in already consumer time region. In this cases this flag allows consumer to receive these "late" messages even if they out of order with respect to current baseline time. NOTE: Late Messages that are timestamped prior to consumer's select time or last reset time will not be delivered even with this flag enabled.

      • rebroadcast

        public boolean rebroadcast
        Allow rebroadcast unique message on open/reset cursors

      • realTimeNotification

        public boolean realTimeNotification
        Enabled/Disables sending system messages when cursor switches from historical to realtime mode.

      • versionTracking

        public boolean versionTracking
        When true, allows receiving notification messages StreamTruncatedMessage and MetaDataChangeMessage when stream is truncated / stream metadata is changed.

      • ordered

        public boolean ordered
        Enabled/Disables fixed message order from cursor independent of subscribed entities.

      • delayedLiveMode

        public boolean delayedLiveMode
        Enabled/Disables delayed mode for live subscription

      • restrictStreamType

        public boolean restrictStreamType

        Will restrict permitted stream type of cursor to type of first stream in the cursor. Attempt to add new stream of different type to produced cursor may result in error.

        Do not set this flag if you going to add new streams of arbitrary type to the cursor.

        Cursors created with this flag may give better performance is some specific cases.

      • shiftOffset

        public long shiftOffset
        Specify (in milliseconds) an offset to shift cursor relatively to the current timestamp, when stream truncation occurs.

        I.e. cursor be reset to current_timestamp + shiftOffset position; shiftOffset can be negative. If the field is equals to ABORT_CURSOR, then cursor throws an exception, when stream truncation occurs.

      • space

        public java.lang.String space
        Name of the space to select data from. Allows regular expression to match several spaces. If set to null then data from all spaces is loaded. Any non-null value is permitted only for streams that supports "spaces". See also LoadingOptions.space Examples: 1. read all spaces without 'temp-' prefix options.space = "^(?!(temp-))" 2. read all spaces starts with 'A' options.space = "^(A+)" See also Pattern

    • Constructor Detail

      • SelectionOptions

        public SelectionOptions​(boolean raw,
                        boolean live,
                        boolean reversed,
                        long shiftOffset)
        Creates new SelectionOptions instance with given arguments.
        Parameters:
        raw - raw selection mode, (@see deltix.qsrv.hf.pub.RawMessage).
        live - consuming live data
        reversed - reverse mode
        shiftOffset - offset to shift cursor in case of truncations

      • SelectionOptions

        public SelectionOptions​(boolean raw,
                        boolean live,
                        boolean reversed)
        Creates new SelectionOptions instance with given arguments.
        Parameters:
        raw - raw selection mode, (@see deltix.qsrv.hf.pub.RawMessage).
        live - consuming live data
        reversed - reverse mode, if true then cursor read data using descending order of message time

      • SelectionOptions

        public SelectionOptions​(boolean raw,
                        boolean live)
        Creates new SelectionOptions instance with given arguments.
        Parameters:
        raw - raw selection mode, (@see deltix.qsrv.hf.pub.RawMessage).
        live - consuming live data

      • SelectionOptions

        public SelectionOptions​(boolean raw,
                        boolean live,
                        ChannelQualityOfService qos)
        Creates new SelectionOptions instance with given arguments.
        Parameters:
        raw - raw selection mode, (@see deltix.qsrv.hf.pub.RawMessage).
        live - consuming live data
        qos - ChannelQualityOfService setting

      • SelectionOptions

        public SelectionOptions()

    • Method Detail

      • isAllowLateOutOfOrder

        public boolean isAllowLateOutOfOrder()

      • setAllowLateOutOfOrder

        public void setAllowLateOutOfOrder​(boolean allowLateOutOfOrder)

      • isRealTimeNotification

        public boolean isRealTimeNotification()

      • setRealTimeNotification

        public void setRealTimeNotification​(boolean realTimeNotification)

      • isLive

        public boolean isLive()

      • setLive

        public void setLive​(boolean live)

      • isRaw

        public boolean isRaw()

      • setRaw

        public void setRaw​(boolean raw)

      • isReversed

        public boolean isReversed()

      • setReversed

        public void setReversed​(boolean reversed)

      • isSchemaChangeMessagesIncluded

        public boolean isSchemaChangeMessagesIncluded()

      • setIncludeSchemaChangeMessages

        public void setIncludeSchemaChangeMessages​(boolean includeSchemaChangeMessages)