class Allocator_GetVmoInfo_Response
Defined at line 7202 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
Public Members
static const fidl_type_t * FidlType
Public Methods
bool IsEmpty ()
Returns whether no field is set.
void Allocator_GetVmoInfo_Response ()
void Allocator_GetVmoInfo_Response (Allocator_GetVmoInfo_Response && other)
const uint64_t & buffer_collection_id ()
The buffer_collection_id and buffer_index together uniquely identify
a buffer per boot.
Defined at line 7210 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
bool has_buffer_collection_id ()
Defined at line 7214 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
uint64_t * mutable_buffer_collection_id ()
The buffer_collection_id and buffer_index together uniquely identify
a buffer per boot.
Defined at line 7220 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
void clear_buffer_collection_id ()
Defined at line 7228 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
const uint64_t & buffer_index ()
The buffer_collection_id and buffer_index together uniquely identify
a buffer per boot.
This buffer_index is in the same space as specified/implied by
`BufferCollectionInfo` from collection allocation.
Clients that don't have direct control over the provenance of `vmo`
should assume that buffer_index could be any uint64. Such clients
may wish to check the buffer_collection_id against client-known
buffer collections before looking at buffer_index, and/or ensure
that looking up a client-known buffer by buffer_collection_id and
buffer_index doesn't rely on buffer_index(s) being packed near 0, at
least until a client-known buffer is found that the client knows
will have buffer_index packed near 0.
Defined at line 7250 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
bool has_buffer_index ()
Defined at line 7254 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
uint64_t * mutable_buffer_index ()
The buffer_collection_id and buffer_index together uniquely identify
a buffer per boot.
This buffer_index is in the same space as specified/implied by
`BufferCollectionInfo` from collection allocation.
Clients that don't have direct control over the provenance of `vmo`
should assume that buffer_index could be any uint64. Such clients
may wish to check the buffer_collection_id against client-known
buffer collections before looking at buffer_index, and/or ensure
that looking up a client-known buffer by buffer_collection_id and
buffer_index doesn't rely on buffer_index(s) being packed near 0, at
least until a client-known buffer is found that the client knows
will have buffer_index packed near 0.
Defined at line 7272 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
void clear_buffer_index ()
Defined at line 7280 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
const ::zx::eventpair & close_weak_asap ()
If vmo was a sysmem weak VMO handle or need_weak was set to true (or
both), this field will be set. Later when ZX_EVENTPAIR_PEER_CLOSED
is signalled on this eventpair endpoint, all weak VMO handles to
this buffer should be closed asap (all strong VMO handles were
already closed by this point). In some cases, a client may be able
to rely on a different participant to notice and inform the client,
so this field being set is potentially ignore-able by some clients.
Client authors should ensure that when the buffer's close_weak_asap
server_end closes, the client will close all handles to the buffer
as soon as possible. This can be achieved directly or indirectly.
Client authors should not assume that this is achieved indirectly.
Defined at line 7300 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
bool has_close_weak_asap ()
Defined at line 7304 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
::zx::eventpair * mutable_close_weak_asap ()
If vmo was a sysmem weak VMO handle or need_weak was set to true (or
both), this field will be set. Later when ZX_EVENTPAIR_PEER_CLOSED
is signalled on this eventpair endpoint, all weak VMO handles to
this buffer should be closed asap (all strong VMO handles were
already closed by this point). In some cases, a client may be able
to rely on a different participant to notice and inform the client,
so this field being set is potentially ignore-able by some clients.
Client authors should ensure that when the buffer's close_weak_asap
server_end closes, the client will close all handles to the buffer
as soon as possible. This can be achieved directly or indirectly.
Client authors should not assume that this is achieved indirectly.
Defined at line 7320 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
void clear_close_weak_asap ()
Defined at line 7328 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
bool has_single_buffer_settings ()
Defined at line 7386 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
::fuchsia::sysmem2::SingleBufferSettings * mutable_single_buffer_settings ()
Iff `need_single_buffer_settings` is set, this field will be set to
the SingleBufferSettings of the vmo's collection. See also
`[fuchsia.sysmem2/Allocator.GetVmoInfo]`
`need_single_buffer_settings`.
Defined at line 7394 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
void clear_single_buffer_settings ()
Defined at line 7402 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
const bool & constraints_ok ()
Iff `constraints_to_check` was set, this field will be set. If true,
the vmo conforms to `constraints_to_check`. If false, the vmo does
not conform to `constraints_to_check`.
Defined at line 7413 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
bool has_constraints_ok ()
Defined at line 7417 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
bool * mutable_constraints_ok ()
Iff `constraints_to_check` was set, this field will be set. If true,
the vmo conforms to `constraints_to_check`. If false, the vmo does
not conform to `constraints_to_check`.
Defined at line 7424 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
void clear_constraints_ok ()
Defined at line 7432 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
bool * mutable_vmo_settings_match ()
Iff `vmo_settings_to_check` was set, this field will be set. If
true, `vmo` and `vmo_settings_to_check` have the same
SingleBufferSettings. If false, `vmo` and `vmo_settings_to_check`
have different SingleBufferSettings. The reason for not matching may
not be visible to the client if SingleBufferSettings has a new field
or similar.
Defined at line 7460 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
void clear_vmo_settings_match ()
Defined at line 7468 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
Allocator_GetVmoInfo_Response & set_buffer_collection_id (uint64_t _value)
Allocator_GetVmoInfo_Response & set_buffer_index (uint64_t _value)
Allocator_GetVmoInfo_Response & set_close_weak_asap (::zx::eventpair _value)
Allocator_GetVmoInfo_Response & set_single_buffer_settings (::fuchsia::sysmem2::SingleBufferSettings _value)
Allocator_GetVmoInfo_Response & set_constraints_ok (bool _value)
Allocator_GetVmoInfo_Response & set_vmo_settings_match (bool _value)
const ::zx::vmo & weak_vmo ()
Iff `need_weak` was set to true, this field is set to a sysmem weak
VMO handle to the same sysmem buffer (assuming no Error). The koid
may be different than the koid of the `vmo` in the request,
regardless of whether `vmo` in the request was a strong or weak VMO
handle. The `weak_vmo` will have no more rights than the `vmo`
handle had. In most cases, the client should also retain
`close_weak_asap` and notice when ZX_EVENTPAIR_PEER_CLOSED is
signalled and close the `weak_vmo` (and any handles to child VMOs)
ASAP.
Defined at line 7345 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
bool has_weak_vmo ()
Defined at line 7349 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
::zx::vmo * mutable_weak_vmo ()
Iff `need_weak` was set to true, this field is set to a sysmem weak
VMO handle to the same sysmem buffer (assuming no Error). The koid
may be different than the koid of the `vmo` in the request,
regardless of whether `vmo` in the request was a strong or weak VMO
handle. The `weak_vmo` will have no more rights than the `vmo`
handle had. In most cases, the client should also retain
`close_weak_asap` and notice when ZX_EVENTPAIR_PEER_CLOSED is
signalled and close the `weak_vmo` (and any handles to child VMOs)
ASAP.
Defined at line 7362 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
void clear_weak_vmo ()
Defined at line 7370 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
Allocator_GetVmoInfo_Response & set_weak_vmo (::zx::vmo _value)
const ::fuchsia::sysmem2::SingleBufferSettings & single_buffer_settings ()
Iff `need_single_buffer_settings` is set, this field will be set to
the SingleBufferSettings of the vmo's collection. See also
`[fuchsia.sysmem2/Allocator.GetVmoInfo]`
`need_single_buffer_settings`.
Defined at line 7382 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
const bool & vmo_settings_match ()
Iff `vmo_settings_to_check` was set, this field will be set. If
true, `vmo` and `vmo_settings_to_check` have the same
SingleBufferSettings. If false, `vmo` and `vmo_settings_to_check`
have different SingleBufferSettings. The reason for not matching may
not be visible to the client if SingleBufferSettings has a new field
or similar.
Defined at line 7446 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
bool has_vmo_settings_match ()
Defined at line 7450 of file fidling/gen/sdk/fidl/fuchsia.sysmem2/fuchsia.sysmem2/hlcpp/fuchsia/sysmem2/cpp/fidl.h
void ~Allocator_GetVmoInfo_Response ()
Allocator_GetVmoInfo_Response & operator= (Allocator_GetVmoInfo_Response && other)
::std::unique_ptr<Allocator_GetVmoInfo_Response> New ()
void Encode (::fidl::Encoder *_encoder,size_t_offset,std::optional< ::fidl::HandleInformation>maybe_handle_info)
void Decode (::fidl::Decoder *_decoder,Allocator_GetVmoInfo_Response *_value,size_t_offset)
zx_status_t Clone (Allocator_GetVmoInfo_Response * _result)