mm::node::OsCommandRequest Struct Reference

What one raw OS command run was asked to do. More...

#include <somanet_procedures.h>

Collaboration diagram for mm::node::OsCommandRequest:

Public Attributes
std::vector< uint8_t >	command
	The 8 request bytes (byte 0 = command ID).
std::chrono::milliseconds	timeout {1000}
	Ceiling on the whole command.
std::chrono::milliseconds	pollInterval {10}
OsCommandFsBuffer	fsBuffer

Detailed Description

What one raw OS command run was asked to do.

The request behind POST /api/devices/:pos/procedures/os-command: the caller supplies the command bytes, which is the direct route to the drive's whole OS command set and a perfectly ordinary way to drive it. A typed procedure is the other route to the same mechanism — it builds the bytes itself and exposes only the parameters that make sense for its command — not a replacement that makes this one a fallback.

Member Data Documentation

command

std::vector<uint8_t> mm::node::OsCommandRequest::command

The 8 request bytes (byte 0 = command ID).

fsBuffer

OsCommandFsBuffer mm::node::OsCommandRequest::fsBuffer

The bulk data the command moves, if it moves any (see OsCommandFsBuffer). Defaults to moving nothing, which is what most commands do.

pollInterval

std::chrono::milliseconds mm::node::OsCommandRequest::pollInterval {10}

Delay between response polls.

timeout

std::chrono::milliseconds mm::node::OsCommandRequest::timeout {1000}

Ceiling on the whole command.

---

The documentation for this struct was generated from the following file:

• libs/node/somanet_procedures.h