Epok Engine

EPOK RUNTIME

epok::PocketStationService::install

Method · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Method

Copies an embedded program to the card (replacing an older copy) and returns its first block.

Belongs to
epok::PocketStationService
Header
pocketstation.hpp
Overloads
1

Declaration

Declaration
PocketError install(const PocketApp& app, uint8_t* first_block = nullptr, unsigned port = 0)

Copies an embedded program to the card (replacing an older copy) and returns its first block.

ParameterTypeMeaning
appconst PocketApp &Not documented; consult the linked header.
first_blockuint8_t *Not documented; consult the linked header.
portunsigned intNot documented; consult the linked header.

Returns: PocketError. Consult the linked header for its meaning.

Example sketch

C++ example
#include "pocketstation.hpp"

// Assume these named values have been initialized with valid data:
// const PocketApp & app
// uint8_t * first_block
// unsigned int port

epok::PocketStationService& object = /* obtain a valid instance */;

auto result = object.install(app, first_block, port);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/pocketstation.hpp:423

Related members