CarpDataStreamService class

A DataStreamService that talks to the CARP Web Services.

Inheritance

• Object
• CarpBaseService
• CarpDataStreamService

Constructors

CarpDataStreamService()

Returns the singleton default instance of the CarpDataStreamService. Before this instance can be used, it must be configured using the configure method.

factory

Properties

app → CarpApp?

The CARP app associated with the CARP Web Service. Returns null if this service has not yet been configured via the configure method.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

headers → Map<String, String>

The headers for any authenticated HTTP REST call to a CarpBaseService.

no setter, inherited

isConfigured → bool

Has this service been configured?

no setter, inherited

rpcEndpointName → String

The endpoint name for this service at CARP.

no setter, override

rpcEndpointUri → String

The URL for this service's endpoint at CARP.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

appendToDataStreams(String studyDeploymentId, List<DataStreamBatch> batch) → Future<void>

Append a batch of data measures to corresponding data streams in studyDeploymentId.

override

closeDataStreams(List<String> studyDeploymentIds) → Future<void>

Stop accepting incoming data for all data streams for each of the studyDeploymentIds.

override

configure(CarpApp app) → void

Configure the this instance of a Carp Service.

inherited

configureFrom(CarpBaseService service) → void

Configure from another service which has already been configured and potentially authenticated.

inherited

getDataStream(DataStreamId dataStream, int fromSequenceId, [int? toSequenceIdInclusive]) → Future<List<DataStreamBatch>>

Retrieve all data points in dataStream that fall within the inclusive range defined by fromSequenceId and toSequenceIdInclusive. If toSequenceIdInclusive is null, all data points starting fromSequenceId are returned.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

openDataStreams(DataStreamsConfiguration configuration) → Future<void>

Start accepting data for a study deployment for data streams configured in configuration.

override

removeDataStreams(List<String> studyDeploymentIds) → Future<Set<String>>

Close data streams and remove all data for each of the studyDeploymentIds.

override

stream([String? studyDeploymentId]) → DataStreamReference

Gets a DataStreamReference for a studyDeploymentId. If the studyDeploymentId is not provided, the study deployment id specified in the CarpApp is used.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited