template <>class WireSyncClientImpl
Defined at line 1352 of file fidling/gen/sdk/fidl/fuchsia.lowpan.spinel/fuchsia.lowpan.spinel/cpp/fidl/fuchsia.lowpan.spinel/cpp/wire_messaging.h
Methods to make a sync FIDL call directly on an unowned handle or a
const reference to a |::fidl::ClientEnd
<
::fuchsia_lowpan_spinel::Device>|,
avoiding setting up a client.
Public Methods
::fidl::WireResult< ::fuchsia_lowpan_spinel::Device::Open> Open ()Opens the Spinel connection and performs initialization.
This method will block until the Device is ready to use or
an error has been encountered. If an error is indicated,
the device is still considered closed.
Calling this method will typically induce reset if
supported by the underlying hardware. It may be called
while the device is already open in order to trigger a
reset.
Possible error codes:
* `Error::IO_ERROR`: An IO error occurred.
* `Error::UNSPECIFIED`: An unspecified error occurred.
See logs for more details.
Allocates 48 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::WireResult< ::fuchsia_lowpan_spinel::Device::Close> Close ()Close the Spinel connection.
This method will block until the Device has successfully
been put into a closed (preferably low-power) state. An
error may be indicated if a problem was encountered that
may indicate the device did not close cleanly.
Calling this method will always cause this interface to be
closed, even if an error is reported. Thus, the error may
be simply ignored or logged.
Calling this method when the device is already closed
will do nothing.
Possible error codes:
* `Error::IO_ERROR`: An IO error occurred.
* `Error::UNSPECIFIED`: An unspecified error occurred.
See logs for more details.
Allocates 48 bytes of message buffer on the stack. No heap allocation necessary.
::fidl::WireResult< ::fuchsia_lowpan_spinel::Device::GetMaxFrameSize> GetMaxFrameSize ()Fetch the max frame size.
This method may be called at any time. The returned
value is an implementation-specific constant.
Allocates 40 bytes of message buffer on the stack. No heap allocation necessary.
Returns
The size of the largest frame that this implementation
supports being passed into `SendFrame()`.
::fidl::OneWayStatus SendFrame (::fidl::VectorView<uint8_t> data)Sends a Spinel-formatted frame to the device.
Calling this method while the device is closed will cause
the frame to be dropped and `->OnError()` to emit `Error::CLOSED`.
See `->OnReadyForSendFrames()` for flow-control considerations.
Allocates 16 bytes of response buffer on the stack. Request is heap-allocated.
::fidl::OneWayStatus ReadyToReceiveFrames (uint32_t number_of_frames)Increases the number of additional frames that the caller is
currently ready to receive, as a method of inbound flow-control.
The caller can use this method to regulate the speed at which
inbound frames are handled. This method should be called periodically
to ensure low-latency frame delivery.
Calling this method with a non-zero value indicates to the
receiver that the caller is ready to receive the specified
additional number of frames.
This method SHOULD NOT be called with a value of zero. If the
receiver gets this call with a value of zero, it MUST be ignored.
Frames will not be received until this method is first called
with a non-zero value. Once received, the receiver will limit
the number of subsequent frames emitted via `->OnReceiveFrame()`
to the given number of frames.
Calling this method while the device is closed will do nothing.
A reasonable usage pattern would be to first call this method
with a value of 4, calling it again with a value of 2 after
every second received inbound frame.
Outbound flow control is similarly accomplished via `->OnReadyForSendFrames()`.
Allocates 40 bytes of message buffer on the stack. No heap allocation necessary.