class StreamParameters

Defined at line 3236 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

Parameters needed to configure a stream of diagnostics information.

Public Members

static const fidl_type_t * FidlType

Public Methods

bool IsEmpty ()

Returns whether no field is set.

StreamParameters & set_data_type (::fuchsia::diagnostics::DataType _value)

StreamParameters & set_stream_mode (::fuchsia::diagnostics::StreamMode _value)

StreamParameters & set_format (::fuchsia::diagnostics::Format _value)

StreamParameters & set_client_selector_configuration (::fuchsia::diagnostics::ClientSelectorConfiguration _value)

StreamParameters & set_batch_retrieval_timeout_seconds (int64_t _value)

StreamParameters & set_performance_configuration (::fuchsia::diagnostics::PerformanceConfiguration _value)

StreamParameters & set_subscribe_to_manifest (bool _value)

void StreamParameters ()

void StreamParameters (StreamParameters && other)

void ~StreamParameters ()

StreamParameters & operator= (StreamParameters && other)

::std::unique_ptr<StreamParameters> New ()

void Encode (::fidl::Encoder * _encoder, size_t _offset, std::optional< ::fidl::HandleInformation> maybe_handle_info)

void Decode (::fidl::Decoder * _decoder, StreamParameters * _value, size_t _offset)

zx_status_t Clone (StreamParameters * _result)

const ::fuchsia::diagnostics::DataType & data_type ()

A [fuchsia.diagnostics/DataType] that specifies the diagnostics data type

to stream to the client.

NOTE: REQUIRED

Defined at line 3245 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

bool has_data_type ()

Defined at line 3249 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

::fuchsia::diagnostics::DataType * mutable_data_type ()

A [fuchsia.diagnostics/DataType] that specifies the diagnostics data type

to stream to the client.

NOTE: REQUIRED

Defined at line 3256 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

void clear_data_type ()

Defined at line 3264 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

const ::fuchsia::diagnostics::StreamMode & stream_mode ()

A [fuchsia.diagnostics/StreamMode] that specifies how the

streaming server provides streamed results.

NOTE: REQUIRED

Defined at line 3275 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

bool has_stream_mode ()

Defined at line 3279 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

::fuchsia::diagnostics::StreamMode * mutable_stream_mode ()

A [fuchsia.diagnostics/StreamMode] that specifies how the

streaming server provides streamed results.

NOTE: REQUIRED

Defined at line 3286 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

void clear_stream_mode ()

Defined at line 3294 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

const ::fuchsia::diagnostics::Format & format ()

A [fuchsia.diagnostics/Format] that specifies how to format the returned

diagnostics data.

NOTE: REQUIRED

Defined at line 3305 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

bool has_format ()

Defined at line 3309 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

::fuchsia::diagnostics::Format * mutable_format ()

A [fuchsia.diagnostics/Format] that specifies how to format the returned

diagnostics data.

NOTE: REQUIRED

Defined at line 3316 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

void clear_format ()

Defined at line 3324 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

const ::fuchsia::diagnostics::ClientSelectorConfiguration & client_selector_configuration ()

Configuration specifying what results the client wants returned from their

connection. The client can request a specific subset of data using a vector

of provided selectors, or can specify that they want all available data.

NOTE: REQUIRED

Defined at line 3336 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

bool has_client_selector_configuration ()

Defined at line 3340 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

::fuchsia::diagnostics::ClientSelectorConfiguration * mutable_client_selector_configuration ()

Configuration specifying what results the client wants returned from their

connection. The client can request a specific subset of data using a vector

of provided selectors, or can specify that they want all available data.

NOTE: REQUIRED

Defined at line 3348 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

void clear_client_selector_configuration ()

Defined at line 3356 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

const int64_t & batch_retrieval_timeout_seconds ()

Configuration specifying max number of seconds to wait for a single

component to have its diagnostics data "pumped". This value can used

for testing or if you know the component you are interested is in under

heavy load.

If not provided, then PER_COMPONENT_ASYNC_TIMEOUT_SECONDS as defined in

https://fuchsia.googlesource.com/fuchsia/+/refs/heads/master/src/diagnostics/archivist/src/constants.rs

will be used.

NOTE: OPTIONAL

Defined at line 3372 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

bool has_batch_retrieval_timeout_seconds ()

Defined at line 3376 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

int64_t * mutable_batch_retrieval_timeout_seconds ()

Configuration specifying max number of seconds to wait for a single

component to have its diagnostics data "pumped". This value can used

for testing or if you know the component you are interested is in under

heavy load.

If not provided, then PER_COMPONENT_ASYNC_TIMEOUT_SECONDS as defined in

https://fuchsia.googlesource.com/fuchsia/+/refs/heads/master/src/diagnostics/archivist/src/constants.rs

will be used.

NOTE: OPTIONAL

Defined at line 3388 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

void clear_batch_retrieval_timeout_seconds ()

Defined at line 3396 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

const ::fuchsia::diagnostics::PerformanceConfiguration & performance_configuration ()

Parameters which configure a diagnostics stream's performance properties.

NOTE: OPTIONAL

Defined at line 3406 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

bool has_performance_configuration ()

Defined at line 3410 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

::fuchsia::diagnostics::PerformanceConfiguration * mutable_performance_configuration ()

Parameters which configure a diagnostics stream's performance properties.

NOTE: OPTIONAL

Defined at line 3416 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

void clear_performance_configuration ()

Defined at line 3424 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

const bool & subscribe_to_manifest ()

Indicates if the client wants to receive a stream of tag definitions

and log records referencing those tags. This is transitional and will

be removed in a future CL once this feature is stable.

TODO(b/315520045): Remove this.

NOTE: OPTIONAL

Defined at line 3437 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

bool has_subscribe_to_manifest ()

Defined at line 3441 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

bool * mutable_subscribe_to_manifest ()

Indicates if the client wants to receive a stream of tag definitions

and log records referencing those tags. This is transitional and will

be removed in a future CL once this feature is stable.

TODO(b/315520045): Remove this.

NOTE: OPTIONAL

Defined at line 3450 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h

void clear_subscribe_to_manifest ()

Defined at line 3458 of file fidling/gen/sdk/fidl/fuchsia.diagnostics/fuchsia.diagnostics/hlcpp/fuchsia/diagnostics/cpp/fidl.h