Epok Engine

EPOK RUNTIME

epok::PocketStationService::receive

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

Pocket Lua link: the message published with `link.send(n)`; size 0 when none.

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

Declaration

Declaration
PocketError receive(void* message, uint8_t capacity, uint8_t* size, unsigned port = 0)

Pocket Lua link: the message published with `link.send(n)`; size 0 when none.

ParameterTypeMeaning
messagevoid *Not documented; consult the linked header.
capacityuint8_tNot documented; consult the linked header.
sizeuint8_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:
// void * message
// uint8_t capacity
// uint8_t * size
// unsigned int port

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

auto result = object.receive(message, capacity, size, port);

Trade-offs and warnings

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

Declared in runtime/pocketstation.hpp:336

Related members