def createCursor()

in tbapi/__init__.py [0:0]

• 17 lines of code
• 1 McCabe index (conditional complexity)

    def createCursor(self, stream: 'TickStream', options: SelectionOptions) -> 'TickCursor':
        '''Opens an initially empty cursor for reading data from multiple streams,
        according to the specified options. The messages
        are returned from the cursor strictly ordered by time. Within the same
        exact timestamp, the order of messages is undefined and may vary from
        call to call, i.e. it is non-deterministic.

        The cursor is returned initially empty and must be reset.
        The TickCursor class provides
        methods for dynamically re-configuring the subscription, or jumping to
        a different timestamp.

        Args:
            stream (TickStream): Stream from which data will be selected.
            options (SelectionOptions): Selection options.

        Returns:
            TickCursor: A cursor used to read messages.
        '''
        return self.__createCursor(stream, options)