Struct data_streaming_service::data_stream::DataStream

pub struct DataStream<T> { /* private fields */ }

Each data stream holds the original stream request from the client and tracks the progress of the data stream to satisfy that request (e.g., the data that has already been sent along the stream to the client and the in-flight Aptos data client requests that have been sent to the network).

Note that it is the responsibility of the data stream to send data notifications along the stream in sequential order (e.g., transactions and proofs must be sent with monotonically increasing versions).

Implementations

impl<T: AptosDataClient + Send + Clone + 'static> DataStream<T>

pub fn new(
    config: DataStreamingServiceConfig,
    data_stream_id: DataStreamId,
    stream_request: &StreamRequest,
    aptos_data_client: T,
    notification_id_generator: Arc<U64IdGenerator>,
    advertised_data: &AdvertisedData
) -> Result<(Self, DataStreamListener), Error>

pub fn data_requests_initialized(&self) -> bool

Returns true iff the first batch of data client requests has been sent

pub fn initialize_data_requests(
    &mut self,
    global_data_summary: GlobalDataSummary
) -> Result<(), Error>

Initializes the data client requests by sending out the first batch

pub fn sent_notification(&self, notification_id: &NotificationId) -> bool

Returns true iff the given notification_id was sent by this stream

pub fn handle_notification_feedback(
    &self,
    notification_id: &NotificationId,
    notification_feedback: &NotificationFeedback
) -> Result<(), Error>

Notifies the Aptos data client of a bad client response

pub fn process_data_responses(
    &mut self,
    global_data_summary: GlobalDataSummary
) -> Result<(), Error>

Processes any data client responses that have been received. Note: the responses must be processed in FIFO order.

pub fn ensure_data_is_available(
    &self,
    advertised_data: &AdvertisedData
) -> Result<(), Error>

Verifies that the data required by the stream can be satisfied using the currently advertised data in the network. If not, returns an error.

Trait Implementations

impl<T: Debug> Debug for DataStream<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Drop for DataStream<T>

fn drop(&mut self)

Terminates the stream by aborting all spawned tasks